Skip to main content
Version: latest - a1.15.x βš–οΈ

✨ Particle

Class to spawn Particle Systems used to create effects in the world.

πŸ’‚Authority
This class can be spawned on both 🟧 Client and 🟦 Server (if you spawn it on client, it won't be synchronized with other players).
πŸ‘ͺInheritance
This class inherits from Base Actor .
tip

Both Cascade and Niagara Particle Systems are supported!

πŸŽ’ Examples​

local my_particle = Particle(
Vector(-200, 100, 100),
Rotator(0, 0, 0),
"nanos-world::P_Explosion",
true, -- Auto Destroy?
true -- Auto Activate?
)

πŸ—οΈ Constructor​

local my_particle = Particle(location?, rotation?, asset?, auto_destroy?, auto_activate?)
TypeNameDefaultDescription
Vector locationVector(0, 0, 0)
Rotator rotationRotator(0, 0, 0)
Particle Reference asset
boolean auto_destroytrue
boolean auto_activatetrue
Note

auto_destroy means the Entity will be immediately destroyed after spawned, losing references to the Particle System spawned in-game. So if the Particle System itself loops indefinitely, it will keep playing until the Player reconnects.

🦠 Functions​

Inherited Actor Functions
Base Actorscripting-reference/classes/base-classes/actor
ReturnsNameDescription
AddImpulseApplies a force in world world to this Actor
AttachToAttaches this Actor to any other Actor, optionally at a specific bone
DestroyDestroys this Actor
DetachDetaches this Actor from AttachedTo Actor
SetCollisionSets this Actor's collision type
SetForceAdds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
SetGravityEnabledSets whether gravity is enabled on this Actor
SetVisibilitySets whether the actor is visible or not
SetHighlightEnabledSets whether the highlight is enabled on this Actor, and which highlight index to use
SetOutlineEnabledSets whether the outline is enabled on this Actor, and which outline index to use
SetLifeSpanSets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
SetLocationSets this Actor's location in the game world
SetRotationSets this Actor's rotation in the game world
SetRelativeLocationSets this Actor's relative location in local space (only if this actor is attached)
SetRelativeRotationSets this Actor's relative rotation in local space (only if this actor is attached)
SetScaleSets this Actor's scale
SetNetworkAuthoritySets the Player to have network authority over this Actor
SetValueSets a value in this Actor
TranslateToSmoothly moves this actor to a location over a certain time
RotateToSmoothly rotates this actor to an angle over a certain time
boolean IsBeingDestroyedReturns true if this Actor is being destroyed
boolean IsVisibleReturns true if this Actor is visible
boolean IsGravityEnabledReturns true if gravity is enabled on this Actor
boolean IsInWaterReturns true if this Actor is in water
boolean IsNetworkDistributedReturns true if this Actor is currently network distributed
boolean IsValidReturns true if this Actor is valid (i.e. wasn't destroyed and points to a valid Actor)
table of Base Actor GetAttachedEntitiesGets all Actors attached to this Actor
Base Actor or nilGetAttachedToGets the Actor this Actor is attached to
table GetBoundsGets this Actor's bounds
CollisionTypeGetCollisionGets this Actor's collision type
number GetIDGets the universal network ID of this Actor (same on both client and server)
Vector GetLocationGets this Actor's location in the game world
Rotator GetRotationGets this Actor's angle in the game world
Vector GetForceGets this Actor's force (set by SetForce())
boolean HasNetworkAuthorityReturns true if the local Player is currently the Network Authority of this Actor
boolean HasAuthorityGets if this Actor was spawned by the client side
Vector GetScaleGets this Actor's scale
string GetTypeGets the type of this Actor
any GetValueGets a value stored on this Actor at the given key. Please refer to Entity Values for more information
Vector GetVelocityGets this Actor's current velocity
AddActorTagAdds an Unreal Actor Tag to this Actor
RemoveActorTagRemoves an Unreal Actor Tag from this Actor
table of string GetActorTagsGets all Unreal Actor Tags on this Actor
function SubscribeSubscribes to an Event
UnsubscribeUnsubscribes all callbacks from this Event in this Actor within this Package, or only the callback passed
ReturnsNameDescription
ActivateActivates the Emitter
DeactivateDeactivate the Emitter
SetParameterFloatSets a float parameter in this Particle System
SetParameterIntSets an integer parameter in this Particle System
SetParameterBoolSets a boolean parameter in this Particle System
SetParameterVectorSets a Vector parameter in this Particle System
SetParameterColorSets a Color parameter in this Particle System
SetParameterMaterialSets a Material parameter in this Particle System
SetParameterMaterialFromTextureSets a Material from a Texture parameter in this Particle System
SetParameterMaterialFromCanvasSets a Material from a Canvas parameter in this Particle System
SetParameterMaterialFromWebUISets a Material from a Canvas parameter in this Particle System

Activate​

Activates the Emitter
my_particle:Activate(should_reset)
TypeParameterDefaultDescription
boolean should_resetIf should reset

Deactivate​

Deactivate the Emitter
my_particle:Deactivate()

SetParameterFloat​

Sets a float parameter in this Particle System
my_particle:SetParameterFloat(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
number valueThe float value

SetParameterInt​

Sets an integer parameter in this Particle System
my_particle:SetParameterInt(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
number valueThe int value

SetParameterBool​

Sets a boolean parameter in this Particle System
my_particle:SetParameterBool(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
boolean valueThe boolean value

SetParameterVector​

Sets a Vector parameter in this Particle System
my_particle:SetParameterVector(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
Vector valueThe Vector value

SetParameterColor​

Sets a Color parameter in this Particle System
my_particle:SetParameterColor(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
Color valueThe Color value

SetParameterMaterial​

Sets a Material parameter in this Particle System
my_particle:SetParameterMaterial(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
Material Reference valueThe Material value

SetParameterMaterialFromTexture​

This will create a Material and set this Texture as it's parameter internally, then set the Material into the Particle parameter
my_particle:SetParameterMaterialFromTexture(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
Image Path valueThe Texture value

SetParameterMaterialFromCanvas​

This will create a Material and set this Canvas as it's parameter internally, then set the Material into the Particle parameter
my_particle:SetParameterMaterialFromCanvas(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
Canvas valueThe Canvas value

SetParameterMaterialFromWebUI​

This will create a Material and set this WebUI as it's parameter internally, then set the Material into the Particle parameter
my_particle:SetParameterMaterialFromWebUI(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
WebUI valueThe WebUI value

πŸš€ Events​

Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/actor
NameDescription
DestroyTriggered when an Actor is destroyed
SpawnTriggered when an Actor is spawned/created
ValueChangeTriggered when an Actor has a value changed with :SetValue()
This entity doesn't have own events.