Skip to main content
Version: latest - a1.30.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 shares methods and events from Base Entity 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?
)

🛠 Constructors

Default Constructor

local my_particle = Particle(location, rotation, asset, auto_destroy?, auto_activate?)
TypeNameDefaultDescription
Vector location
Rotator rotation
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.

🗿 Static Functions

Inherited Entity Static Functions
Base Entityscripting-reference/classes/base-classes/entity
ReturnsNameDescription
table of Base Entity GetAllReturns a table containing all Entities of the class this is called on
Base Entity GetByIndexReturns a specific Entity of this class at an index
integer GetCountReturns how many Entities of this class exist
iterator GetPairsReturns an iterator with all Entities of this class to be used with pairs()
table InheritInherits this class with the Inheriting System
table of table GetInheritedClassesGets a list of all directly inherited classes from this Class created with the Inheriting System
table or nilGetParentClassGets the parent class if this Class was created with the Inheriting System
boolean IsChildOfGets if this Class is child of another class if this Class was created with the Inheriting System
function SubscribeSubscribes to an Event for all entities of this Class
function SubscribeRemoteSubscribes to a custom event called from server
UnsubscribeUnsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed
This entity doesn't have own static functions.

🦠 Functions

Inherited Entity Functions
Base Entityscripting-reference/classes/base-classes/Entity
ReturnsNameDescription
integer GetIDGets the universal network ID of this Entity (same on both client and server)
table GetClassGets the class of this entity
boolean IsARecursively checks if this entity is inherited from a Class
function SubscribeSubscribes to an Event on this specific entity
function SubscribeRemoteSubscribes to a custom event called from server on this specific entity
UnsubscribeUnsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed
SetValueSets a Value in this Entity
any GetValueGets a Value stored on this Entity at the given key
DestroyDestroys this Entity
boolean IsValidReturns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
CallRemoteEventCalls a custom remote event directly on this entity to a specific Player
CallRemoteEventCalls a custom remote event directly on this entity
BroadcastRemoteEventCalls a custom remote event directly on this entity to all Players
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
DetachDetaches this Actor from AttachedTo Actor
SetCollisionSets this Actor's collision type
SetDimensionSets this Actor's Dimension
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
SetNetworkAuthorityAutoDistributedSets if this Actor will auto distribute the network authority betwen players
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
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
Vector GetLocationGets this Actor's location in the game world
Vector GetRelativeLocationGets this Actor's Relative Location if it's attached
Player or nilGetNetworkAuthorityGets this Actor's Network Authority Player
Rotator GetRotationGets this Actor's angle in the game world
Rotator GetRelativeRotationGets this Actor's Relative Rotation if it's attached
Vector GetForceGets this Actor's force (set by SetForce())
integer GetDimensionGets this Actor's dimension
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
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
boolean WasRecentlyRenderedGets if this Actor was recently rendered on screen
float GetDistanceFromCameraGets the distance of this Actor from the Camera
float GetScreenPercentageGets the percentage of this Actor size in the screen
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
float valueThe float value

SetParameterInt

Sets an integer parameter in this Particle System
my_particle:SetParameterInt(parameter, value)
TypeParameterDefaultDescription
string parameterThe parameter name
integer 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 Entity Events
Base Entityscripting-reference/classes/base-classes/Entity
NameDescription
SpawnTriggered when an Entity is spawned/created
DestroyTriggered when an Entity is destroyed
ValueChangeTriggered when an Entity has a value changed with :SetValue()
ClassRegisterTriggered when a new Class is registered with the Inheriting System
Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/actor
NameDescription
DimensionChangeTriggered when an Actor changes it's dimension
This entity doesn't have own events.