CPUParticles Properties |
The CPUParticles type exposes the following members.
Name | Description | |
---|---|---|
_ImportPath | (Inherited from Node.) | |
Amount | ||
Angle | Initial rotation applied to each particle, in degrees. | |
AngleCurve | Each particle's rotation will be animated along this Curve. | |
AngleRandom | Rotation randomness ratio. | |
AngularVelocity | Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. | |
AngularVelocityCurve | Each particle's angular velocity will vary along this Curve. | |
AngularVelocityRandom | Angular velocity randomness ratio. | |
AnimOffset | Particle animation offset. | |
AnimOffsetCurve | Each particle's animation offset will vary along this Curve. | |
AnimOffsetRandom | Animation offset randomness ratio. | |
AnimSpeed | Particle animation speed. | |
AnimSpeedCurve | Each particle's animation speed will vary along this Curve. | |
AnimSpeedRandom | Animation speed randomness ratio. | |
CastShadow | The selected shadow casting flag. See GeometryInstanceShadowCastingSetting for possible values. | |
Color | Unused for 3D particles. | |
ColorRamp | Unused for 3D particles. | |
CustomMultiplayer | The override to the default MultiplayerAPI. Set to null to use the default SceneTree one. | |
Damping | The rate at which particles lose velocity. | |
DampingCurve | Damping will vary along this Curve. | |
DampingRandom | Damping randomness ratio. | |
Direction | Unit vector specifying the particles' emission direction. | |
DrawOrder | Particle draw order. Uses CPUParticlesDrawOrderEnum values. | |
DynamicObject |
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.) | |
EditorDescription | (Inherited from Node.) | |
EmissionBoxExtents | The rectangle's extents if EmissionShape is set to . | |
EmissionColors | Sets the Colors to modulate particles by when using or . | |
EmissionNormals | Sets the direction the particles will be emitted in when using . | |
EmissionPoints | Sets the initial positions to spawn particles when using or . | |
EmissionShape | Particles will be emitted inside this region. See CPUParticlesEmissionShapeEnum for possible values. | |
EmissionSphereRadius | The sphere's radius if CPUParticlesEmissionShapeEnum is set to . | |
Emitting | If true, particles are being emitted. | |
Explosiveness | How rapidly particles in an emission cycle are emitted. If greater than 0, there will be a gap in emissions before the next cycle begins. | |
ExtraCullMargin | The extra distance added to the GeometryInstance's bounding box (AABB) to increase its cull box. | |
Filename | When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. | |
FixedFps | 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 particle system itself. | |
FlagAlignY | Align Y axis of particle with the direction of its velocity. | |
FlagDisableZ | If true, particles will not move on the z axis. | |
FlagRotateY | If true, particles rotate around Y axis by Angle. | |
Flatness | Amount of Spread in Y/Z plane. A value of 1 restricts particles to X/Z plane. | |
FractDelta | If true, results in fractional delta calculation which has a smoother particles display effect. | |
GenerateLightmap | When disabled, the mesh will be taken into account when computing indirect lighting, but the resulting lightmap will not be saved. Useful for emissive only materials or shadow casters. | |
Gizmo | The SpatialGizmo for this node. Used for example in [!:Godot.EditorSpatialGizmo] as custom visualization and editing handles in Editor. | |
GlobalTransform | World space (global) Transform of this node. | |
Gravity | Gravity applied to every particle. | |
HueVariation | Initial hue variation applied to each particle. | |
HueVariationCurve | Each particle's hue will vary along this Curve. | |
HueVariationRandom | Hue variation randomness ratio. | |
InitialVelocity | Initial velocity magnitude for each particle. Direction comes from Spread and the node's orientation. | |
InitialVelocityRandom | Initial velocity randomness ratio. | |
Layers | The render layer(s) this VisualInstance is drawn on. This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to. | |
Lifetime | The amount of time each particle will exist (in seconds). | |
LifetimeRandomness | Particle lifetime randomness ratio. | |
LightmapScale | Scale factor for the generated baked lightmap. Useful for adding detail to certain mesh instances. | |
LinearAccel | Linear acceleration applied to each particle in the direction of motion. | |
LinearAccelCurve | Each particle's linear acceleration will vary along this Curve. | |
LinearAccelRandom | Linear acceleration randomness ratio. | |
LocalCoords | If true, particles use the parent node's coordinate space. If false, they use global coordinates. | |
LodMaxDistance | The GeometryInstance's max LOD distance. Note: This property currently has no effect. | |
LodMaxHysteresis | The GeometryInstance's max LOD margin. Note: This property currently has no effect. | |
LodMinDistance | The GeometryInstance's min LOD distance. Note: This property currently has no effect. | |
LodMinHysteresis | The GeometryInstance's min LOD margin. Note: This property currently has no effect. | |
MaterialOverride | The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. | |
Mesh | The Mesh used for each particle. If null, particles will be spheres. | |
Multiplayer | The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree). | |
Name | The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed. Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed. | |
NativeInstance | (Inherited from Object.) | |
OneShot | If true, only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle's end. | |
OrbitVelocity | Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second. This property is only available when FlagDisableZ is true. | |
OrbitVelocityCurve | Each particle's orbital velocity will vary along this Curve. | |
OrbitVelocityRandom | Orbital velocity randomness ratio. | |
Owner | The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing. | |
PauseMode | Pause mode. How the node will behave if the SceneTree is paused. | |
Preprocess | Particle system starts as if it had already run for this many seconds. | |
ProcessPriority | The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first. | |
RadialAccel | Radial acceleration applied to each particle. Makes particle accelerate away from origin. | |
RadialAccelCurve | Each particle's radial acceleration will vary along this Curve. | |
RadialAccelRandom | Radial acceleration randomness ratio. | |
Randomness | Emission lifetime randomness ratio. | |
Rotation | Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. | |
RotationDegrees | Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). | |
Scale | Scale part of the local transformation. | |
ScaleAmount | Initial scale applied to each particle. | |
ScaleAmountCurve | Each particle's scale will vary along this Curve. | |
ScaleAmountRandom | Scale randomness ratio. | |
SpeedScale | Particle system's running speed scaling ratio. A value of 0 can be used to pause the particles. | |
Spread | Each particle's initial direction range from +spread to -spread degrees. Applied to X/Z plane and Y/Z planes. | |
TangentialAccel | Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. | |
TangentialAccelCurve | Each particle's tangential acceleration will vary along this Curve. | |
TangentialAccelRandom | Tangential acceleration randomness ratio. | |
Transform | Local space Transform of this node, with respect to the parent node. | |
Translation | Local translation of this node. | |
UseInBakedLight | If true, this GeometryInstance will be used when baking lights using a GIProbe or BakedLightmap. | |
Visible | If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true). |