Documentation
¶
Overview ¶
Particle attractors can be used to attract particles towards the attractor's origin, or to push them away from the attractor's 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.
Attractors can be temporarily disabled by hiding them, or by setting their Strength to 0.0.
Note: Particle attractors only affect GPUParticles3D, not CPUParticles3D.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsGPUParticlesAttractor3D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
- func (self Instance) Attenuation() Float.X
- func (self Instance) CullMask() int
- func (self Instance) Directionality() Float.X
- func (self Instance) ID() ID
- func (self Instance) SetAttenuation(value Float.X)
- func (self Instance) SetCullMask(value int)
- func (self Instance) SetDirectionality(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetStrength(value Float.X)
- func (self Instance) Strength() Float.X
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsGPUParticlesAttractor3D ¶
func (*Extension[T]) AsVisualInstance3D ¶
func (self *Extension[T]) AsVisualInstance3D() VisualInstance3D.Instance
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.GPUParticlesAttractor3D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsGPUParticlesAttractor3D ¶
func (Instance) AsVisualInstance3D ¶
func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
func (Instance) Attenuation ¶
The particle attractor's attenuation. Higher values result in more gradual pushing of particles as they come closer to the attractor's origin. Zero or negative values will cause particles to be pushed very fast as soon as the touch the attractor's edges.
func (Instance) CullMask ¶
The particle rendering layers (VisualInstance3D.Layers) that will be affected by the attractor. By default, all particles are affected by an attractor.
After configuring particle nodes accordingly, specific layers can be unchecked to prevent certain particles from being affected by attractors. For example, this can be used if you're using an attractor as part of a spell effect but don't want the attractor to affect unrelated weather particles at the same position.
Particle attraction can also be disabled on a per-process material basis by setting ParticleProcessMaterial.AttractorInteractionEnabled on the GPUParticles3D node.
func (Instance) Directionality ¶
Adjusts how directional the attractor is. At 0.0, the attractor is not directional at all: it will attract particles towards its center. At 1.0, the attractor is fully directional: particles will always be pushed towards local -Z (or +Z if Strength is negative).
Note: If Directionality is greater than 0.0, the direction in which particles are pushed can be changed by rotating the GPUParticlesAttractor3D node.
func (Instance) SetAttenuation ¶
SetAttenuation sets the property returned by [GetAttenuation].
func (Instance) SetCullMask ¶
SetCullMask sets the property returned by [GetCullMask].
func (Instance) SetDirectionality ¶
SetDirectionality sets the property returned by [GetDirectionality].
func (Instance) SetStrength ¶
SetStrength sets the property returned by [GetStrength].
func (Instance) Strength ¶
Adjusts the strength of the attractor. If Strength is negative, particles will be pushed in the opposite direction. Particles will be pushed away from the attractor's origin if Directionality is 0.0, or towards local +Z if Directionality is greater than 0.0.
Source Files