Dayz Explorer
1.24.157551 (v105080)
Dayz Code Explorer by Zeroy
|
Go to the source code of this file.
Data Structures | |
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) More... | |
void | ~ParticleManagerSettings () |
dtor More... | |
void | ParticleManager (ParticleManagerSettings settings) |
Constructor (ctor) More... | |
void | ~ParticleManager () |
dtor More... | |
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. More... | |
ParticleSource | CreateParticleEx (int id, vector pos, int flags=ParticlePropertiesFlags.NONE, Object parent=null, vector ori=vector.Zero, Class owner=null) |
Master create function. More... | |
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. More... | |
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. More... | |
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. More... | |
ParticleSource | Create (int particle_id, vector global_pos, vector global_ori="0 0 0") |
Legacy function for backwards compatibility with 1.01 and below. More... | |
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. More... | |
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. More... | |
ParticleSource | PlayInWorld (int particle_id, vector global_pos) |
Creates a particle emitter on the given position and activates it. More... | |
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. More... | |
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. More... | |
ParticleSource | CreateParticleByPath (string path, notnull ParticleProperties properties) |
Create a particle. More... | |
int | CreateParticlesById (int id, notnull ParticlePropertiesArray properties, int count) |
QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well. More... | |
array< ParticleSource > | CreateParticlesByIdArr (int id, notnull ParticlePropertiesArray properties, int count) |
QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well. More... | |
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. More... | |
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. More... | |
array< ParticleSource > | PlayParticlesById (int id, array< vector > positions, int count) |
QoL function using script ParticleList, strongly recommend to read comments for PlayParticles as well. More... | |
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. More... | |
proto native ParticleSource | GetParticle (int index) |
Manually get the particle at index. More... | |
proto native int | GetParticles (out array< ParticleSource > outArray, int startIndex, int count) |
Manually get a portion of the particles in the pool. More... | |
array< ParticleSource > | GetParticlesEx (int startIndex, int count) |
Manually get a portion of the particles in the pool. More... | |
Identification | |
Identification functionality | |
proto native void | SetName (string name) |
Set a name for the ParticleManager to identify it more easily. More... | |
proto string | GetName () |
Gets the name which is set for the ParticleManager, default is "ParticleSourceManager". More... | |
proto string | GetDebugNameNative () |
Gets the debug name for the ParticleManager. More... | |
override string | GetDebugName () |
Gets the debug name for the ParticleManager. More... | |
proto int | GetCountID () |
Gets the ID for the ParticleManager. More... | |
Properties and state | |
Obtain information about the state of the ParticleManager | |
proto native int | GetPoolSize () |
Gets the fixed maximum size of the pool. More... | |
proto native int | GetAllocatedCount () |
Gets the amount of particles currently allocated. More... | |
proto native int | GetVirtualCount () |
Gets the amount of virtual particles. More... | |
proto native int | GetPlayingCount () |
Gets the amount of playing particles. More... | |
proto native bool | IsFinishedAllocating () |
Checks if the ParticleManager has allocated all slots in the pool. More... | |
Script Events API | |
Setting and getting of ScriptEvents | |
private proto void | SetScriptEvents (Managed events) |
Set the events. More... | |
private proto Managed | GetScriptEvents () |
Get the events. More... | |
ParticleManagerEvents | GetEvents () |
Get the events. More... | |
Events | |
Events called from C++ | |
void | OnAllocation (array< ParticleSource > allocatedParticles) |
void | OnAllocationEnd () |
Variables | |
class ParticleManagerEvents | g_ParticleManager |
Has a fixed pool of precreated and reserved particles. More... | |
Global ParticleManager settings | |
Settings applied to the global ParticleManager |
Flags for ParticleManagerSettings.
Definition at line 2 of file particlemanager.c.
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 174 of file particlemanager.c.
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 195 of file particlemanager.c.
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.
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 |
ParticleSource
Created particle instance Definition at line 187 of file particlemanager.c.
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.
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) |
ParticleSource
Created particle instance Definition at line 161 of file particlemanager.c.
ParticleSource CreateParticle | ( | int | id, |
vector | pos, | ||
bool | playOnCreation = false , |
||
Object | parent = null , |
||
vector | ori = vector.Zero , |
||
bool | forceWorldRotation = false , |
||
Class | owner = null |
||
) |
Create function.
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) |
ParticleSource
Created particle instance when successful Definition at line 111 of file particlemanager.c.
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.
id | int ID of particle registered in ParticleList |
properties | ParticleProperties Properties of the particles created |
ParticleSource
The resulting particle Definition at line 324 of file particlemanager.c.
ParticleSource CreateParticleByPath | ( | string | path, |
notnull ParticleProperties | properties | ||
) |
Create a particle.
path | string Path of particle effect |
properties | ParticleProperties Properties of the particles created |
ParticleSource
The resulting particle Definition at line 281 of file particlemanager.c.
ParticleSource CreateParticleEx | ( | int | id, |
vector | pos, | ||
int | flags = ParticlePropertiesFlags.NONE , |
||
Object | parent = null , |
||
vector | ori = vector.Zero , |
||
Class | owner = null |
||
) |
Master create function.
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) |
ParticleSource
Created particle instance when successful Definition at line 138 of file particlemanager.c.
proto native int CreateParticles | ( | array< ParticleSource > | particles, |
string | path, | ||
notnull ParticlePropertiesArray | properties, | ||
int | count = 1 |
||
) |
Creates an amount of particles with the properties given.
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 |
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 QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well.
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 |
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 299 of file particlemanager.c.
array<ParticleSource> CreateParticlesByIdArr | ( | int | id, |
notnull ParticlePropertiesArray | properties, | ||
int | count | ||
) |
QoL function using script ParticleList, strongly recommend to read comments for CreateParticles as well.
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 |
array<ParticleSource>
The resulting particles - Read particles param of CreateParticles Definition at line 311 of file particlemanager.c.
proto native int GetAllocatedCount | ( | ) |
Gets the amount of particles currently allocated.
int
Amount of particles currently allocated proto int GetCountID | ( | ) |
Gets the ID for the ParticleManager.
int
ID for the ParticleManager (different every restart, as it is the nth instance created since the start of the program) override string GetDebugName | ( | ) |
Gets the debug name for the ParticleManager.
string
"name:id" Definition at line 436 of file particlemanager.c.
proto string GetDebugNameNative | ( | ) |
Gets the debug name for the ParticleManager.
dbgName | string "name:id" |
ParticleManagerEvents GetEvents | ( | ) |
Get the events.
ParticleManagerEvents
If there is any events set, this will return them so that additional functionality can be bound to them Definition at line 523 of file particlemanager.c.
proto native ParticleSource GetParticle | ( | int | index | ) |
Manually get the particle at index.
index | int Index of particle |
ParticleSource
ParticleSource at given index proto native int GetParticles | ( | out array< ParticleSource > | outArray, |
int | startIndex, | ||
int | count | ||
) |
Manually get a portion of the particles in the pool.
particles | array<ParticleSource> The resulting particles |
startIndex | int Starting index |
count | int Amount of particles to get |
int
Amount of particles in outArray array<ParticleSource> GetParticlesEx | ( | int | startIndex, |
int | count | ||
) |
Manually get a portion of the particles in the pool.
startIndex | int Starting index |
count | int Amount of particles to get |
array<ParticleSource>
The resulting particles Definition at line 398 of file particlemanager.c.
proto native int GetPlayingCount | ( | ) |
Gets the amount of playing particles.
int
Amount of currently playing particles proto native int GetPoolSize | ( | ) |
Gets the fixed maximum size of the pool.
int
The fixed maximum size of the pool private proto Managed GetScriptEvents | ( | ) |
Get the events.
Managed
If there is any events set, this will return them proto native int GetVirtualCount | ( | ) |
Gets the amount of virtual particles.
int
Amount of virtual particles currently waiting to be turned into real particles proto native bool IsFinishedAllocating | ( | ) |
Checks if the ParticleManager has allocated all slots in the pool.
bool
True when the number of allocated particles is the same as the pool size void OnAllocation | ( | array< ParticleSource > | allocatedParticles | ) |
Definition at line 537 of file particlemanager.c.
void OnAllocationEnd | ( | ) |
Definition at line 542 of file particlemanager.c.
void ParticleManager | ( | ParticleManagerSettings | settings | ) |
Constructor (ctor)
settings | ParticleManagerSettings Settings for the ParticleManager |
Definition at line 84 of file particlemanager.c.
class ParticleManagerConstants ParticleManagerSettings | ( | int | poolSize, |
int | flags = ParticleManagerSettingsFlags.NONE |
||
) |
Settings given to ParticleManager on creation (in ctor)
Constructor (ctor)
poolSize | int Size of pool (amount of created and reserved particles) |
flags | int ParticleManagerSettingsFlags |
Definition at line 35 of file particlemanager.c.
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 226 of file particlemanager.c.
ParticleSource Play | ( | int | particle_id, |
vector | global_pos | ||
) |
Legacy function for backwards compatibility with 1.01 and below.
Definition at line 251 of file particlemanager.c.
ParticleSource PlayInWorld | ( | int | particle_id, |
vector | global_pos | ||
) |
Creates a particle emitter on the given position and activates it.
particle_id | int Particle ID registered in ParticleList |
global_pos | Vector Position where the particel will be created |
ParticleSource
Created particle instance Definition at line 237 of file particlemanager.c.
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 242 of file particlemanager.c.
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.
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) |
ParticleSource
Created particle instance Definition at line 218 of file particlemanager.c.
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.
id | int ID of particle registered in ParticleList |
positions | array<vector> Positions of particles |
ParticleSource
The resulting particle Definition at line 365 of file particlemanager.c.
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.
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 |
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 QoL function using script ParticleList, strongly recommend to read comments for PlayParticles as well.
id | int ID of particle registered in ParticleList |
positions | array<vector> Positions of particles |
count | int Amount of particles to create at this position |
array<ParticleSource>
The resulting particles - Read particles param of PlayParticles Definition at line 352 of file particlemanager.c.
proto native void SetName | ( | string | name | ) |
Set a name for the ParticleManager to identify it more easily.
name | string Name for ParticleManager |
private proto void SetScriptEvents | ( | Managed | events | ) |
Set the events.
events | Managed The events to set |
void ~ParticleManager | ( | ) |
dtor
Definition at line 89 of file particlemanager.c.
void ~ParticleManagerSettings | ( | ) |
dtor
Definition at line 40 of file particlemanager.c.
class ParticleManagerEvents g_ParticleManager |
Has a fixed pool of precreated and reserved particles.
Static ParticleManager