Classes
class	ParticleManagerConstants
	Class simply to have easily modded constants. More...

class	ParticleManagerEvents
	Invokers for ParticleManager events. More...

Enumerations
enum	ParticleManagerSettingsFlags { NONE , FIXED_INDEX , BLOCKING , DISABLE_VIRTUAL , REUSE_OWNED }
	Flags for ParticleManagerSettings. More...

Functions
class ParticleManagerConstants	ParticleManagerSettings (int poolSize, int flags=ParticleManagerSettingsFlags.NONE)
	Settings given to ParticleManager on creation (in ctor)

void	~ParticleManagerSettings ()
	dtor

void	ParticleManager (ParticleManagerSettings settings)
	Constructor (ctor)

void	~ParticleManager ()
	dtor

API for compatibility with Particle/ParticleSource create/play
Mimics the static Create and Play methods from Particle/ParticleSource
ParticleSource	CreateParticle (int id, vector pos, bool playOnCreation=false, Object parent=null, vector ori=vector.Zero, bool forceWorldRotation=false, Class owner=null)
	Create function.

ParticleSource	CreateParticleEx (int id, vector pos, int flags=ParticlePropertiesFlags.NONE, Object parent=null, vector ori=vector.Zero, Class owner=null)
	Master create function.

ParticleSource	CreateOnObject (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_world_rotation=false)
	Creates a particle emitter and attaches it on the given object.

ParticleSource	Create (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Legacy function for backwards compatibility.

ParticleSource	CreateInWorld (int particle_id, vector global_pos, vector global_ori="0 0 0", bool force_world_rotation=false)
	Creates a particle emitter on the given position.

ParticleSource	Create (int particle_id, vector global_pos, vector global_ori="0 0 0")
	Legacy function for backwards compatibility with 1.01 and below.

Static play on creation
You can use the following Play(...) functions to create and activate a particle in 1 line of your script.
ParticleSource	PlayOnObject (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_world_rotation=false)
	Creates a particle emitter, attaches it on the given object and activates it.

ParticleSource	Play (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Legacy function for backwards compatibility with 1.01 and below.

ParticleSource	PlayInWorld (int particle_id, vector global_pos)
	Creates a particle emitter on the given position and activates it.

ParticleSource	PlayInWorldEx (int particle_id, Object parent_obj, vector global_pos, vector global_ori="0 0 0", bool force_world_rotation=false)

ParticleSource	Play (int particle_id, vector global_pos)
	Legacy function for backwards compatibility with 1.01 and below.

Get Particles
API for creating, playing or obtaining particles from the pool
proto native int	CreateParticles (array< ParticleSource > particles, string path, notnull ParticlePropertiesArray properties, int count=1)
	Creates an amount of particles with the properties given.

ParticleSource	CreateParticleByPath (string path, notnull ParticleProperties properties)
	Create a particle.

int	CreateParticlesById (int id, notnull ParticlePropertiesArray properties, int count)
	QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well.

array< ParticleSource >	CreateParticlesByIdArr (int id, notnull ParticlePropertiesArray properties, int count)
	QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well.

ParticleSource	CreateParticleById (int id, ParticleProperties properties)
	QoL function for when only one particle is needed using script ParticleList, strongly recommend to read comments for CreateParticles as well.

proto native int	PlayParticles (out array< ParticleSource > particles, string path, notnull array< vector > positions, int count=1)
	QoL function for when wanting to play a particle at a position right away.

array< ParticleSource >	PlayParticlesById (int id, array< vector > positions, int count)
	QoL function using script ParticleList, strongly recommend to read comments for PlayParticles as well.

ParticleSource	PlayParticleById (int id, array< vector > position)
	QoL function for when only one particle is needed using script ParticleList, strongly recommend to read comments for PlayParticles as well.

proto native ParticleSource	GetParticle (int index)
	Manually get the particle at index.

proto native int	GetParticles (out array< ParticleSource > outArray, int startIndex, int count)
	Manually get a portion of the particles in the pool.

array< ParticleSource >	GetParticlesEx (int startIndex, int count)
	Manually get a portion of the particles in the pool.

Identification
Identification functionality
proto native void	SetName (string name)
	Set a name for the ParticleManager to identify it more easily.

proto string	GetName ()
	Gets the name which is set for the ParticleManager, default is "ParticleSourceManager".

proto string	GetDebugNameNative ()
	Gets the debug name for the ParticleManager.

override string	GetDebugName ()
	Gets the debug name for the ParticleManager.

proto int	GetCountID ()
	Gets the ID for the ParticleManager.

Properties and state
Obtain information about the state of the ParticleManager
proto native int	GetPoolSize ()
	Gets the fixed maximum size of the pool.

proto native int	GetAllocatedCount ()
	Gets the amount of particles currently allocated.

proto native int	GetVirtualCount ()
	Gets the amount of virtual particles.

proto native int	GetPlayingCount ()
	Gets the amount of playing particles.

proto native bool	IsFinishedAllocating ()
	Checks if the ParticleManager has allocated all slots in the pool.

Script Events API
Setting and getting of ScriptEvents
Events
Events called from C++

Variables
class ParticleManagerEvents	g_ParticleManager
	Has a fixed pool of precreated and reserved particles.

Global ParticleManager settings
Settings applied to the global ParticleManager

Enumeration Type Documentation

◆ ParticleManagerSettingsFlags

enum ParticleManagerSettingsFlags

Flags for ParticleManagerSettings.

Enumerator
NONE
FIXED_INDEX	Particles will be locked to the index and not reused.
BLOCKING	Allocation blocks the game until it is done.
DISABLE_VIRTUAL	Disable the creation of virtual particles when the pool is still allocating.
REUSE_OWNED	Reuse stopped particles even if they are owned by something.

Definition at line 2 of file particlemanager.c.

Function Documentation

◆ Create() [1/2]

ParticleSource Create	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = "0 0 0",
		vector	local_ori = "0 0 0" )

Legacy function for backwards compatibility.

Definition at line 178 of file particlemanager.c.

◆ Create() [2/2]

ParticleSource Create	(	int	particle_id,
		vector	global_pos,
		vector	global_ori = "0 0 0" )

Legacy function for backwards compatibility with 1.01 and below.

Definition at line 199 of file particlemanager.c.

◆ CreateInWorld()

ParticleSource CreateInWorld	(	int	particle_id,
		vector	global_pos,
		vector	global_ori = "0 0 0",
		bool	force_world_rotation = false )

Creates a particle emitter on the given position.

Parameters

particle_id	`int` Particle ID registered in ParticleList
global_pos	`Vector` Position where the particel will be created
global_ori	`vector` Orientation (Pitch, Yawn, Roll in degrees) (Optional)
force_world_rotation	`bool` Has absolutely no effect here as there is no parent

Returns: ParticleSource Created particle instance

Definition at line 191 of file particlemanager.c.

◆ CreateOnObject()

ParticleSource CreateOnObject	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = "0 0 0",
		vector	local_ori = "0 0 0",
		bool	force_world_rotation = false )

Creates a particle emitter and attaches it on the given object.

Parameters

particle_id	`int` Particle ID registered in ParticleList
parent_obj	`Object` Instance on which this particle will be attached
local_pos	`vector` Attachment position local to the parent (Optional)
local_ori	`vector` Orientation local to the parent (Pitch, Yaw, Roll in degrees) (Optional)
force_world_rotation	`bool` Forces particle's orientation to rotate relative to the world and not with the object (Optional)

Returns: ParticleSource Created particle instance

Definition at line 165 of file particlemanager.c.

◆ CreateParticle()

ParticleSource CreateParticle	(	int	id,
		vector	pos,
		bool	playOnCreation = false,
		Object	parent = null,
		vector	ori = vector.Zero,
		bool	forceWorldRotation = false,
		Class	owner = null )

Create function.

Parameters

id	`int` Particle ID registered in ParticleList
pos	`vector` Position of ParticleSource in LS (WS when no parent)
playOnCreation	`bool` Whether to play immediately after creation (Optional)
parent	`Object` Parent Object which will child the ParticleSource (Optional)
ori	`vector` Orientation of ParticleSource in LS (WS when no parent) (Pitch, Yaw, Roll in degrees) (Optional)
forceWorldRotation	`bool` Forces orientation to rotate relative to the world and not with the parent (Optional)
owner	`Class` The owning instance for this particle (Optional)

Returns: ParticleSource Created particle instance when successful

Definition at line 115 of file particlemanager.c.

◆ CreateParticleById()

ParticleSource CreateParticleById	(	int	id,
		ParticleProperties	properties )

QoL function for when only one particle is needed using script ParticleList, strongly recommend to read comments for CreateParticles as well.

Parameters

id	`int` ID of particle registered in ParticleList
properties	`ParticleProperties` Properties of the particles created

Returns: ParticleSource The resulting particle

Definition at line 328 of file particlemanager.c.

◆ CreateParticleByPath()

ParticleSource CreateParticleByPath	(	string	path,
		notnull ParticleProperties	properties )

Create a particle.

Parameters

path	`string` Path of particle effect
properties	`ParticleProperties` Properties of the particles created

Returns: ParticleSource The resulting particle

Definition at line 285 of file particlemanager.c.

◆ CreateParticleEx()

ParticleSource CreateParticleEx	(	int	id,
		vector	pos,
		int	flags = ParticlePropertiesFlags.NONE,
		Object	parent = null,
		vector	ori = vector.Zero,
		Class	owner = null )

Master create function.

Parameters

id	`int` Particle ID registered in ParticleList
pos	`vector` Position of ParticleSource in LS (WS when no parent)
flags	`int` See ParticlePropertiesFlags (Optional)
parent	`Object` Parent Object which will child the ParticleSource (Optional)
ori	`vector` Orientation of ParticleSource in LS (WS when no parent) (Pitch, Yaw, Roll in degrees) (Optional)
owner	`Class` The owning instance for this particle (Optional)

Returns: ParticleSource Created particle instance when successful

Definition at line 142 of file particlemanager.c.

◆ CreateParticles()

proto native int CreateParticles	(	array< ParticleSource >	particles,
		string	path,
		notnull ParticlePropertiesArray	properties,
		int	count = 1 )

Creates an amount of particles with the properties given.

Parameters

particles	`array<ParticleSource>` The resulting particles if an array is given
path	`string` Path of particle effect
properties	`ParticleProperties` Properties of the particles created
count	`int` Amount of particles to create with these properties

Returns: int Amount of particles created in this frame, if the ParticleManager is still allocating while this is called and virtual particles are enabled, the overflow particles will be virtual instead and not given in the out array

◆ CreateParticlesById()

int CreateParticlesById	(	int	id,
		notnull ParticlePropertiesArray	properties,
		int	count )

QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well.

Parameters

id	`int` ID of particle registered in ParticleList
properties	`ParticleProperties` Properties of the particles created
count	`int` Amount of particles to create with these properties

Returns: int Amount of particles created in this frame, if the ParticleManager is still allocating while this is called and virtual particles are enabled, the overflow particles will be virtual instead

Definition at line 303 of file particlemanager.c.

◆ CreateParticlesByIdArr()

array< ParticleSource > CreateParticlesByIdArr	(	int	id,
		notnull ParticlePropertiesArray	properties,
		int	count )

QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well.

Parameters

id	`int` ID of particle registered in ParticleList
properties	`ParticleProperties` Properties of the particles created
count	`int` Amount of particles to create with these properties

Returns: array<ParticleSource> The resulting particles - Read particles param of CreateParticles

Definition at line 315 of file particlemanager.c.

◆ GetAllocatedCount()

proto native int GetAllocatedCount ( )

Gets the amount of particles currently allocated.

Returns: int Amount of particles currently allocated

◆ GetCountID()

proto int GetCountID ( )

Gets the ID for the ParticleManager.

Returns: int ID for the ParticleManager (different every restart, as it is the nth instance created since the start of the program)

◆ GetDebugName()

override string GetDebugName ( )

Gets the debug name for the ParticleManager.

Returns: string "name:id"

Definition at line 440 of file particlemanager.c.

◆ GetDebugNameNative()

proto string GetDebugNameNative ( )

Gets the debug name for the ParticleManager.

Parameters

dbgName string "name:id"

◆ GetParticle()

proto native ParticleSource GetParticle ( int index )

Manually get the particle at index.

Parameters

index int Index of particle

Returns: ParticleSource ParticleSource at given index

◆ GetParticles()

proto native int GetParticles	(	out array< ParticleSource >	outArray,
		int	startIndex,
		int	count )

Manually get a portion of the particles in the pool.

Parameters

particles	`array<ParticleSource>` The resulting particles
startIndex	`int` Starting index
count	`int` Amount of particles to get

Returns: int Amount of particles in outArray

◆ GetParticlesEx()

array< ParticleSource > GetParticlesEx	(	int	startIndex,
		int	count )

Manually get a portion of the particles in the pool.

Parameters

startIndex	`int` Starting index
count	`int` Amount of particles to get

Returns: array<ParticleSource> The resulting particles

Definition at line 402 of file particlemanager.c.

◆ GetPlayingCount()

proto native int GetPlayingCount ( )

Gets the amount of playing particles.

Returns: int Amount of currently playing particles

◆ GetPoolSize()

proto native int GetPoolSize ( )

Gets the fixed maximum size of the pool.

Returns: int The fixed maximum size of the pool

◆ GetVirtualCount()

proto native int GetVirtualCount ( )

Gets the amount of virtual particles.

Returns: int Amount of virtual particles currently waiting to be turned into real particles

◆ IsFinishedAllocating()

proto native bool IsFinishedAllocating ( )

Checks if the ParticleManager has allocated all slots in the pool.

Returns: bool True when the number of allocated particles is the same as the pool size

◆ ParticleManager()

void ParticleManager ( ParticleManagerSettings settings )

Constructor (ctor)

Parameters

settings ParticleManagerSettings Settings for the ParticleManager

Definition at line 88 of file particlemanager.c.

◆ ParticleManagerSettings()

class ParticleManagerConstants ParticleManagerSettings	(	int	poolSize,
		int	flags = ParticleManagerSettingsFlags.NONE )

Settings given to ParticleManager on creation (in ctor)

Constructor (ctor)

Parameters

poolSize	`int` Size of pool (amount of created and reserved particles)
flags	`int` ParticleManagerSettingsFlags

Definition at line 1 of file particlemanager.c.

◆ Play() [1/2]

ParticleSource Play	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = "0 0 0",
		vector	local_ori = "0 0 0" )

Legacy function for backwards compatibility with 1.01 and below.

Definition at line 230 of file particlemanager.c.

◆ Play() [2/2]

ParticleSource Play	(	int	particle_id,
		vector	global_pos )

Legacy function for backwards compatibility with 1.01 and below.

Definition at line 255 of file particlemanager.c.

◆ PlayInWorld()

ParticleSource PlayInWorld	(	int	particle_id,
		vector	global_pos )

Creates a particle emitter on the given position and activates it.

Parameters

particle_id	`int` Particle ID registered in ParticleList
global_pos	`Vector` Position where the particel will be created

Returns: ParticleSource Created particle instance

Definition at line 241 of file particlemanager.c.

◆ PlayInWorldEx()

ParticleSource PlayInWorldEx	(	int	particle_id,
		Object	parent_obj,
		vector	global_pos,
		vector	global_ori = "0 0 0",
		bool	force_world_rotation = false )

Definition at line 246 of file particlemanager.c.

◆ PlayOnObject()

ParticleSource PlayOnObject	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = "0 0 0",
		vector	local_ori = "0 0 0",
		bool	force_world_rotation = false )

Creates a particle emitter, attaches it on the given object and activates it.

Parameters

particle_id	`int` Particle ID registered in ParticleList
parent_obj	`Object` Instance on which this particle will be attached
local_pos	`vector` Attachment position local to the parent (Optional)
local_ori	`vector` Orientation local to the parent (Pitch, Yaw, Roll in degrees) (Optional)
force_world_rotation	`bool` Forces particle's orientation to rotate relative to the world and not with the object (Optional)

Returns: ParticleSource Created particle instance

Definition at line 222 of file particlemanager.c.

◆ PlayParticleById()

ParticleSource PlayParticleById	(	int	id,
		array< vector >	position )

QoL function for when only one particle is needed using script ParticleList, strongly recommend to read comments for PlayParticles as well.

Parameters

id	`int` ID of particle registered in ParticleList
positions	`array<vector>` Positions of particles

Returns: ParticleSource The resulting particle

Definition at line 369 of file particlemanager.c.

◆ PlayParticles()

proto native int PlayParticles	(	out array< ParticleSource >	particles,
		string	path,
		notnull array< vector >	positions,
		int	count = 1 )

QoL function for when wanting to play a particle at a position right away.

Parameters

particles	`array<ParticleSource>` The resulting particles if an array is given
path	`string` Path of particle effect
positions	`array<vector>` Positions of particles
count	`int` Amount of particles to create at this position

Returns: int Amount of particles created in this frame, if the ParticleManager is still allocating while this is called and virtual particles are enabled, the overflow particles will be virtual instead and not given in the out array

◆ PlayParticlesById()

array< ParticleSource > PlayParticlesById	(	int	id,
		array< vector >	positions,
		int	count )

QoL function using script ParticleList, strongly recommend to read comments for PlayParticles as well.

Parameters

id	`int` ID of particle registered in ParticleList
positions	`array<vector>` Positions of particles
count	`int` Amount of particles to create at this position

Returns: array<ParticleSource> The resulting particles - Read particles param of PlayParticles

Definition at line 356 of file particlemanager.c.

◆ SetName()

proto native void SetName ( string name )

Set a name for the ParticleManager to identify it more easily.

Parameters

name	`string` Name for ParticleManager

◆ ~ParticleManager()

void ~ParticleManager ( )

dtor

Definition at line 93 of file particlemanager.c.

◆ ~ParticleManagerSettings()

void ~ParticleManagerSettings ( )

dtor

Definition at line 44 of file particlemanager.c.

Variable Documentation

◆ g_ParticleManager

class ParticleManagerEvents g_ParticleManager

Has a fixed pool of precreated and reserved particles.

Static ParticleManager

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ ParticleManagerSettingsFlags

Function Documentation

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateInWorld()

◆ CreateOnObject()

◆ CreateParticle()

◆ CreateParticleById()

◆ CreateParticleByPath()

◆ CreateParticleEx()

◆ CreateParticles()

◆ CreateParticlesById()

◆ CreateParticlesByIdArr()

◆ GetAllocatedCount()

◆ GetCountID()

◆ GetDebugName()

◆ GetDebugNameNative()

◆ GetParticle()

◆ GetParticles()

◆ GetParticlesEx()

◆ GetPlayingCount()

◆ GetPoolSize()

◆ GetVirtualCount()

◆ IsFinishedAllocating()

◆ ParticleManager()

◆ ParticleManagerSettings()

◆ Play() [1/2]

◆ Play() [2/2]

◆ PlayInWorld()

◆ PlayInWorldEx()

◆ PlayOnObject()

◆ PlayParticleById()

◆ PlayParticles()

◆ PlayParticlesById()

◆ SetName()

◆ ~ParticleManager()

◆ ~ParticleManagerSettings()

Variable Documentation

◆ g_ParticleManager