virtualx-engine/doc/classes/Particles.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-stable">
	<brief_description>
		3D particle emitter.
	</brief_description>
	<description>
		3D particle node used to create a variety of particle systems and effects. [code]Particles[/code] features an emitter that generates some number of particles at a given rate.
		Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="capture_aabb" qualifiers="const">
			<return type="AABB">
			</return>
			<description>
			</description>
		</method>
		<method name="restart">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="amount" type="int" setter="set_amount" getter="get_amount">
			Number of particles to emit.
		</member>
		<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder">
			Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code].
		</member>
		<member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
		</member>
		<member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
		</member>
		<member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
		</member>
		<member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
		</member>
		<member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes">
		</member>
		<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
			If [code]true[/code] particles are being emitted. Default value: [code]true[/code].
		</member>
		<member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio">
			Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code].
		</member>
		<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">
		</member>
		<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
		</member>
		<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
			Amount of time each particle will exist. Default value: [code]1[/code].
		</member>
		<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates">
			If [code]true[/code] particles use the parent node's coordinate space. If [code]false[/code] they use global coordinates. Default value: [code]true[/code].
		</member>
		<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">
			If [code]true[/code] only [code]amount[/code] particles will be emitted. Default value: [code]false[/code].
		</member>
		<member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time">
		</member>
		<member name="process_material" type="Material" setter="set_process_material" getter="get_process_material">
			[Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].
		</member>
		<member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio">
			Emission randomness ratio. Default value: [code]0[/code].
		</member>
		<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale">
			Speed scaling ratio. Default value: [code]1[/code].
		</member>
		<member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb">
		</member>
	</members>
	<constants>
		<constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
			Particles are drawn in the order emitted.
		</constant>
		<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
			Particles are drawn in order of remaining lifetime.
		</constant>
		<constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder">
			Particles are drawn in order of depth.
		</constant>
		<constant name="MAX_DRAW_PASSES" value="4">
		</constant>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Sync with current source Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage). 2018-01-25 08:50:56 +01:00			`<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-stable">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`3D particle emitter.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`3D particle node used to create a variety of particle systems and effects. [code]Particles[/code] features an emitter that generates some number of particles at a given rate.`
			`Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<demos>`
			`</demos>`
			`<methods>`
			`<method name="capture_aabb" qualifiers="const">`
Rename Rect3 to AABB. Fixes #12973. 2017-11-17 03:09:00 +01:00			`<return type="AABB">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</return>`
			`<description>`
			`</description>`
			`</method>`
			`<method name="restart">`
			`<return type="void">`
			`</return>`
			`<description>`
			`</description>`
			`</method>`
			`</methods>`
			`<members>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="amount" type="int" setter="set_amount" getter="get_amount">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Number of particles to emit.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`If [code]true[/code] particles are being emitted. Default value: [code]true[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Amount of time each particle will exist. Default value: [code]1[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`If [code]true[/code] particles use the parent node's coordinate space. If [code]false[/code] they use global coordinates. Default value: [code]true[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`If [code]true[/code] only [code]amount[/code] particles will be emitted. Default value: [code]false[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="process_material" type="Material" setter="set_process_material" getter="get_process_material">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`[Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Emission randomness ratio. Default value: [code]0[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Speed scaling ratio. Default value: [code]1[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
Rename Rect3 to AABB. Fixes #12973. 2017-11-17 03:09:00 +01:00			`<member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Particles are drawn in the order emitted.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Particles are drawn in order of remaining lifetime.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder">`
[DOCS] Update ParticlesMaterial, Particles class ref 2017-10-03 21:30:32 +02:00			`Particles are drawn in order of depth.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="MAX_DRAW_PASSES" value="4">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
			`</constants>`
			`</class>`