virtualx-engine/doc/classes/GPUParticlesAttractorBox3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GPUParticlesAttractorBox3D" inherits="GPUParticlesAttractor3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A box-shaped attractor that influences particles from [GPUParticles3D] nodes.
	</brief_description>
	<description>
		A box-shaped attractor that influences particles from [GPUParticles3D] nodes. Can be used to attract particles towards its origin, or to push them away from its origin.
		Particle attractors work in real-time and can be moved, rotated and scaled during gameplay. Unlike collision shapes, non-uniform scaling of attractors is also supported.
		[b]Note:[/b] Particle attractors only affect [GPUParticles3D], not [CPUParticles3D].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(2, 2, 2)">
			The attractor box's size in 3D units.
		</member>
	</members>
</class>
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="GPUParticlesAttractorBox3D" inherits="GPUParticlesAttractor3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`<brief_description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A box-shaped attractor that influences particles from [GPUParticles3D] nodes.`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`</brief_description>`
			`<description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A box-shaped attractor that influences particles from [GPUParticles3D] nodes. Can be used to attract particles towards its origin, or to push them away from its origin.`
			`Particle attractors work in real-time and can be moved, rotated and scaled during gameplay. Unlike collision shapes, non-uniform scaling of attractors is also supported.`
Document GPUParticles3D attractors and collision 2022-05-13 04:11:01 +02:00			`[b]Note:[/b] Particle attractors only affect [GPUParticles3D], not [CPUParticles3D].`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
Replace Extents with Size in VoxelGI, ReflectionProbe, FogVolume, Decal and GPUParticles3D - Extents are replaced by Size (Size is Extents 2) - The UI text displays 'Size' - Snapping is adjusted to work with Size - _set and _get handle extents for compatibility Co-authored-by: ator-dev <dominic.codedeveloper@gmail.com> 2022-07-12 09:43:01 +02:00			`<member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(2, 2, 2)">`
			`The attractor box's size in 3D units.`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`</member>`
			`</members>`
			`</class>`