Particle

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

💂Authority

This class can be spawned on both 🟧 Client and 🟦 Server side (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),
    "helix::P_Explosion",
    true, -- Auto Destroy?
    true -- Auto Activate?
)

Constructors

Default Constructor

local my_particle = Particle(location, rotation, asset, auto_destroy?, auto_activate?)

Type	Name	Default
Vector	`location`
Rotator	`rotation`
Particle Reference	`asset`
boolean	`auto_destroy`	`true`
boolean	`auto_activate`	`true`

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

Returns	Name	Description
table of Base Entity	`GetAll`	Returns a table containing all Entities of the class this is called on
Base Entity	`GetByIndex`	Returns a specific Entity of this class at an index
integer	`GetCount`	Returns how many Entities of this class exist
iterator	`GetPairs`	Returns an iterator with all Entities of this class to be used with `pairs()`
table	`Inherit`	Inherits this class with the Inheriting System
table of table	`GetInheritedClasses`	Gets a list of all directly inherited classes from this Class created with the Inheriting System
table or nil	`GetParentClass`	Gets the parent class if this Class was created with the Inheriting System
boolean	`IsChildOf`	Gets if this Class is child of another class if this Class was created with the Inheriting System
function	`Subscribe`	Subscribes to an Event for all entities of this Class
function	`SubscribeRemote`	Subscribes to a custom event called from server
	`Unsubscribe`	Unsubscribes 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

Returns	Name	Description
integer	`GetID`	Gets the universal network ID of this Entity (same on both client and server)
table	`GetClass`	Gets the class of this entity
boolean	`IsA`	Recursively checks if this entity is inherited from a Class
function	`Subscribe`	Subscribes to an Event on this specific entity
function	`SubscribeRemote`	Subscribes to a custom event called from server on this specific entity
	`Unsubscribe`	Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed
	`SetValue`	Sets a Value in this Entity
any	`GetValue`	Gets a Value stored on this Entity at the given key
	`Destroy`	Destroys this Entity
boolean	`IsValid`	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
	`CallRemoteEvent`	Calls a custom remote event directly on this entity to a specific Player
	`CallRemoteEvent`	Calls a custom remote event directly on this entity
	`BroadcastRemoteEvent`	Calls a custom remote event directly on this entity to all Players

Inherited Actor Functions

Base Actorscripting-reference/classes/base-classes/Actor

Returns	Name	Description
	`AddImpulse`	Applies a force in world world to this Actor
	`AttachTo`	Attaches this Actor to any other Actor, optionally at a specific bone
	`Detach`	Detaches this Actor from AttachedTo Actor
	`SetCollision`	Sets this Actor's collision type
	`SetDimension`	Sets this Actor's Dimension
	`SetForce`	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
	`SetGravityEnabled`	Sets whether gravity is enabled on this Actor
	`SetVisibility`	Sets whether the actor is visible or not
	`SetHighlightEnabled`	Sets whether the highlight is enabled on this Actor, and which highlight index to use
	`SetOutlineEnabled`	Sets whether the outline is enabled on this Actor, and which outline index to use
	`SetLifeSpan`	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
	`SetLocation`	Sets this Actor's location in the game world
	`SetRotation`	Sets this Actor's rotation in the game world
	`SetRelativeLocation`	Sets this Actor's relative location in local space (only if this actor is attached)
	`SetRelativeRotation`	Sets this Actor's relative rotation in local space (only if this actor is attached)
	`SetScale`	Sets this Actor's scale
	`SetNetworkAuthority`	Sets the Player to have network authority over this Actor
	`SetNetworkAuthorityAutoDistributed`	Sets if this Actor will auto distribute the network authority between players
	`TranslateTo`	Smoothly moves this actor to a location over a certain time
	`RotateTo`	Smoothly rotates this actor to an angle over a certain time
boolean	`IsBeingDestroyed`	Returns true if this Actor is being destroyed
boolean	`IsVisible`	Returns true if this Actor is visible
boolean	`IsGravityEnabled`	Returns true if gravity is enabled on this Actor
boolean	`IsInWater`	Returns true if this Actor is in water
boolean	`IsNetworkDistributed`	Returns true if this Actor is currently network distributed
table of Base Actor	`GetAttachedEntities`	Gets all Actors attached to this Actor
Base Actor or nil	`GetAttachedTo`	Gets the Actor this Actor is attached to
table	`GetBounds`	Gets this Actor's bounds
CollisionType	`GetCollision`	Gets this Actor's collision type
Vector	`GetLocation`	Gets this Actor's location in the game world
Vector	`GetRelativeLocation`	Gets this Actor's Relative Location if it's attached
Player or nil	`GetNetworkAuthority`	Gets this Actor's Network Authority Player
Rotator	`GetRotation`	Gets this Actor's angle in the game world
Rotator	`GetRelativeRotation`	Gets this Actor's Relative Rotation if it's attached
Vector	`GetForce`	Gets this Actor's force (set by `SetForce()`)
integer	`GetDimension`	Gets this Actor's dimension
boolean	`HasNetworkAuthority`	Returns true if the local Player is currently the Network Authority of this Actor
boolean	`HasAuthority`	Gets if this Actor was spawned by the client side
Vector	`GetScale`	Gets this Actor's scale
Vector	`GetVelocity`	Gets this Actor's current velocity
	`AddActorTag`	Adds an Unreal Actor Tag to this Actor
	`RemoveActorTag`	Removes an Unreal Actor Tag from this Actor
table of string	`GetActorTags`	Gets all Unreal Actor Tags on this Actor
boolean	`WasRecentlyRendered`	Gets if this Actor was recently rendered on screen
float	`GetDistanceFromCamera`	Gets the distance of this Actor from the Camera
float	`GetScreenPercentage`	Gets the percentage of this Actor size in the screen

	Returns	Name	Description
		`Activate`	Activates the Emitter
		`Deactivate`	Deactivate the Emitter
		`SetParameterFloat`	Sets a float parameter in this Particle System
		`SetParameterInt`	Sets an integer parameter in this Particle System
		`SetParameterBool`	Sets a boolean parameter in this Particle System
		`SetParameterVector`	Sets a Vector parameter in this Particle System
		`SetParameterColor`	Sets a Color parameter in this Particle System
		`SetParameterMaterial`	Sets a Material parameter in this Particle System
		`SetParameterMaterialFromTexture`	Sets a Material from a Texture parameter in this Particle System
		`SetParameterMaterialFromCanvas`	Sets a Material from a Canvas parameter in this Particle System
		`SetParameterMaterialFromWebUI`	Sets a Material from a Canvas parameter in this Particle System

`Activate`

Activates the Emitter

my_particle:Activate(should_reset)

Type	Parameter	Default	Description
boolean	`should_reset`		If should reset

`Deactivate`

Deactivate the Emitter

my_particle:Deactivate()

`SetParameterFloat`

Sets a float parameter in this Particle System

my_particle:SetParameterFloat(parameter, value)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
float	`value`		The float value

`SetParameterInt`

Sets an integer parameter in this Particle System

my_particle:SetParameterInt(parameter, value)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
integer	`value`		The int value

`SetParameterBool`

Sets a boolean parameter in this Particle System

my_particle:SetParameterBool(parameter, value)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
boolean	`value`		The boolean value

`SetParameterVector`

Sets a Vector parameter in this Particle System

my_particle:SetParameterVector(parameter, value)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
Vector	`value`		The Vector value

`SetParameterColor`

Sets a Color parameter in this Particle System

my_particle:SetParameterColor(parameter, value)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
Color	`value`		The Color value

`SetParameterMaterial`

Sets a Material parameter in this Particle System

my_particle:SetParameterMaterial(parameter, value)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
Material Reference	`value`		The 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)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
Image Path	`value`		The 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)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
Canvas	`value`		The 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)

Type	Parameter	Default	Description
string	`parameter`		The parameter name
WebUI	`value`		The WebUI value

Events

Inherited Entity Events

Base Entityscripting-reference/classes/base-classes/Entity

	Name	Description
	`Spawn`	Triggered when an Entity is spawned/created
	`Destroy`	Triggered when an Entity is destroyed
	`ValueChange`	Triggered when an Entity has a value changed with `:SetValue()`
	`ClassRegister`	Triggered when a new Class is registered with the Inheriting System

Inherited Actor Events

Base Actorscripting-reference/classes/base-classes/Actor

	Name	Description
	`Spawn`	Triggered when an Entity is spawned/created
	`Destroy`	Triggered when an Entity is destroyed
	`ValueChange`	Triggered when an Entity has a value changed with `:SetValue()`
	`ClassRegister`	Triggered when a new Class is registered with the Inheriting System

This entity doesn't have own events.

Examples​

Constructors​

Default Constructor​

Static Functions​

Functions​

Activate​

Deactivate​

SetParameterFloat​

SetParameterInt​

SetParameterBool​

SetParameterVector​

SetParameterColor​

SetParameterMaterial​

SetParameterMaterialFromTexture​

SetParameterMaterialFromCanvas​

SetParameterMaterialFromWebUI​

Events​

Examples

Constructors

Default Constructor

Static Functions

Functions

`Activate`

`Deactivate`

`SetParameterFloat`

`SetParameterInt`

`SetParameterBool`

`SetParameterVector`

`SetParameterColor`

`SetParameterMaterial`

`SetParameterMaterialFromTexture`

`SetParameterMaterialFromCanvas`

`SetParameterMaterialFromWebUI`

Events