Класс ParticleSource

Entity which has the particle instance as an ObjectComponent. Подробнее...

Граф наследования:ParticleSource:

Защищенные члены
void	ParticleInit ()
	Empty - Only needed for Particle.
proto native void	SetParticleAutoDestroyFlags (ParticleAutoDestroyFlags flags)
	Enables the particle to automatically clean up itself when ending or stopping.
void	DisableAutoDestroy ()
	Disables the particle automatically cleaning up itself when ending or stopping.
proto native int	GetParticleAutoDestroyFlags ()
	Gets the currently set ParticleAutoDestroyFlags flags set on this ParticleSource.
Events
ParticleBase events For ParticleSource, these are handed on C++ side For more information, read ParticleEvents
void	OnParticleParented (IEntity parent)
	Event when the particle receives a parent.
void	OnParticleUnParented (IEntity parent)
	Event when the particle is orphaned.
void	OnParticleStop ()
	Event when the particle stops.
Misc backwards compatibility helpers
Helpers for misc backwards compatibility functionality
override void	AddAsChild (Object parent, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_rotation_to_world=false)
	Attaches this particle onto some object. If null value is provided then the particle will be detached from the current parent.
Parameter API
Helpful methods for getting or setting parameters
override void	SetParticleParam (int parameter_id, float value)
	Set the value of a parameter of all emitors in the particle.
override void	SetParameter (int emitter, int parameter, float value)
	Set the value of a parameter of an emitor in the particle.
override void	GetParameter (int emitter, int parameter, out float value)
	Get the value of a parameter of an emitor in the particle.
override float	GetParameterEx (int emitter, int parameter)
	Get the value of a parameter of an emitor in the particle.
override void	ScaleParticleParamFromOriginal (int parameter_id, float coef)
	Scales the given parameter on all emitors relatively to their ORIGINAL value.
override void	ScaleParticleParam (int parameter_id, float coef)
	Scales the given parameter on all emitors relatively to their CURRENT value.
override void	IncrementParticleParamFromOriginal (int parameter_id, float value)
	Increments the value of the given parameter relatively from the ORIGINAL value.
override void	IncrementParticleParam (int parameter_id, float value)
	Increments the value of the given parameter relatively from the CURRENT value.

Защищенные статические члены
Create a particle (static)
Helper static methods to create/attach/play a ParticleSource on one line
static ParticleSource	CreateParticle (int id, vector pos, bool playOnCreation=false, Object parent=null, vector ori=vector.Zero, bool forceWorldRotation=false, Class owner=null)
	Create function.
static ParticleSource	CreateParticleEx (int id, vector pos, int flags=ParticlePropertiesFlags.NONE, Object parent=null, vector ori=vector.Zero, Class owner=null)
	Master create function.
static override Particle	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.
static override Particle	Create (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Legacy function for backwards compatibility.
static override Particle	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.
static override 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.
static override Particle	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.
static override Particle	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.
static override Particle	PlayInWorld (int particle_id, vector global_pos)
	Creates a particle emitter on the given position and activates it.
static override Particle	Play (int particle_id, vector global_pos)
	Legacy function for backwards compatibility with 1.01 and below.

Закрытые члены
void	ParticleSource ()
	ctor
void	~ParticleSource ()
	dtor
Playback
Methods regarding playing/stopping of particle
proto bool	PlayParticleNative (int flags)
	Method to tell the particle to start playing.
override bool	PlayParticleEx (int particle_id=-1, int flags=0)
	Method to tell the particle to start playing.
proto bool	StopParticleNative (int flags)
	Method to tell the particle to stop playing.
override bool	StopParticle (int flags=0)
	Method to tell the particle to stop playing.
proto native bool	ResetParticleNative ()
	Method to tell the particle to reset.
override bool	ResetParticle ()
	Method to tell the particle to reset.
proto native bool	RestartParticleNative ()
	Method to tell the particle to restart (reset + play)
override bool	RestartParticle ()
	Method to tell the particle to restart (reset + play)
proto bool	IsParticlePlayingNative ()
	Ask if the particle is still playing.
override bool	IsParticlePlaying ()
	Ask if the particle is still playing.
SetParticle
Methods that set the particle to be used
proto native bool	SetParticleNative (string path)
	Assigns a particle to the ParticleSource.
bool	SetParticle (string path)
	Assigns a particle to the ParticleSource.
bool	SetParticleByID (int id)
	Assigns a particle to the ParticleSource.
override void	SetSource (int particle_id)
	Sets particle id.
GetParticle
Methods that get the particle assigned
proto bool	GetParticleNative (out string path, EGetParticleMode mode)
	Gets the path to the currently assigned particle.
bool	GetParticle (out string path, EGetParticleMode mode)
	Gets the path to the currently assigned particle.
override int	GetParticleID ()
	Gets the ParticleList ID of the currently assigned particle.
int	GetParticleIDLegacy ()
	Gets the ParticleList ID of the currently assigned particle.
Apply properties
Methods to apply properties to the particle
proto native bool	ApplyPropertiesNative (ParticleProperties properties)
	Applies the properties given to the ParticleSource.
bool	ApplyProperties (ParticleProperties properties)
	Applies the properties given to the ParticleSource
Properties and state
Obtain information or set properties regarding the state of the Particle
override Object	GetDirectParticleEffect ()
	Returns direct particle effect entity.
override Object	GetParticleParent ()
	Returns the parent of this Particle if there is one.
proto bool	HasActiveParticleNative ()
	Returns if there is any particle active.
override bool	HasActiveParticle ()
	Returns if there is any particle active.
proto int	GetParticleCountNative ()
	Returns the total count of active particles in all emitors.
override int	GetParticleCount ()
	Returns the total count of active particles in all emitors.
proto bool	IsRepeatNative ()
	Returns whether there is a repeating particle.
override bool	IsRepeat ()
	Returns whether there is a repeating particle.
proto float	GetMaxLifetimeNative ()
	Returns the approx. max lifetime.
override float	GetMaxLifetime ()
	Returns the approx. max lifetime.
proto native Class	GetOwner ()
	Get the owner of this ParticleSource.
proto native void	SetOwner (Class owner)
	Set the owner of this ParticleSource.
proto native void	Orphan ()
	null the owner of this ParticleSource
Owning ParticleManager
Methods regarding the owner
proto native ParticleManager	GetParticleManager ()
	Get the ParticleManager the ParticleSource belongs to if any.
proto native int	GetIndex ()
	Get the index of this ParticleSource in the owning ParticleManager.
Закрытые члены унаследованные от Particle
override void	PlayParticle (int particle_id=-1)
	Method to tell the particle to start playing.
override bool	PlayParticleEx (int particle_id=-1, int flags=0)
	Method to tell the particle to start playing.
void	Play (int particle_id=-1)
	Legacy function for backwards compatibility with 1.01 and below.
override bool	StopParticle (int flags=0)
	Method to tell the particle to stop playing.
void	Stop ()
	Legacy function for backwards compatibility with 1.14 and below.
void	SetSource (int particle_id)
	Sets particle id.
int	GetParticleID ()
	Gets particle id.
Object	GetDirectParticleEffect ()
	Returns direct particle effect entity which is usually handled by this class 'Particle' if there is one.
Object	GetParticleParent ()
	Returns the parent of this Particle if there is one.
bool	HasActiveParticle ()
	Returns if there is any particle active.
int	GetParticleCount ()
	Returns the total count of active particles in all emitors.
bool	IsRepeat ()
	Returns whether there is a repeating particle.
float	GetMaxLifetime ()
	Returns the approx. max lifetime.
void	ParticleInit ()
	Purely here so that it can be emptied in ParticleSource.
vector	RandWiggleVector ()
	Helper to get a randomized wiggle vector.
float	RandWiggleFloat ()
	Helper to get a randomized wiggle float value.
void	UpdateState ()
	Creates/Destroys ParticleEffect child according to current state.

Static counter API
Gives counter information for the class
proto int	GetCountID ()
	Gets the ID for the ParticleSource.
proto static native int	GetStaticCount ()
	Gets the amount of ParticleSource that have been created since the start of the program.
proto static native int	GetStaticActiveCount ()
	Gets the amount of ParticleSource that are currently existing.

Wiggle API
Settings to make the Particle wiggle
void	RandomizeOrientation ()
	Randomizes a new orientation and applies it.
override void	SetWiggle (float random_angle, float random_interval)
	Makes the particle change direction by random_angle every random_interval seconds.
override void	StopWiggle ()
	Stops randomized wiggle.

Misc Particle specific helpers
Functionality specific for Particle, so we empty them here
void	UpdateState ()
	Empty.
void	DestroyParticleEffect ()
	Empty.
void	CreateParticleEffect ()
	Empty.
void	OnCheckAutoDelete ()
	Empty.
void	OnToDelete ()
	Empty.
void	EOnFrame (IEntity other, float timeSlice)
	Empty.

Дополнительные унаследованные члены
Закрытые статические члены унаследованные от Particle
static Particle	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.
static Particle	Create (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Legacy function for backwards compatibility.
static Particle	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.
static Particle	Create (int particle_id, vector global_pos, vector global_ori="0 0 0")
	Legacy function for backwards compatibility with 1.01 and below.
static Particle	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.
static Particle	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.
static Particle	PlayInWorld (int particle_id, vector global_pos)
	Creates a particle emitter on the given position and activates it.
static Particle	Play (int particle_id, vector global_pos)
	Legacy function for backwards compatibility with 1.01 and below.
Закрытые данные унаследованные от Particle
int	m_ParticleID
	ID from ParticleList if assigned.
float	m_Lifetime
	Approx. remaining lifetime of particle.
bool	m_IsRepeat
	Whether this particle repeats.
Object	m_ParentObject
	Parent Object the Particle is child of.
Object	m_ParticleEffect
	The child object which contains the actual particle.
int	m_PreviousFrame
	DEPRECATED.

Подробное описание

Entity which has the particle instance as an ObjectComponent.

Заметки

Unfortunately the native methods are private and have a script wrapper This is because of backwards compatibility with the old Particle and to avoid confusion As we should continue to use Particle for consistency, as it is too deeply rooted in script Which means switching is no longer possible due to it being harmful for already existing mods Even though using the ParticleSource directly would be preferred

Some variables from Particle are invalid on this level, those marked DEPRECATED by Particle are still DEPRECATED here m_ParticleID; //!< INVALID - Use GetParticleID() instead m_Lifetime; //!< INVALID - No EOnFrame, so no use for it m_IsPlaying; //!< VALID - Set through events - IsParticlePlaying() is still better m_IsRepeat; //!< INVALID - Use IsRepeat() instead m_MarkedForDeletion; //!< INVALID - No EOnFrame, so no use for it Wiggle API variables are still used for Wiggle API m_ParentObject; //!< VALID - Set through events - Or use GetParticleParent() or GetParent() m_ParticleEffect; //!< VALID - Not in the same usage as Particle, as it will always be 'this', never null

Конструктор(ы)

ParticleSource()

void ParticleSource ( )

inlineprivate

ctor

    {
        m_ParticleEffect = this;
    }

Перекрестные ссылки Particle::m_ParticleEffect.

~ParticleSource()

void ~ParticleSource ( )

inlineprivate

dtor

    {
    }

Методы

AddAsChild()

override void AddAsChild ( Object parent, vector local_pos = "0 0 0", vector local_ori = "0 0 0", bool force_rotation_to_world = false )

inlineprotected

Attaches this particle onto some object. If null value is provided then the particle will be detached from the current parent.

Заметки

Unlike Particle, you are free to use AddChild/RemoveChild instead of this one if you know what you are doing

Аргументы

parent	Object Parent onto 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, Yawn, Roll in degrees) (Optional)
force_rotation_to_world	bool Force rotation to be in WS (Optional)

    {
        int flags = ParticlePropertiesFlags.NONE;
        
        if (force_rotation_to_world)
            flags = ParticlePropertiesFlags.FORCE_WORLD_ROT;
        
        ParticleProperties props = new ParticleProperties(local_pos, flags, parent, local_ori);
        ApplyProperties(props);
    }

Перекрестные ссылки ApplyProperties().

ApplyProperties()

bool ApplyProperties ( ParticleProperties properties )

inlineprivate

Applies the properties given to the ParticleSource

Аргументы

properties

ParticleProperties The properties to apply

Возвращает

bool Whether the properties were successfully applied

    {
        return ApplyPropertiesNative(properties);
    }

Перекрестные ссылки ApplyPropertiesNative().

Используется в AddAsChild(), RandomizeOrientation() и StopWiggle().

ApplyPropertiesNative()

proto native bool ApplyPropertiesNative ( ParticleProperties properties )

private

Applies the properties given to the ParticleSource.

Заметки

Already handles proper reparenting

Аргументы

properties

ParticleProperties The properties to apply

Возвращает

bool Whether the properties were successfully applied

Используется в ApplyProperties().

Create() [1/2]

static override Particle Create ( int particle_id, Object parent_obj, vector local_pos = "0 0 0", vector local_ori = "0 0 0" )

inlinestaticprotected

Legacy function for backwards compatibility.

    {
        return CreateOnObject( particle_id, parent_obj, local_pos, local_ori);
    }

Перекрестные ссылки CreateOnObject() и particle_id.

Create() [2/2]

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

inlinestaticprotected

Legacy function for backwards compatibility with 1.01 and below.

    {
        return CreateInWorld( particle_id, global_pos, global_ori );
    }

Перекрестные ссылки CreateInWorld() и particle_id.

CreateInWorld()

static override Particle CreateInWorld ( int particle_id, vector global_pos, vector global_ori = "0 0 0", bool force_world_rotation = false )

inlinestaticprotected

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

Возвращает

Particle Created particle instance

    {
        return CreateParticle(particle_id, global_pos, false, null, global_ori, force_world_rotation);
    }

Перекрестные ссылки CreateParticle() и particle_id.

Используется в Create().

CreateOnObject()

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

inlinestaticprotected

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)

Возвращает

Particle Created particle instance

    {
        return CreateParticle(particle_id, local_pos, false, parent_obj, local_ori, force_world_rotation);
    }

Перекрестные ссылки CreateParticle() и particle_id.

Используется в Create().

CreateParticle()

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

inlinestaticprotected

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

    {
        int flags = ParticlePropertiesFlags.NONE;
        
        if (playOnCreation)
        {
            flags = flags | ParticlePropertiesFlags.PLAY_ON_CREATION;
        }
        
        if (forceWorldRotation)
        {
            flags = flags | ParticlePropertiesFlags.FORCE_WORLD_ROT;
        }
 
        return CreateParticleEx(id, pos, flags, parent, ori, owner);
    }

Перекрестные ссылки CreateParticleEx().

Используется в PMTPlayback::TestOnePlayingStandAlone(), PMTPlayback::TestOnePlayingStandAloneAutoDestroy(), PMTPlayback::TestStopping() и PMTPlayback::TestWiggleStress().

CreateParticleEffect()

void CreateParticleEffect ( )

inlineprivate

Empty.

{ ErrorEx("Should not be in use on ParticleSource."); }

Перекрестные ссылки ErrorEx.

CreateParticleEx()

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

inlinestaticprotected

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

    {
        string particlePath = ParticleList.GetParticleFullPath(id);
        if (particlePath == "") // There is already an error inside of ParticleList signaling this
        {
            ErrorEx(string.Format("Could not create ParticleSource as particle id %1 is invalid.", id));
            return null;
        }
 
        vector localPos = pos;
        
        if (parent)
            pos = parent.GetPosition();
        
        ParticleSource p = ParticleSource.Cast( GetGame().CreateObjectEx("ParticleSource", pos, ECE_LOCAL) );
        p.SetParticle(particlePath);
        ParticleProperties props = new ParticleProperties(localPos, flags, parent, ori, owner);
        p.ApplyProperties(props);
        
        return p;
    }

Перекрестные ссылки ECE_LOCAL, ErrorEx, GetGame() и ParticleList::GetParticleFullPath().

Используется в CreateParticle().

DestroyParticleEffect()

void DestroyParticleEffect ( )

inlineprivate

Empty.

{ ErrorEx("Should not be in use on ParticleSource."); }

Перекрестные ссылки ErrorEx.

DisableAutoDestroy()

void DisableAutoDestroy ( )

inlineprotected

Disables the particle automatically cleaning up itself when ending or stopping.

    {
        SetParticleAutoDestroyFlags(ParticleAutoDestroyFlags.NONE);
    }

Перекрестные ссылки SetParticleAutoDestroyFlags().

EOnFrame()

void EOnFrame ( IEntity other, float timeSlice )

inlineprotected

Empty.

{ ErrorEx("Should not be in use on ParticleSource."); } 

Перекрестные ссылки ErrorEx.

GetCountID()

proto int GetCountID ( )

private

Gets the ID for the ParticleSource.

Заметки

Different every restart, as it is the nth instance created since the start of the program

Возвращает

int ID for the ParticleSource

GetDirectParticleEffect()

override Object GetDirectParticleEffect ( )

inlineprivate

Returns direct particle effect entity.

Заметки

Backwards compatibility with Particle, here it is the Object itself

Возвращает

Object The Object with the particle component (this)

    {
        return this;
    }

GetIndex()

proto native int GetIndex ( )

private

Get the index of this ParticleSource in the owning ParticleManager.

Возвращает

int The index in the pool in the owning ParticleManager, -1 if no owner

GetMaxLifetime()

override float GetMaxLifetime ( )

inlineprivate

Returns the approx. max lifetime.

Возвращает

float The largest lifetime sum among the emitors

    {
        return GetMaxLifetimeNative();
    }

Перекрестные ссылки GetMaxLifetimeNative().

GetMaxLifetimeNative()

proto float GetMaxLifetimeNative ( )

private

Returns the approx. max lifetime.

Возвращает

float The largest lifetime sum among the emitors

Используется в GetMaxLifetime().

GetOwner()

proto native Class GetOwner ( )

private

Get the owner of this ParticleSource.

Возвращает

Class The owner or null

Используется в RandomizeOrientation() и StopWiggle().

GetParameter()

override void GetParameter ( int emitter, int parameter, out float value )

inlineprotected

Get the value of a parameter of an emitor in the particle.

Аргументы

emitter	int The emitor to get the value from
parameter	int The parameter to get the value from (enum EmitorParam)
value	float The value

    {
        GetParticleParm(this, emitter, parameter, value);
    }

Перекрестные ссылки GetParticleParm().

GetParameterEx()

override float GetParameterEx ( int emitter, int parameter )

inlineprotected

Get the value of a parameter of an emitor in the particle.

Аргументы

emitter	int The emitor to get the value from
parameter	int The parameter to get the value from (enum EmitorParam)

Возвращает

float The value

    {
        float value;
        GetParticleParm(this, emitter, parameter, value);
        return value;
    }

Перекрестные ссылки GetParticleParm().

GetParticle()

bool GetParticle ( out string path, EGetParticleMode mode )

inlineprivate

Gets the path to the currently assigned particle.

Аргументы

path	string Path of particle effect
mode	EGetParticleMode What path to return

Возвращает

bool Whether the path is filled in or not

    {
        return GetParticleNative(path, mode);
    }

Перекрестные ссылки GetParticleNative() и path.

Используется в GetParticleID() и GetParticleIDLegacy().

GetParticleAutoDestroyFlags()

proto native int GetParticleAutoDestroyFlags ( )

protected

Gets the currently set ParticleAutoDestroyFlags flags set on this ParticleSource.

Возвращает

int Currently set ParticleAutoDestroyFlags flags set on this ParticleSource

GetParticleCount()

override int GetParticleCount ( )

inlineprivate

Returns the total count of active particles in all emitors.

Заметки

Internally does a sum, HasActiveParticle is better for a quick check

Возвращает

int Total count of active particles

    {
        return GetParticleCountNative();
    }

Перекрестные ссылки GetParticleCountNative().

GetParticleCountNative()

proto int GetParticleCountNative ( )

private

Returns the total count of active particles in all emitors.

Заметки

Internally does a sum, HasActiveParticle is better for a quick check

Возвращает

int Total count of active particles

Используется в GetParticleCount().

GetParticleID()

override int GetParticleID ( )

inlineprivate

Gets the ParticleList ID of the currently assigned particle.

Возвращает

int ID of particle registered in ParticleList

    {
        string path;
        if (GetParticle(path, EGetParticleMode.FILE))
            return ParticleList.GetParticleIDByName(path);
        else
            return -1;          
    }

Перекрестные ссылки GetParticle(), ParticleList::GetParticleIDByName() и path.

GetParticleIDLegacy()

int GetParticleIDLegacy ( )

inlineprivate

Gets the ParticleList ID of the currently assigned particle.

Заметки

This is because the new GetParticleID will only work when every particle file name has a unique name In case this is not the case, then this method is what one will want to use

Возвращает

int ID of particle registered in ParticleList

    {
        string path;
        if (GetParticle(path, EGetParticleMode.NO_EXT))
            return ParticleList.GetParticleID(path);
        else
            return -1;
    }

Перекрестные ссылки GetParticle(), ParticleList::GetParticleID() и path.

GetParticleManager()

proto native ParticleManager GetParticleManager ( )

private

Get the ParticleManager the ParticleSource belongs to if any.

Возвращает

ParticleManager The ParticleManager which created the ParticleSource or null

GetParticleNative()

proto bool GetParticleNative ( out string path, EGetParticleMode mode )

private

Gets the path to the currently assigned particle.

Аргументы

path	string Path of particle effect
mode	EGetParticleMode What path to return

Возвращает

bool Whether the path is filled in or not

Используется в GetParticle().

GetParticleParent()

override Object GetParticleParent ( )

inlineprivate

Returns the parent of this Particle if there is one.

Возвращает

Object The parent or null if there is none

    {
        return Object.Cast(GetParent());
    }

Перекрестные ссылки GetParent().

Используется в RandomizeOrientation() и StopWiggle().

GetStaticActiveCount()

proto static native int GetStaticActiveCount ( )

staticprivate

Gets the amount of ParticleSource that are currently existing.

Возвращает

int Amount of ParticleSource that are currently existing

Используется в PMTF::PrintActiveStats() и TestCleanup().

GetStaticCount()

proto static native int GetStaticCount ( )

staticprivate

Gets the amount of ParticleSource that have been created since the start of the program.

Возвращает

int Amount of ParticleSource that have been created since the start of the program

HasActiveParticle()

override bool HasActiveParticle ( )

inlineprivate

Returns if there is any particle active.

Возвращает

bool Whether there is any particle active

    {
        return HasActiveParticleNative();
    }

Перекрестные ссылки HasActiveParticleNative().

HasActiveParticleNative()

proto bool HasActiveParticleNative ( )

private

Returns if there is any particle active.

Возвращает

bool Whether there is any particle active

Используется в HasActiveParticle().

IncrementParticleParam()

override void IncrementParticleParam ( int parameter_id, float value )

inlineprotected

Increments the value of the given parameter relatively from the CURRENT value.

Заметки

It's a simple sum, so negative value decrements

Аргументы

parameter_id	int The parameter to adjust (enum EmitorParam)
value	float The value to sum

    {
        int emitors = GetParticleEmitorCount(this); 
        for (int i = 0; i < emitors; ++i)
        {
            float param;
            GetParticleParm(this, i, parameter_id, param);
            SetParticleParm(this, i, parameter_id, param + value);
        }
    }

Перекрестные ссылки GetParticleEmitorCount(), GetParticleParm() и SetParticleParm().

Используется в HotSpringTrigger::SpawnVaporEffect() и VolcanicTrigger::SpawnVaporEffect().

IncrementParticleParamFromOriginal()

override void IncrementParticleParamFromOriginal ( int parameter_id, float value )

inlineprotected

Increments the value of the given parameter relatively from the ORIGINAL value.

Заметки

It's a simple sum, so negative value decrements

Аргументы

parameter_id	int The parameter to adjust (enum EmitorParam)
value	float The value to sum

    {
        int emitors = GetParticleEmitorCount(this); 
        for (int i = 0; i < emitors; ++i)
        {
            float param;
            GetParticleParmOriginal(this, i, parameter_id, param);
            SetParticleParm(this, i, parameter_id, param + value);
        }
    }

Перекрестные ссылки GetParticleEmitorCount(), GetParticleParmOriginal() и SetParticleParm().

IsParticlePlaying()

override bool IsParticlePlaying ( )

inlineprivate

Ask if the particle is still playing.

Возвращает

bool Whether the particle is playing

    {
        return IsParticlePlayingNative();
    }

Перекрестные ссылки IsParticlePlayingNative().

IsParticlePlayingNative()

proto bool IsParticlePlayingNative ( )

private

Ask if the particle is still playing.

Возвращает

bool Whether the particle is playing

Используется в IsParticlePlaying().

IsRepeat()

override bool IsRepeat ( )

inlineprivate

Returns whether there is a repeating particle.

Возвращает

bool whether there is a repeating particle

    {
        return IsRepeatNative();
    }

Перекрестные ссылки IsRepeatNative().

IsRepeatNative()

proto bool IsRepeatNative ( )

private

Returns whether there is a repeating particle.

Возвращает

bool whether there is a repeating particle

Используется в IsRepeat().

OnCheckAutoDelete()

void OnCheckAutoDelete ( )

inlineprivate

Empty.

{ ErrorEx("Should not be in use on ParticleSource."); } 

Перекрестные ссылки ErrorEx.

OnParticleParented()

void OnParticleParented ( IEntity parent )

inlineprotected

Event when the particle receives a parent.

    {
        m_ParentObject = Object.Cast(parent);
        
        super.OnParticleParented(parent);
    }

Перекрестные ссылки Particle::m_ParentObject.

OnParticleStop()

void OnParticleStop ( )

inlineprotected

Event when the particle stops.

    {
        if (IsWiggling())
        {
            StopWiggle();
            delete m_RandomizeOri;
        }
        
        super.OnParticleStop();
    }

Перекрестные ссылки Particle::IsWiggling(), Particle::m_RandomizeOri и StopWiggle().

OnParticleUnParented()

void OnParticleUnParented ( IEntity parent )

inlineprotected

Event when the particle is orphaned.

    {
        m_ParentObject = null;
        
        // Since we have lost the parent, we will need to refresh the wiggle
        // As it uses a cached local position, which is now no longer correct
        if (!m_WiggleProcessing && IsWiggling())
        {
            float randomAngle = m_MaxOriWiggle;
            float randomInterval = m_MaxOriInterval;
            m_DefaultPos = m_DefaultWorldPos;
            m_DefaultOri = m_DefaultWorldOri;
            
            StopWiggle();
            SetWiggle(randomAngle, randomInterval);
        }
        
        super.OnParticleUnParented(parent);
    }

Перекрестные ссылки Particle::IsWiggling(), Particle::m_DefaultOri, Particle::m_DefaultPos, Particle::m_DefaultWorldOri, Particle::m_DefaultWorldPos, Particle::m_MaxOriInterval, Particle::m_MaxOriWiggle, Particle::m_ParentObject, Particle::m_WiggleProcessing, SetWiggle() и StopWiggle().

OnToDelete()

void OnToDelete ( )

inlineprivate

Empty.

{ ErrorEx("Should not be in use on ParticleSource."); }

Перекрестные ссылки ErrorEx.

Orphan()

proto native void Orphan ( )

private

null the owner of this ParticleSource

ParticleInit()

void ParticleInit ( )

inlineprotected

Empty - Only needed for Particle.

{}

Play() [1/2]

static override Particle Play ( int particle_id, Object parent_obj, vector local_pos = "0 0 0", vector local_ori = "0 0 0" )

inlinestaticprotected

Legacy function for backwards compatibility with 1.01 and below.

    {
        return PlayOnObject( particle_id, parent_obj, local_pos, local_ori);
    }

Перекрестные ссылки particle_id и PlayOnObject().

Play() [2/2]

static override Particle Play ( int particle_id, vector global_pos )

inlinestaticprotected

Legacy function for backwards compatibility with 1.01 and below.

    {
        return PlayInWorld( particle_id, global_pos);
    }

Перекрестные ссылки particle_id и PlayInWorld().

PlayInWorld()

static override Particle PlayInWorld ( int particle_id, vector global_pos )

inlinestaticprotected

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

Возвращает

Particle Created particle instance

    {
        return CreateParticle(particle_id, global_pos, true);
    }

Перекрестные ссылки CreateParticle() и particle_id.

Используется в Play().

PlayOnObject()

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

inlinestaticprotected

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)

Возвращает

Particle Created particle instance

    {
        return CreateParticle(particle_id, local_pos, true, parent_obj, local_ori, force_world_rotation);
    }

Перекрестные ссылки CreateParticle() и particle_id.

Используется в Play().

PlayParticleEx()

override bool PlayParticleEx ( int particle_id = -1, int flags = 0 )

inlineprivate

Method to tell the particle to start playing.

Аргументы

particle_id

int Particle ID registered in ParticleList to start playing

Возвращает

bool Whether the particle successfully started

    {
        if ( particle_id > -1 )
        {
            // Here we can just do it directly
            // While with the old system it will not work when the particle is already created
            SetParticleByID(particle_id);
        }
        
        return PlayParticleNative(flags);
    }

Перекрестные ссылки particle_id, PlayParticleNative() и SetParticleByID().

PlayParticleNative()

proto bool PlayParticleNative ( int flags )

private

Method to tell the particle to start playing.

Заметки

Will call OnParticleStart when successful

Возвращает

bool Whether the particle successfully started

Используется в PlayParticleEx().

RandomizeOrientation()

void RandomizeOrientation ( )

inlineprivate

Randomizes a new orientation and applies it.

    {
        if (ToDelete())
            return;
        
        m_WiggleProcessing = true;
        
        if ( !m_RandomizeOri.IsRunning() )
            m_RandomizeOri.Run( Math.RandomFloat(0, m_MaxOriInterval) , this, "RandomizeOrientation", null, false);
        
        int flags = ParticlePropertiesFlags.NONE;
        
        if (m_ForceOrientationRelativeToWorld)
            flags = ParticlePropertiesFlags.FORCE_WORLD_ROT;
 
        ParticleProperties prop = new ParticleProperties(m_DefaultPos, flags, GetParticleParent(), m_DefaultOri + RandWiggleVector(), GetOwner());
        ApplyProperties(prop);
        
        m_WiggleProcessing = false;
    }

Перекрестные ссылки ApplyProperties(), GetOwner(), GetParticleParent(), Particle::m_DefaultOri, Particle::m_DefaultPos, Particle::m_ForceOrientationRelativeToWorld, Particle::m_MaxOriInterval, Particle::m_RandomizeOri, Particle::m_WiggleProcessing, Math::RandomFloat() и Particle::RandWiggleVector().

ResetParticle()

override bool ResetParticle ( )

inlineprivate

Method to tell the particle to reset.

Возвращает

bool Whether the particle successfully reset

    {
        return ResetParticleNative();
    }

Перекрестные ссылки ResetParticleNative().

ResetParticleNative()

proto native bool ResetParticleNative ( )

private

Method to tell the particle to reset.

Возвращает

bool Whether the particle successfully reset

Используется в ResetParticle().

RestartParticle()

override bool RestartParticle ( )

inlineprivate

Method to tell the particle to restart (reset + play)

Возвращает

bool Whether the particle successfully restarted

    {
        return RestartParticleNative();
    }

Перекрестные ссылки RestartParticleNative().

RestartParticleNative()

proto native bool RestartParticleNative ( )

private

Method to tell the particle to restart (reset + play)

Возвращает

bool Whether the particle successfully restarted

Используется в RestartParticle().

ScaleParticleParam()

override void ScaleParticleParam ( int parameter_id, float coef )

inlineprotected

Scales the given parameter on all emitors relatively to their CURRENT value.

Аргументы

parameter_id	int The parameter to adjust (enum EmitorParam)
coef	float The multiplier to apply

    {
        int emitors = GetParticleEmitorCount(this); 
        for (int i = 0; i < emitors; ++i)
        {
            float value;
            GetParticleParm(this, i, parameter_id, value);
            SetParticleParm(this, i, parameter_id, value * coef);
        }
    }

Перекрестные ссылки GetParticleEmitorCount(), GetParticleParm() и SetParticleParm().

ScaleParticleParamFromOriginal()

override void ScaleParticleParamFromOriginal ( int parameter_id, float coef )

inlineprotected

Scales the given parameter on all emitors relatively to their ORIGINAL value.

Аргументы

parameter_id	int The parameter to adjust (enum EmitorParam)
coef	float The multiplier to apply

    {   
        int emitors = GetParticleEmitorCount(this);         
        for (int i = 0; i < emitors; ++i)
        {
            float value;
            GetParticleParmOriginal(this, i, parameter_id, value);
            SetParticleParm(this, i, parameter_id, value * coef);
        }
    }

Перекрестные ссылки GetParticleEmitorCount(), GetParticleParmOriginal() и SetParticleParm().

SetOwner()

proto native void SetOwner ( Class owner )

private

Set the owner of this ParticleSource.

Аргументы

p Class The owner or null

Используется в FireworksLauncherClientEvent::OnFired(), FireworksLauncher::OnFuseIgnitedClient() и DestructionEffectBase::OnHealthLevelChanged().

SetParameter()

override void SetParameter ( int emitter, int parameter, float value )

inlineprotected

Set the value of a parameter of an emitor in the particle.

Аргументы

emitter	int The emitter to apply the new value to, -1 for all emitter
parameter	int The parameter to apply the new value to (enum EmitorParam)
value	float The value to apply

    {
        SetParticleParm(this, emitter, parameter, value);
    }

Перекрестные ссылки SetParticleParm().

SetParticle()

bool SetParticle ( string path )

inlineprivate

Assigns a particle to the ParticleSource.

Заметки

Intentionally private, as it is best to use 'SetParticleByID' instead from script, because ParticleList

Аргументы

path	string Path of particle effect

Возвращает

bool Whether the creating and assigning of particle was successful

    {
        return SetParticleNative(path);
    }

Перекрестные ссылки path и SetParticleNative().

Используется в SetParticleByID().

SetParticleAutoDestroyFlags()

proto native void SetParticleAutoDestroyFlags ( ParticleAutoDestroyFlags flags )

protected

Enables the particle to automatically clean up itself when ending or stopping.

Заметки

Is enabled by default (ALL)

Looping particles never end

ParticleSource belonging to a ParticleManager will ignore these

Аргументы

flags

ParticleAutoDestroyFlags Flags enabling when the particle should be auto destroyed

Используется в DisableAutoDestroy() и Edible_Base::UpdateVaporParticle().

SetParticleByID()

bool SetParticleByID ( int id )

inlineprivate

Assigns a particle to the ParticleSource.

Аргументы

id	int ID of particle registered in ParticleList

Возвращает

bool Whether the creating and assigning of particle was successful

    {
        return SetParticle(ParticleList.GetParticleFullPath(id));
    }

Перекрестные ссылки ParticleList::GetParticleFullPath() и SetParticle().

Используется в PlayParticleEx() и SetSource().

SetParticleNative()

proto native bool SetParticleNative ( string path )

private

Assigns a particle to the ParticleSource.

Аргументы

path	string Path of particle effect

Возвращает

bool Whether the creating and assigning of particle was successful

Используется в SetParticle().

SetParticleParam()

override void SetParticleParam ( int parameter_id, float value )

inlineprotected

Set the value of a parameter of all emitors in the particle.

Аргументы

parameter	int The parameter to apply the new value to (enum EmitorParam)
value	float The value to apply

    {
        SetParticleParm(this, -1, parameter_id, value);
    }

Перекрестные ссылки SetParticleParm().

Используется в Edible_Base::UpdateVaporParticle().

SetSource()

override void SetSource ( int particle_id )

inlineprivate

Sets particle id.

Заметки

Purely here for backwards compatibility with Particle

Аргументы

particle_id

int Particle ID registered in ParticleList to start playing

    {
        SetParticleByID(particle_id);
    }

Перекрестные ссылки particle_id и SetParticleByID().

SetWiggle()

override void SetWiggle ( float random_angle, float random_interval )

inlineprotected

Makes the particle change direction by random_angle every random_interval seconds.

Заметки

This does not actually work on Particle with no parent, it should on ParticleSource

Аргументы

random_angle	float Will be the range [-random_angle, random_angle[ to wiggle between
random_interval	float Will be the time range [0, random_interval] to wiggle next time

    {
        if (random_angle != 0 || random_interval != 0)
        {
            if (IsWiggling())
            {
                m_MaxOriWiggle = random_angle;
                m_MaxOriInterval = random_interval;
                return;
            }
            
            // We need the position to be accurate before storing it
            Update();
 
            // These are only ever used within the Wiggle API
            // To restore the properties after wiggling
            // So let's only set them within the Wiggle API c:
            
            m_DefaultPos = GetLocalPosition();
            m_DefaultOri = GetLocalYawPitchRoll();
            m_DefaultWorldPos = GetWorldPosition();
            m_DefaultWorldOri = GetYawPitchRoll();  
            m_ForceOrientationRelativeToWorld = IsHierarchyPositionOnly();
        }
        
        super.SetWiggle(random_angle, random_interval);
    }

Перекрестные ссылки GetLocalPosition(), Particle::IsWiggling(), Particle::m_DefaultOri, Particle::m_DefaultPos, Particle::m_DefaultWorldOri, Particle::m_DefaultWorldPos, Particle::m_ForceOrientationRelativeToWorld, Particle::m_MaxOriInterval, Particle::m_MaxOriWiggle и Update().

Используется в OnParticleUnParented().

StopParticle()

override bool StopParticle ( int flags = 0 )

inlineprivate

Method to tell the particle to stop playing.

Аргументы

flags

int Flags to pass to the stopping (StopParticleFlags)

Возвращает

bool Whether the particle successfully stopped

    {
        return StopParticleNative(flags);
    }

Перекрестные ссылки StopParticleNative().

Используется в FireworksLauncher::OnFiringStartClient(), GeyserTrigger::StopEffects(), GeyserTrigger::UpdateGeyserState() и FireworksLauncherClientEvent::~FireworksLauncherClientEvent().

StopParticleNative()

proto bool StopParticleNative ( int flags )

private

Method to tell the particle to stop playing.

Заметки

The particle is not immediately stopped by default, instead it will gradually fade If this is however desired, then pass in StopParticleFlags.IMMEDIATE

Аргументы

flags

int Flags to pass to the stopping (StopParticleFlags)

Возвращает

bool Whether the particle successfully stopped

Используется в StopParticle().

StopWiggle()

override void StopWiggle ( )

inlineprotected

Stops randomized wiggle.

    {
        bool wiggling = IsWiggling();
        
        super.StopWiggle();
        
        if (wiggling)
        {
            // Restore pre-wiggle orientation
            int flags = ParticlePropertiesFlags.NONE;
            
            if (m_ForceOrientationRelativeToWorld)
                flags = ParticlePropertiesFlags.FORCE_WORLD_ROT;
            
            ParticleProperties prop = new ParticleProperties(m_DefaultPos, flags, GetParticleParent(), m_DefaultOri, GetOwner());
            ApplyProperties(prop);
        }
    }

Перекрестные ссылки ApplyProperties(), GetOwner(), GetParticleParent(), Particle::IsWiggling(), Particle::m_DefaultOri, Particle::m_DefaultPos и Particle::m_ForceOrientationRelativeToWorld.

Используется в OnParticleStop() и OnParticleUnParented().

UpdateState()

void UpdateState ( )

inlineprivate

Empty.

{ ErrorEx("Should not be in use on ParticleSource."); }

Перекрестные ссылки ErrorEx.

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/Particles/ParticleManager/ParticleSource.c