Класс Particle

Legacy way of using particles in the game. Подробнее...

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

Защищенные члены
Playback
Methods regarding playing/stopping of 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.
Properties and state
Obtain information or set properties regarding the state of the Particle
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.

Защищенные статические члены
Create a particle (static)
You can create a particle either at some position, or create it as a child on some object.
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 play on creation
You can use the following Play(...) functions to create and activate a particle in 1 line of your script.
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.

Закрытые члены
Misc
Various helpers
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
void	SetParticleParam (int parameter_id, float value)
	Set the value of a parameter of all emitors in the particle.
void	SetParameter (int emitter, int parameter, float value)
	Set the value of a parameter of an emitor in the particle.
void	GetParameter (int emitter, int parameter, out float value)
	Get the value of a parameter of an emitor in the particle.
float	GetParameterEx (int emitter, int parameter)
	Get the value of a parameter of an emitor in the particle.
void	ScaleParticleParamFromOriginal (int parameter_id, float coef)
	Scales the given parameter on all emitors relatively to their ORIGINAL value.
void	ScaleParticleParam (int parameter_id, float coef)
	Scales the given parameter on all emitors relatively to their CURRENT value.
void	IncrementParticleParamFromOriginal (int parameter_id, float value)
	Increments the value of the given parameter relatively from the ORIGINAL value.
void	IncrementParticleParam (int parameter_id, float value)
	Increments the value of the given parameter relatively from the CURRENT value.

Generic data
Generic data for the Particle
int	m_ParticleID
	ID from ParticleList if assigned.
float	m_Lifetime
	Approx. remaining lifetime of particle.
bool	m_IsRepeat
	Whether this particle repeats.
bool	m_MarkedForDeletion
	Whether this particle is queued for deletion.

Wiggle API
Settings to make the Particle wiggle
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.
bool	m_WiggleProcessing
	Used for Wiggle API, to signal that wiggle API is currently doing work.
bool	m_ForceOrientationRelativeToWorld
	Used for Wiggle API, to restore after unparenting.
vector	m_DefaultOri
	Used for Wiggle API, to restore after unparenting.
vector	m_DefaultPos
	Used for Wiggle API, to restore after unparenting.
vector	m_DefaultWorldOri
	Used for Wiggle API, to restore after unparenting.
vector	m_DefaultWorldPos
	Used for Wiggle API, to restore after unparenting.
float	m_MaxOriWiggle
	Used for Wiggle API, Wiggle room [-m_MaxOriWiggle, m_MaxOriWiggle].
float	m_MaxOriInterval
	Used for Wiggle API, Interval for wiggling [0, m_MaxOriInterval[.
ref Timer	m_RandomizeOri
	Used for Wiggle API, calls the Wiggle functionality.
vector	m_GlobalPosPreviousFrame
	DEPRECATED.
const int	MAX_EMITORS = 30
	DEPRECATED
void	Particle ()
	ctor
bool	IsWiggling ()
	Checks if particle is currently wiggling.
void	SetWiggle (float random_angle, float random_interval)
	Makes the particle change direction by random_angle every random_interval seconds.
void	StopWiggle ()
	Stops randomized wiggle.
void	RandomizeOrientation ()
	Randomizes a new orientation and applies it.
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.

Misc Particle specific helpers
Functionality specific for Particle
void	CreateParticleEffect ()
	Creates ParticleEffect child, called from UpdateState.
void	DestroyParticleEffect ()
	Destroys ParticleEffect child, called from UpdateState.
override void	EOnFrame (IEntity other, float timeSlice)
	OnFrame update event decrementing the stored approx. lifetime and checking for deletion.
void	OnCheckAutoDelete ()
	Creates ParticleEffect child, called from UpdateState.
void	OnToDelete ()
	Called before deletion from OnCheckAutoDelete.
void	UpdateState ()
	Creates/Destroys ParticleEffect child according to current state.

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

Legacy way of using particles in the game.

Заметки

They work okay when just needing to play a particle once every once in a while But are extremely wasteful when it comes to playing multiple Particles at the same time

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

Particle()

void Particle ( )

inlineprivate

ctor

    {
        ParticleInit();
    }

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

Методы

AddAsChild()

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

inlineprivate

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

Заметки

Due to the members being filled in, AddChild/RemoveChild cannot be used with Particle when using Wiggle

Аргументы

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)

    {
        if (ToDelete())
            return;
        
        if (parent)
        {
            // AddAsChild method is sometimes called from a timer.
            // Due to that it is necesarry to use ToDelete() here to check if the parent object is flagged for deletion or not on client,
            // because sometimes this code is executed before the parent's destructor from where this would normally be handled.
            if (!parent.ToDelete())
            {
                SetPosition(local_pos);
                SetOrientation(local_ori);
                m_ParentObject = parent;
                m_DefaultPos = local_pos;
                m_ForceOrientationRelativeToWorld = force_rotation_to_world;
                
                if (m_ParticleEffect)
                    AddChild(m_ParticleEffect, -1, m_ForceOrientationRelativeToWorld);
                
                parent.AddChild(this, -1, false);
            }
        }
        else
        {
            if (m_ParentObject && !m_ParentObject.ToDelete())
            {
                m_ParentObject.RemoveChild(this, true);
                m_ParentObject = null;
            }
        }
    }

Перекрестные ссылки AddChild(), m_DefaultPos, m_ForceOrientationRelativeToWorld, m_ParentObject, m_ParticleEffect и SetPosition().

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

Create() [1/2]

static 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 Particle 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 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 Forces particle's orientation to rotate relative to the world and not with the object (Optional)

Возвращает

Particle Created particle instance

    {
        Particle p = Particle.Cast( GetGame().CreateObjectEx("Particle", global_pos, ECE_LOCAL) );
        p.SetSource(particle_id);
        p.SetOrientation(global_ori);
        p.m_ForceOrientationRelativeToWorld = force_world_rotation;
        return p;
    }

Перекрестные ссылки ECE_LOCAL, GetGame() и particle_id.

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

CreateOnObject()

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 )

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, Yawn, 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

    {
        if (!parent_obj)
            Error("ERROR when creating a particle! Parameter parent_obj is NULL!");
        
        vector global_pos = parent_obj.GetPosition();
        Particle p = CreateInWorld(particle_id, global_pos, Vector(0,0,0), force_world_rotation);
        p.AddAsChild(parent_obj, local_pos, local_ori, force_world_rotation);
        p.m_DefaultOri = local_ori;
        
        return p;
    }

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

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

CreateParticleEffect()

void CreateParticleEffect ( )

inlineprivate

Creates ParticleEffect child, called from UpdateState.

    {
        if ( !GetGame().IsServer() || !GetGame().IsMultiplayer() )
        {
            string fullPath = ParticleList.GetParticleFullPath(m_ParticleID);
            if (fullPath == "")
            {
                ErrorEx("Could not play Particle as there is no valid particle id assigned.");
                m_IsPlaying = false;
                return;
            }
            
            if ( m_ParticleEffect == null )
            {
                m_ParticleEffect = GetGame().CreateObjectEx("#particlesourceenf", vector.Zero, ECE_LOCAL); // particle source must be lowercase!
            }
            
            AddChild(m_ParticleEffect, -1, m_ForceOrientationRelativeToWorld);
            
            vobject vobj = GetObject( fullPath );           
            m_ParticleEffect.SetObject(vobj, "");
            ReleaseObject(vobj);
            
            m_IsRepeat = IsRepeat();
            m_Lifetime = GetMaxLifetime();
        }
    }

Перекрестные ссылки AddChild(), ECE_LOCAL, ErrorEx, GetGame(), GetMaxLifetime(), GetObject(), ParticleList::GetParticleFullPath(), IsRepeat(), m_ForceOrientationRelativeToWorld, m_IsPlaying, m_IsRepeat, m_Lifetime, m_ParticleEffect, m_ParticleID, ReleaseObject() и vector::Zero.

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

DestroyParticleEffect()

void DestroyParticleEffect ( )

inlineprivate

Destroys ParticleEffect child, called from UpdateState.

Заметки

Does not destroy it immediately As it simply nulls the lifetime Then it will be cleaned up by EOnFrame eventually

    {
        if ( m_ParticleEffect && GetGame() )
        {
            SetParameter(-1, EmitorParam.LIFETIME, 0);
            SetParameter(-1, EmitorParam.LIFETIME_RND, 0);
            SetParameter(-1, EmitorParam.REPEAT, 0);
            
            m_IsRepeat = false;
        }
    }

Перекрестные ссылки GetGame(), m_IsRepeat, m_ParticleEffect и SetParameter().

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

EOnFrame()

override void EOnFrame ( IEntity other, float timeSlice )

inlineprivate

OnFrame update event decrementing the stored approx. lifetime and checking for deletion.

    {       
        m_Lifetime -= timeSlice;
        OnCheckAutoDelete();
    }

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

GetDirectParticleEffect()

Object GetDirectParticleEffect ( )

inlineprotected

Returns direct particle effect entity which is usually handled by this class 'Particle' if there is one.

Заметки

Is a child of this Particle

Возвращает

Object The Object with the particle component or null

    {
        return m_ParticleEffect;
    }

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

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

GetMaxLifetime()

float GetMaxLifetime ( )

inlineprotected

Returns the approx. max lifetime.

Возвращает

float The largest lifetime sum among the emitors

    {
        float lifetime_return = 0;
        
        if (m_ParticleEffect)
        {
            float lifetime_min = 0;
            float lifetime_random = 0;          
            float effect_time = 0;
            
            float lifetime_sum = 0;
            
            int emitors = GetParticleEmitorCount(m_ParticleEffect);
            
            for (int i = 0; i < emitors; ++i)
            {
                GetParticleParm(m_ParticleEffect, i, EmitorParam.LIFETIME, lifetime_min);
                GetParticleParm(m_ParticleEffect, i, EmitorParam.LIFETIME_RND, lifetime_random);
                GetParticleParm(m_ParticleEffect, i, EmitorParam.EFFECT_TIME, effect_time);
                
                lifetime_sum = lifetime_min + lifetime_random + effect_time;
                
                if ( lifetime_sum > lifetime_return )
                {
                    lifetime_return = lifetime_sum;
                }
            }
        }
        
        return lifetime_return;
    }

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

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

GetParameter()

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

inlineprivate

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

    {
        if (!m_ParticleEffect)
            return;
        
        GetParticleParm(m_ParticleEffect, emitter, parameter, value);
    }

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

GetParameterEx()

float GetParameterEx ( int emitter, int parameter )

inlineprivate

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

    {
        if (!m_ParticleEffect)
            return 0;
        
        float value;
        GetParticleParm(m_ParticleEffect, emitter, parameter, value);
        return value;
    }

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

GetParticleCount()

int GetParticleCount ( )

inlineprotected

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

    {
        if (m_ParticleEffect)
        {
            return ParticleGetCount(m_ParticleEffect);
        }
        
        return 0;
    }

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

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

GetParticleID()

int GetParticleID ( )

inlineprotected

Gets particle id.

Заметки

This is not necessarily the CURRENT particle As one can use SetSource while the Particle is still playing But that will not change the particle before Particle is played again

Возвращает

int The last set Particle ID registered in ParticleList

    {
        return m_ParticleID;
    }

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

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

GetParticleParent()

Object GetParticleParent ( )

inlineprotected

Returns the parent of this Particle if there is one.

Возвращает

Object The registered parent or null

    {
        return m_ParentObject;
    }

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

HasActiveParticle()

bool HasActiveParticle ( )

inlineprotected

Returns if there is any particle active.

Возвращает

bool Whether there is any particle active

    {
        if (m_ParticleEffect)
        {
            return ParticleHasActive(m_ParticleEffect);
        }
        
        return false;
    }

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

IncrementParticleParam()

void IncrementParticleParam ( int parameter_id, float value )

inlineprivate

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

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

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

IncrementParticleParamFromOriginal()

void IncrementParticleParamFromOriginal ( int parameter_id, float value )

inlineprivate

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

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

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

IsRepeat()

bool IsRepeat ( )

inlineprotected

Returns whether there is a repeating particle.

Возвращает

bool whether there is a repeating particle

    {
        if (m_ParticleEffect)
        {
            bool repeat = false;
            
            int emitors = GetParticleEmitorCount(m_ParticleEffect);
            
            for (int i = 0; i < emitors; ++i)
            {
                GetParticleParm(m_ParticleEffect, i, EmitorParam.REPEAT, repeat);
                
                if (repeat)
                {
                    return true;
                }
            }
        }
        
        return false;
    }

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

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

IsWiggling()

bool IsWiggling ( )

inlineprivate

Checks if particle is currently wiggling.

    {
        return m_RandomizeOri && m_RandomizeOri.IsRunning();
    }

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

Используется в ParticleSource::OnParticleStop(), ParticleSource::OnParticleUnParented(), ParticleSource::SetWiggle() и ParticleSource::StopWiggle().

OnCheckAutoDelete()

void OnCheckAutoDelete ( )

inlineprivate

Creates ParticleEffect child, called from UpdateState.

    {
        if (m_Lifetime <= 0)
        {
            if (!m_MarkedForDeletion)
            {
                m_IsRepeat = IsRepeat(); // It is possible that the REPEAT flag was changed during lifetime, so it needs to be checked again.
                
                if ( m_IsRepeat )
                {
                    m_Lifetime = GetMaxLifetime();
                }
                else
                {
                    OnParticleStop();
                    
                    if ( GetParticleCount() == 0 )
                    {
                        m_MarkedForDeletion = true;
                        OnToDelete();
                        OnParticleEnd();
                    }
                }
            }
            else
            {
                if ( m_MarkedForDeletion )
                {
                    if (m_ParticleEffect)
                    {
                        m_ParticleEffect.Delete();
                        m_ParticleEffect = null;
                    }
                    
                    Delete();
                }
            }
        }
    }

Перекрестные ссылки GetMaxLifetime(), GetParticleCount(), IsRepeat(), m_IsRepeat, m_Lifetime, m_MarkedForDeletion, m_ParticleEffect, OnParticleEnd(), OnParticleStop() и OnToDelete().

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

OnToDelete()

void OnToDelete ( )

inlineprivate

Called before deletion from OnCheckAutoDelete.

    {
 
    }

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

ParticleInit()

void ParticleInit ( )

inlineprotected

Purely here so that it can be emptied in ParticleSource.

    {
        SetFlags(EntityFlags.VISIBLE, true);
        SetEventMask(EntityEvent.INIT);
        SetEventMask(EntityEvent.FRAME);
    }   

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

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

Play() [1/3]

static 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/3]

static 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().

Play() [3/3]

void Play ( int particle_id = -1 )

inlineprotected

Legacy function for backwards compatibility with 1.01 and below.

Аргументы

particle_id

int Particle ID registered in ParticleList to start playing

    {
        PlayParticle(particle_id);
    }

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

PlayInWorld()

static 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

    {
        Particle p = CreateInWorld(particle_id, global_pos);
        p.PlayParticle();
        
        return p;
    }

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

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

PlayOnObject()

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 )

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

    {
        Particle p = CreateOnObject(particle_id, parent_obj, local_pos, local_ori, force_world_rotation);
        p.PlayParticle();
        
        return p;
    }

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

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

PlayParticle()

override void PlayParticle ( int particle_id = -1 )

inlineprotected

Method to tell the particle to start playing.

Аргументы

particle_id

int Particle ID registered in ParticleList to start playing

    {
        PlayParticleEx(particle_id, 0);
    }

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

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

PlayParticleEx()

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

inlineprotected

Method to tell the particle to start playing.

Заметки

The parameter to set the ID will only work when the particle is not already playing

Аргументы

particle_id	int Particle ID registered in ParticleList to start playing
flags	int Flags to pass to the playing (None on this level)

Возвращает

bool Whether the particle successfully started

    {
        if ( particle_id > -1 )
        {
            SetSource(particle_id);
        }
        
        OnParticleStart();
 
        UpdateState();
        
        return true;
    }

Перекрестные ссылки OnParticleStart(), particle_id, SetSource() и UpdateState().

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

RandomizeOrientation()

void RandomizeOrientation ( )

inlineprivate

Randomizes a new orientation and applies it.

    {
        m_WiggleProcessing = true;
        
        if (m_ParentObject)
        {
            if ( !m_RandomizeOri.IsRunning() )
            {
                m_RandomizeOri.Run( Math.RandomFloat(0, m_MaxOriInterval) , this, "RandomizeOrientation", NULL, false);
            }
            
            Object old_parent = m_ParentObject;
            AddAsChild( null );
            AddAsChild( old_parent, m_DefaultPos, m_DefaultOri + RandWiggleVector() );
        }
        
        m_WiggleProcessing = false;
    }

Перекрестные ссылки AddAsChild(), m_DefaultOri, m_DefaultPos, m_MaxOriInterval, m_ParentObject, m_RandomizeOri, m_WiggleProcessing, Math::RandomFloat() и RandWiggleVector().

RandWiggleFloat()

float RandWiggleFloat ( )

inlineprotected

Helper to get a randomized wiggle float value.

    {
        return Math.RandomFloatInclusive(-m_MaxOriWiggle, m_MaxOriWiggle);
    }

Перекрестные ссылки m_MaxOriWiggle и Math::RandomFloatInclusive().

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

RandWiggleVector()

vector RandWiggleVector ( )

inlineprotected

Helper to get a randomized wiggle vector.

    {
        return Vector( RandWiggleFloat(), RandWiggleFloat(), RandWiggleFloat() );
    }

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

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

ScaleParticleParam()

void ScaleParticleParam ( int parameter_id, float coef )

inlineprivate

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

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

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

ScaleParticleParamFromOriginal()

void ScaleParticleParamFromOriginal ( int parameter_id, float coef )

inlineprivate

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

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

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

Используется в BroomBase::UpdateParticle() и FlammableBase::UpdateParticle().

SetParameter()

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

inlineprivate

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

    {
        if (!m_ParticleEffect)
            return;
        
        SetParticleParm(m_ParticleEffect, emitter, parameter, value);
    }

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

Используется в ManBase::ContaminatedParticleAdjustment(), CreateParticle(), DestroyParticleEffect(), ParticleNormalSmokeStart(), ParticleSmallSmokeStart(), PlayVFX(), ManBase::SetContaminatedEffectEx(), FlareSimulation::Simulate() и FlareSimulation::TurnOffDistantLight().

SetParticleParam()

void SetParticleParam ( int parameter_id, float value )

inlineprivate

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

    {
        if (!m_ParticleEffect)
            return;
        
        SetParticleParm(m_ParticleEffect, -1, parameter_id, value);
    }

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

SetSource()

void SetSource ( int particle_id )

inlineprotected

Sets particle id.

Заметки

Does not work at runtime, particle object needs to be destroyed and then Particle needs to play again

Аргументы

particle_id

int Particle ID registered in ParticleList to start playing

    {
        m_ParticleID = particle_id;
    }

Перекрестные ссылки m_ParticleID и particle_id.

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

SetWiggle()

void SetWiggle ( float random_angle, float random_interval )

inlineprivate

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

Calling SetWiggle(0,0) will effectively stop all wiggle functionality

Аргументы

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 )
        {   
            m_MaxOriWiggle = random_angle;
            m_MaxOriInterval = random_interval;
            
            if ( !m_RandomizeOri )
                m_RandomizeOri = new Timer( CALL_CATEGORY_GAMEPLAY );
            
            if ( !m_RandomizeOri.IsRunning() ) // Makes sure the timer is NOT running already
                m_RandomizeOri.Run( Math.RandomFloat(0, m_MaxOriInterval) , this, "RandomizeOrientation", null, false);
        }
        else
        {
            StopWiggle();
        }
    }

Перекрестные ссылки CALL_CATEGORY_GAMEPLAY, m_MaxOriInterval, m_MaxOriWiggle, m_RandomizeOri, Math::RandomFloat() и StopWiggle().

Используется в FlareSimulation::OnActivation(), CupidsBoltSimulation::OnFire(), SmokeSimulation::OnFire(), Ammo_40mm_Smoke_ColorBase::OnVariablesSynchronized(), PlayVFX() и Roadflare::UpdateActiveParticles().

Stop()

void Stop ( )

inlineprotected

Legacy function for backwards compatibility with 1.14 and below.

    {
        StopParticle();
    }

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

Используется в DynamicArea_Flare::EEDelete(), House::EEDelete(), BuildingSuper::EEDelete(), Ammo_40mm_Smoke_ColorBase::EEDelete(), ItemBase::EEDelete(), FlareSimulation::OnActivation(), FireworksLauncherClientEvent::OnExplode(), CupidsBoltSimulation::OnFire(), OnInventoryEnter(), FlammableBase::OnWorkStop(), ManBase::SetContaminatedEffectEx(), EffectParticle::Stop(), FlammableBase::StopAllParticles(), FlammableBase::UpdateParticle(), CupidsBoltSimulation::~CupidsBoltSimulation(), DestructionEffectBase::~DestructionEffectBase(), ~EasterEgg(), FlareSimulation::~FlareSimulation() и SmokeSimulation::~SmokeSimulation().

StopParticle()

override bool StopParticle ( int flags = 0 )

inlineprotected

Method to tell the particle to stop playing.

Заметки

No flags available for Particle

Emitors are automatically removed later when its particle count is 0

Аргументы

flags

int Flags to pass to the stopping (None on this level)

Возвращает

bool Whether the particle successfully stopped

    {
        OnParticleStop();       
        
        // Without the following we might get an error when a particle parent is despawned client-side.
        Object parent = Object.Cast( GetParent() );
        if ( parent && !ToDelete())
        {
            vector world_pos = GetPosition();
            parent.RemoveChild(this);
            SetPosition(world_pos);
        }
        
        UpdateState();
        
        return true;
    }

Перекрестные ссылки GetParent(), GetPosition, OnParticleStop(), SetPosition() и UpdateState().

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

StopWiggle()

void StopWiggle ( )

inlineprivate

Stops randomized wiggle.

    {           
        if ( m_RandomizeOri )
        {
            m_RandomizeOri.Stop();
        }
        
        m_MaxOriWiggle = 0;
        m_MaxOriInterval = 0;
    }

Перекрестные ссылки m_MaxOriInterval, m_MaxOriWiggle и m_RandomizeOri.

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

UpdateState()

void UpdateState ( )

inlineprotected

Creates/Destroys ParticleEffect child according to current state.

Заметки

Is called from Play/Stop methods

    {
        if ( m_IsPlaying == false && m_ParticleEffect)
        {
            DestroyParticleEffect();
        }
        else if ( m_IsPlaying == true && m_ParticleEffect == null )
        {
            CreateParticleEffect();
        }
    }

Перекрестные ссылки CreateParticleEffect(), DestroyParticleEffect(), m_IsPlaying и m_ParticleEffect.

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

Поля

m_DefaultOri

vector m_DefaultOri

private

Used for Wiggle API, to restore after unparenting.

Используется в ParticleSource::OnParticleUnParented(), RandomizeOrientation(), ParticleSource::RandomizeOrientation(), ParticleSource::SetWiggle() и ParticleSource::StopWiggle().

m_DefaultPos

vector m_DefaultPos

private

Used for Wiggle API, to restore after unparenting.

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

m_DefaultWorldOri

vector m_DefaultWorldOri

private

Used for Wiggle API, to restore after unparenting.

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

m_DefaultWorldPos

vector m_DefaultWorldPos

private

Used for Wiggle API, to restore after unparenting.

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

m_ForceOrientationRelativeToWorld

bool m_ForceOrientationRelativeToWorld

private

Used for Wiggle API, to restore after unparenting.

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

m_GlobalPosPreviousFrame

vector m_GlobalPosPreviousFrame

private

DEPRECATED.

m_IsRepeat

bool m_IsRepeat

protected

Whether this particle repeats.

Используется в CreateParticleEffect(), DestroyParticleEffect() и OnCheckAutoDelete().

m_Lifetime

float m_Lifetime

protected

Approx. remaining lifetime of particle.

Используется в CreateParticleEffect(), EOnFrame() и OnCheckAutoDelete().

m_MarkedForDeletion

bool m_MarkedForDeletion

private

Whether this particle is queued for deletion.

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

m_MaxOriInterval

float m_MaxOriInterval

private

Used for Wiggle API, Interval for wiggling [0, m_MaxOriInterval[.

Используется в ParticleSource::OnParticleUnParented(), RandomizeOrientation(), ParticleSource::RandomizeOrientation(), SetWiggle(), ParticleSource::SetWiggle() и StopWiggle().

m_MaxOriWiggle

float m_MaxOriWiggle

private

Used for Wiggle API, Wiggle room [-m_MaxOriWiggle, m_MaxOriWiggle].

Используется в ParticleSource::OnParticleUnParented(), RandWiggleFloat(), SetWiggle(), ParticleSource::SetWiggle() и StopWiggle().

m_ParentObject

Object m_ParentObject

protected

Parent Object the Particle is child of.

Используется в AddAsChild(), GetParticleParent(), ParticleSource::OnParticleParented(), ParticleSource::OnParticleUnParented() и RandomizeOrientation().

m_ParticleEffect

Object m_ParticleEffect

protected

The child object which contains the actual particle.

Используется в AddAsChild(), CreateParticleEffect(), DestroyParticleEffect(), GetDirectParticleEffect(), GetMaxLifetime(), GetParameter(), GetParameterEx(), GetParticleCount(), HasActiveParticle(), IncrementParticleParam(), IncrementParticleParamFromOriginal(), IsRepeat(), OnCheckAutoDelete(), ParticleSource::ParticleSource(), ScaleParticleParam(), ScaleParticleParamFromOriginal(), SetParameter(), SetParticleParam() и UpdateState().

m_ParticleID

int m_ParticleID

protected

ID from ParticleList if assigned.

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

m_PreviousFrame

int m_PreviousFrame

protected

DEPRECATED.

m_RandomizeOri

ref Timer m_RandomizeOri

private

Used for Wiggle API, calls the Wiggle functionality.

Используется в IsWiggling(), ParticleSource::OnParticleStop(), RandomizeOrientation(), ParticleSource::RandomizeOrientation(), SetWiggle() и StopWiggle().

m_WiggleProcessing

bool m_WiggleProcessing

private

Used for Wiggle API, to signal that wiggle API is currently doing work.

Используется в ParticleSource::OnParticleUnParented(), RandomizeOrientation() и ParticleSource::RandomizeOrientation().

MAX_EMITORS

const int MAX_EMITORS = 30

staticprivate

DEPRECATED

---

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

• D:/Ishodniki/scripts/3_Game/Particles/Particle.c