✨ Particle

Particle Entity.

info

🟦🟧 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 Actor.

tip

Both Cascade and Niagara Particle Systems are supported!

Utilisation

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

Constructor Parameters

Type	Nom	Default
Vector	location	Vector(0, 0, 0)
Rotator	rotation	Rotator(0, 0, 0)
Particle Asset	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.

Functions

Inherited Actor Functions

Base Actorscripting-reference/classes/base-classes/actor

	Returns	Name	Description
		AddImpulse	Applies a Force in world space to this Actor
		AttachTo	Attaches this Actor to another Actor
		Destroy	Destroys this Actor
		Detach	Detaches this Actor if attached
		SetCollision	Sets this Actor's collision type
		SetForce	Adds a permanent force to this Actor
		SetGravityEnabled	Sets whether gravity is enabled on this Actor
		SetVisibility	Sets the Actor visibility
		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
		SetLocation	Sets this Actor's location in the game world
		SetNetworkAuthority	Sets the Player this Actor will have its physics calculated on Network Authority
		SetRelativeLocation	Sets this Actor's relative location in local space
		SetRelativeRotation	Sets this Actor's relative rotation in local space
		SetRotation	Sets this Actor's rotation in the game world
		SetScale	Sets this Actor's scale
		SetValue	Sets a value in this Actor, which can be accessed by any package
		TranslateTo	Smoothly moves this Actor to the specified location
		RotateTo	Smoothly rotates this Actor to the specified angle
	boolean	HasNetworkAuthority	Gets if the LocalPlayer is currently the Network Authority of this Actor
	boolean	HasAuthority	Gets if this Actor was spawned by the client side
	boolean	IsBeingDestroyed	Gets if this Actor is being destroyed
	boolean	IsGravityEnabled	Gets whether gravity is enabled on this Actor
	boolean	IsVisible	Gets whether this actor is Visible or not
	boolean	IsInWater	Gets if this Actor is in water
	boolean	IsNetworkDistributed	Gets if this Actor is currently Network Distributed
	boolean	IsValid	Returns if this Actor is valid (i.e. not destroyed)
	table	GetAttachedEntities	Gets all Actors attached to this Actor
	any	GetAttachedTo	Gets the Actor this Actor is attached to
	table	GetBounds	Gets this Actor's bounds
	number	GetCollision	Gets this Actor's collision type
	number	GetID	Gets the universal network ID of this Actor
	Vector	GetLocation	Gets this Actor's location in the game world
	Rotator	GetRotation	Gets this Actor's angle in the game world
	Vector	GetForce	Gets this Actor's scale
	Vector	GetScale	Gets this Actor's scale
	string	GetType	Gets the type of this Actor
	any	GetValue	Gets a value stored on this Actor at the given key
	Vector	GetVelocity	Returns this Actor's current velocity
	string	AddActorTag	Adds an Unreal Actor Tag to this Actor
	string	RemoveActorTag`	Remove an Unreal Actor Tag from this Actor
	table	GetActorTags	Gets all Unreal Actor Tags from this Actor
	function	Subscribe	Subscribes to an Event
		Unsubscribe	Unsubscribes from an Event

Valeur retournée	Nom	Description
	Activate	Activates the Emitter
	Deactivate	Deactivates 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 parameter from a Texture in this Particle System
	SetParameterMaterialFromCanvas	Sets a Material parameter from a Canvas in this Particle System
	SetParameterMaterialFromWebUI	Sets a Material parameter from a WebUI in this Particle System

Activate

Activates the Emitter

my_particle:Activate(should_reset)

Type	Parameter	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	Description
string	parameter	The parameter name
number	value	The float value

SetParameterInt

Sets an integer parameter in this Particle System

my_particle:SetParameterInt(parameter, value)

Type	Parameter	Description
string	parameter	The parameter name
number	value	The int value

SetParameterBool

Sets a boolean parameter in this Particle System

my_particle:SetParameterBool(parameter, value)

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

SetParameterVector

Sets a float parameter in this Particle System

my_particle:SetParameterVector(parameter, value)

Type	Parameter	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	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	Description
string	parameter	The parameter name
Material Asset	value	The Material value

SetParameterMaterialFromTexture

Sets a Material from a Texture parameter in this Particle System

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	Description
string	parameter	The parameter name
Image Special Path	value	The Texture value

SetParameterMaterialFromCanvas

Sets a Material from a Canvas parameter in this Particle System

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	Description
string	parameter	The parameter name
Canvas	value	The Canvas entity

SetParameterMaterialFromWebUI

Sets a Material from a Canvas parameter in this Particle System

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	Description
string	parameter	The parameter name
WebUI	value	The WebUI entity

Events

Inherited Actor Events

Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	Destroy	Triggered when an Actor is destroyed
	Spawn	Triggered when an Actor is spawned/created
	ValueChange	Triggered when an Actor has a value changed with :SetValue()