Struct Particles

3D particle emitter.


					
			struct Particles
			;

3D particle node used to create a variety of particle systems and effects. Particles features an emitter that generates some number of particles at a given rate. Use the process_material property to add a ParticlesMaterial to configure particle appearance and behavior. Alternatively, you can add a ShaderMaterial which will be applied to all particles.

Properties

Name	Type	Description
`amount`[get, set]	`long`	Number of particles to emit.
`drawOrder`[get, set]	`Particles.DrawOrder`	Particle draw order. Uses `draworder` values.
`drawPass1`[get, set]	`Mesh`	`Mesh` that is drawn for the first draw pass.
`drawPass2`[get, set]	`Mesh`	`Mesh` that is drawn for the second draw pass.
`drawPass3`[get, set]	`Mesh`	`Mesh` that is drawn for the third draw pass.
`drawPass4`[get, set]	`Mesh`	`Mesh` that is drawn for the fourth draw pass.
`drawPasses`[get, set]	`long`	The number of draw passes when rendering particles.
`emitting`[get, set]	`bool`	If `true`, particles are being emitted.
`explosiveness`[get, set]	`double`	Time ratio between each emission. If `0`, particles are emitted continuously. If `1`, all particles are emitted simultaneously.
`fixedFps`[get, set]	`long`	The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself.
`fractDelta`[get, set]	`bool`	If `true`, results in fractional delta calculation which has a smoother particles display effect.
`lifetime`[get, set]	`double`	Amount of time each particle will exist.
`localCoords`[get, set]	`bool`	If `true`, particles use the parent node's coordinate space. If `false`, they use global coordinates.
`oneShot`[get, set]	`bool`	If `true`, only `amount` particles will be emitted.
`preprocess`[get, set]	`double`	Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.
`randomness`[get, set]	`double`	Emission randomness ratio.
`speedScale`[get, set]	`double`	Speed scaling ratio. A value of `0` can be used to pause the particles.
`visibilityAabb`[get, set]	`AABB`	The `AABB` that determines the area of the world part of which needs to be visible on screen for the particle system to be active.

Methods

Name	Description
`captureAabb`	Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.
`getAmount`
`getDrawOrder`
`getDrawPasses`
`getDrawPassMesh`	Returns the `Mesh` that is drawn at index `pass`.
`getExplosivenessRatio`
`getFixedFps`
`getFractionalDelta`
`getLifetime`
`getOneShot`
`getPreProcessTime`
`getProcessMaterial`
`getRandomnessRatio`
`getSpeedScale`
`getUseLocalCoordinates`
`getVisibilityAabb`
`isEmitting`
`restart`	Restarts the particle emission, clearing existing particles.
`setAmount`
`setDrawOrder`
`setDrawPasses`
`setDrawPassMesh`	Sets the `Mesh` that is drawn at index `pass`.
`setEmitting`
`setExplosivenessRatio`
`setFixedFps`
`setFractionalDelta`
`setLifetime`
`setOneShot`
`setPreProcessTime`
`setProcessMaterial`
`setRandomnessRatio`
`setSpeedScale`
`setUseLocalCoordinates`
`setVisibilityAabb`

Enums

Name	Description
`Constants`
`DrawOrder`

Authors
Copyright	Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) Copyright (c) 2017-2018 Godot-D contributors
License	MIT License

Generated using the DDOX documentation generator