✨ 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.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

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

No description provided

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

Type	Name	Default	Description
Vector	location	Required parameter	No description provided
Rotator	rotation	Required parameter	No description provided
Particle Reference	asset	Required parameter	No description provided
boolean	auto_destroy	true	No description provided
boolean	auto_activate	true	No description provided

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

Particle inherits from Base Entity Class, sharing it's methods and 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
	table of table	GetInheritedClasses	Gets a list of all directly inherited classes from this Class created with the Inheriting System
	iterator	GetPairs	Returns an iterator with all Entities of this class to be used with pairs()
	table or nil	GetParentClass	Gets the parent class if this Class was created with the Inheriting System
	table	Inherit	Inherits this class 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 class doesn't have own static functions.

🦠 Functions

Inherited Entity Functions

Particle inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity

	Returns	Name	Description
		BroadcastRemoteEvent	Calls a custom remote event directly on this entity to all Players
		CallRemoteEvent	Calls a custom remote event directly on this entity to a specific Player
		CallRemoteEvent	Calls a custom remote event directly on this entity
		Destroy	Destroys this Entity
	table of string	GetAllValuesKeys	Gets a list of all values keys
	table	GetClass	Gets the class of this entity
	integer	GetID	Gets the universal network ID of this Entity (same on both client and server)
	any	GetValue	Gets a Value stored on this Entity at the given key
	boolean	IsA	Recursively checks if this entity is inherited from a Class
	boolean	IsValid	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
		SetValue	Sets a Value in this Entity
	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

Inherited Actor Functions

Particle inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/Actor

	Returns	Name	Description
		AddActorTag	Adds an Unreal Actor Tag to this Actor
		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
	table of string	GetActorTags	Gets all Unreal Actor Tags on this Actor
	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
	integer	GetDimension	Gets this Actor's dimension
	float	GetDistanceFromCamera	Gets the distance of this Actor from the Camera
	Vector	GetForce	Gets this Actor's force (set by SetForce())
	Vector	GetLocation	Gets this Actor's location in the game world
	Player or nil	GetNetworkAuthority	Gets this Actor's Network Authority Player
	Vector	GetRelativeLocation	Gets this Actor's Relative Location if it's attached
	Rotator	GetRelativeRotation	Gets this Actor's Relative Rotation if it's attached
	Rotator	GetRotation	Gets this Actor's angle in the game world
	Vector	GetScale	Gets this Actor's scale
	float	GetScreenPercentage	Gets the percentage of this Actor size in the screen
	table	GetSocketTransform	Gets a Socket Transform in world space given a bone or socket name
	Vector	GetVelocity	Gets this Actor's current velocity
	boolean	HasAuthority	Gets if this Actor was spawned by the client side
	boolean	HasNetworkAuthority	Returns true if the local Player is currently the Network Authority of this Actor
	boolean	IsBeingDestroyed	Returns true if this Actor is being destroyed
	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
	boolean	IsVisible	Returns true if this Actor is visible
		RemoveActorTag	Removes an Unreal Actor Tag from this Actor
		RotateTo	Smoothly rotates this actor to an angle over a certain time
		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
		SetHighlightEnabled	Sets whether the highlight is enabled on this Actor, and which highlight 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
		SetNetworkAuthority	Sets the Player to have network authority over this Actor
		SetNetworkAuthorityAutoDistributed	Sets if this Actor will auto distribute the network authority between players
		SetOutlineEnabled	Sets whether the outline is enabled on this Actor, and which outline index to use
		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)
		SetRotation	Sets this Actor's rotation in the game world
		SetScale	Sets this Actor's scale
		SetVisibility	Sets whether the actor is visible or not
		TranslateTo	Smoothly moves this actor to a location over a certain time
	boolean	WasRecentlyRendered	Gets if this Actor was recently rendered on screen

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

---

Activate

Activates the Emitter

my_particle:Activate(should_reset)

Type	Parameter	Default	Description
boolean	should_reset	Required parameter	If should reset

See also Deactivate, IsActive.

---

Deactivate

Deactivate the Emitter

my_particle:Deactivate()

See also Activate, IsActive.

---

IsActive

Returns if this Particle is active

— Returns boolean.

local ret = my_particle:IsActive()

See also Activate, Deactivate.

---

SetParameterBool

Sets a boolean parameter in this Particle System

my_particle:SetParameterBool(parameter, value)

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

---

SetParameterColor

Sets a Color parameter in this Particle System

my_particle:SetParameterColor(parameter, value)

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

---

SetParameterFloat

Sets a float parameter in this Particle System

my_particle:SetParameterFloat(parameter, value)

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

---

SetParameterInt

Sets an integer parameter in this Particle System

my_particle:SetParameterInt(parameter, value)

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

---

SetParameterMaterial

Sets a Material parameter in this Particle System

my_particle:SetParameterMaterial(parameter, value)

Type	Parameter	Default	Description
string	parameter	Required parameter	The parameter name
Material Reference	value	Required parameter	The Material 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	Required parameter	The parameter name
Canvas	value	Required parameter	The Canvas 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	Required parameter	The parameter name
Image Path	value	Required parameter	The Texture 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	Required parameter	The parameter name
WebUI	value	Required parameter	The WebUI value

---

SetParameterVector

Sets a Vector parameter in this Particle System

my_particle:SetParameterVector(parameter, value)

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

🚀 Events

Inherited Entity Events

Particle inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/Entity

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

Inherited Actor Events

Particle inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/Actor

	Name	Description
	DimensionChange	Triggered when an Actor changes it's dimension

This class doesn't have own events.