Класс EffectParticle

Wrapper class for managing particles through SEffectManager. Подробнее...

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

Защищенные члены
EffectType
Information about what type of effect the Effect is, without the need for casting
override EffectType	GetEffectType ()
	Get what type of effect the Effect is.
override bool	IsParticle ()
	Check whether the Effect is EffectParticle without casting.
Main particle
Set or get the main particle which this Effect will manage
void	SetParticle (Particle p)
	Sets the main particle which this Effect will manage.
Particle	GetParticle ()
	Gets the main particle which this Effect is managing.
Playback
Methods to Play/Stop Effect Generally, SEffectManager.Play methods are used instead of Start
override void	Start ()
	Plays all elements this effect consists of.
override void	Stop ()
	Stops all elements this effect consists of.
Attach
Helper methods for attaching to prent
void	AttachTo (Object obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_rotation_to_world=false)
	Read Particle.AddAsChild.
void	ReAttach ()
	Helper method to attach to parent using stored settings.
void	AddAsChild (Object obj, vector local_pos, vector local_ori, bool force_rotation_to_world)
	Helper method to attach to parent.
Events
Various events that can be overriden for custom behaviour
void	Event_OnPlayStart ()
	Event which just simply exists (DEPRECATED)
void	Event_OnPlayStarted ()
	Event which just simply exists (DEPRECATED)
Generic API
Setters and getters for generic data and properties
void	SetParticleID (int id)
	Sets the id of the particle to be used.
int	GetParticleID ()
	Gets the id of the particle to be used.
void	SetCurrentParticleID (int id)
	Sets the id of the particle to be used.
int	GetCurrentParticleID ()
	Gets the current id of the managed Particle.
override void	SetCurrentParent (Object parent_obj, bool updateCached=true)
	Set current parent of the managed Particle.
override Object	GetCurrentParent ()
	Get the current parent of the managed Particle.
override void	SetCurrentPosition (vector pos, bool updateCached=true)
	Set the current world position of the managed Particle.
override vector	GetCurrentPosition ()
	Get the current world position of the managed Particle.
override void	SetCurrentLocalPosition (vector pos, bool updateCached=true)
	Set the current local position of the managed Particle.
override vector	GetCurrentLocalPosition ()
	Get the current local position of the managed Particle.
void	SetOrientation (vector ori)
	Set orientation of the EffectParticle.
vector	GetOrientation ()
	Get the orientation of the EffectParticle.
void	SetCurrentOrientation (vector ori, bool updateCached=true)
	Set the current orientation of the managed Particle.
vector	GetCurrentOrientation ()
	Get the current orientation of the managed Particle.
void	ForceParticleRotationRelativeToWorld (bool state)
	Set orientation setting to be used by the effect when the Effect starts.
bool	IsParticleRotationRelativeToWorld ()
	Get the orientation setting to be used by the effect when the Effect starts.
bool	IsParticleCurrentRotationRelativeToWorld ()
	Get the current orientation setting to be used by the managed Particle.

Защищенные данные
Particle	m_ParticleObj
	The main Particle effect that this Effect wrapper manages.
Generic data
Generic data for the particle
int	m_ParticleID
	The ID in the ParticleList to create Particle from.
vector	m_Orientation
	Orientation set by SetOrientation.
bool	m_ForceRotationRelativeToWorld
	Orientation setting to be used by the effect when the Effect starts.

DEPRECATED
Methods which exist for backwards compatibility and are no longer in use or have never been in use
vector	m_ParticleOrientation
Object	m_Object
void	EffectParticle ()
	ctor
void	~EffectParticle ()
	dtor
override void	InitEffect ()
	init
override string	GetDebugName ()
	Override when getting debug information.
override void	ValidateStart ()
	Validation whether an effect truly started playing or if the Effect should stop as none is present.
void	CheckLifeSpan ()
	Was never called and probably should never be called.
void	SetDecalOwner (Object o)

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

Wrapper class for managing particles through SEffectManager.

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

EffectParticle()

void EffectParticle ( )

inlineprotected

ctor

    {
        
    }

~EffectParticle()

void ~EffectParticle ( )

inlineprotected

dtor

    {
 
    }

Методы

AddAsChild()

void AddAsChild ( Object obj, vector local_pos, vector local_ori, bool force_rotation_to_world )

inlineprotected

Helper method to attach to parent.

    {
        Particle p = GetParticle();     
        if (p)
        {
            p.AddAsChild(obj, local_pos, local_ori, force_rotation_to_world);
        }
    }

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

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

AttachTo()

void AttachTo ( Object obj, vector local_pos = "0 0 0", vector local_ori = "0 0 0", bool force_rotation_to_world = false )

inlineprotected

Read Particle.AddAsChild.

    {
        // Update the cached variables...
        SetParent(obj);
        SetLocalPosition(local_pos);
        SetAttachedLocalOri(local_ori);
        ForceParticleRotationRelativeToWorld(force_rotation_to_world);
        
        // Now attach it
        AddAsChild(obj, local_pos, local_ori, force_rotation_to_world);
    }

Перекрестные ссылки AddAsChild(), ForceParticleRotationRelativeToWorld(), SetAttachedLocalOri(), SetLocalPosition() и SetParent().

CheckLifeSpan()

void CheckLifeSpan ( )

inlineprotected

Was never called and probably should never be called.

Предупреждения

Emptied the functionality as it is relatively unsafe...

    {
        /*
        if ( !m_ParticleObj )
        {
            delete this;
        }
        
        OnCheckUpdate();
        */
    }

Event_OnPlayStart()

void Event_OnPlayStart ( )

inlineprotected

Event which just simply exists (DEPRECATED)

Предупреждения

Never called or used

Заметки

Use Event_OnStarted instead

    {
        
    }

Event_OnPlayStarted()

void Event_OnPlayStarted ( )

inlineprotected

Event which just simply exists (DEPRECATED)

Предупреждения

Never called or used

Заметки

Use Event_OnStarted instead

    {
 
    }

ForceParticleRotationRelativeToWorld()

void ForceParticleRotationRelativeToWorld ( bool state )

inlineprotected

Set orientation setting to be used by the effect when the Effect starts.

Предупреждения

Only caches it into a variable to be used by Start, does not live update when called afterwards

Заметки

There is no way to update this immediately

Аргументы

state

bool Whether to keep WS orientation when attaching it to parent

    {
        m_ForceRotationRelativeToWorld = state;
    }

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

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

GetCurrentLocalPosition()

override vector GetCurrentLocalPosition ( )

inlineprotected

Get the current local position of the managed Particle.

Возвращает

vector The current local position of the managed Particle

    {
        Particle p = GetParticle(); 
        
        if (p)
        {
            Object parent = GetParent();
            
            if (parent)
                return parent.WorldToModel(p.GetPosition());
            else
                return p.GetPosition();
        }
        else
            return super.GetLocalPosition();
    }

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

GetCurrentOrientation()

vector GetCurrentOrientation ( )

inlineprotected

Get the current orientation of the managed Particle.

Возвращает

vector The current orientation of the managed Particle

    {
        Particle p = GetParticle(); 
        
        if (p)
            return p.GetOrientation();
        else
            return vector.Zero;
    }

Перекрестные ссылки GetParticle() и vector::Zero.

GetCurrentParent()

override Object GetCurrentParent ( )

inlineprotected

Get the current parent of the managed Particle.

Возвращает

Object The currrent parent of the Particle

    {
        Particle p = GetParticle();
            
        if (p)
            return Object.Cast(p.GetParent());
        else
            return super.GetParent();
    }

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

GetCurrentParticleID()

int GetCurrentParticleID ( )

inlineprotected

Gets the current id of the managed Particle.

Возвращает

int Particle ID registered in ParticleList

    {
        Particle p = GetParticle();
        if (p)
        {
            return p.GetParticleID();
        }
        else
        {
            return ParticleList.INVALID;
        }
    }

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

GetCurrentPosition()

override vector GetCurrentPosition ( )

inlineprotected

Get the current world position of the managed Particle.

Возвращает

vector The current world position of the managed Particle

    {
        Particle p = GetParticle(); 
        
        if (p)
            return p.GetPosition();
        else
            return super.GetPosition();
    }

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

GetDebugName()

override string GetDebugName ( )

inlineprotected

Override when getting debug information.

    {
        string identifier;
        if (GetParticle())
        {
            identifier = GetParticle().GetDebugNameNative();
        }
        else
        {
            identifier = "NO_PARTICLE";
        }
        
        return string.Format("%1:%2:%3", super.GetDebugName(), m_ParticleID, identifier);
    }

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

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

GetEffectType()

override EffectType GetEffectType ( )

inlineprotected

Get what type of effect the Effect is.

Возвращает

EffectType What type of effect the Effect is

    {
        return EffectType.PARTICLE;
    }

GetOrientation()

vector GetOrientation ( )

inlineprotected

Get the orientation of the EffectParticle.

Предупреждения

Only gets the cached variable, for immediate effect use GetCurrent variant

Возвращает

vector The orientation of EffectParticle

    {
        return m_Orientation;
    }

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

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

GetParticle()

Particle GetParticle ( )

inlineprotected

Gets the main particle which this Effect is managing.

Возвращает

Particle Main particle which this Effect is managing

    {
        return m_ParticleObj;
    }

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

Используется в AddAsChild(), EffEngineSmoke::Event_OnFrameUpdate(), GetCurrentLocalPosition(), GetCurrentOrientation(), GetCurrentParent(), GetCurrentParticleID(), GetCurrentPosition(), GetDebugName(), IsParticleCurrentRotationRelativeToWorld(), IsParticleRotationRelativeToWorld(), SetCurrentLocalPosition(), SetCurrentOrientation(), SetCurrentParticleID(), SetCurrentPosition(), EffExhaustSmoke::SetParticleStateLight(), Stop(), EffCoolantSteam::UpdateParticle() и ValidateStart().

GetParticleID()

int GetParticleID ( )

inlineprotected

Gets the id of the particle to be used.

Предупреждения

Only gets the cached variable, for immediate effect use GetCurrent variant

Возвращает

int Particle ID registered in ParticleList

    {
        return m_ParticleID;
    }

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

InitEffect()

override void InitEffect ( )

inlineprotected

init

    {
        super.InitEffect();
        
        // Would be neat, but since particles are often already playing
        // BEFORE they are even registered as the particle for the Effect
        // Better to just keep that one I guess..
        // Event_OnStarted.Remove(Event_OnEffectStarted);
        
        // Will be called by the particle events
        Event_OnStopped.Remove(Event_OnEffectEnded);
    }

Перекрестные ссылки Event_OnEffectEnded и Event_OnStopped.

IsParticle()

override bool IsParticle ( )

inlineprotected

Check whether the Effect is EffectParticle without casting.

Возвращает

bool Whether the Effect is EffectParticle

    {
        return true;
    }

IsParticleCurrentRotationRelativeToWorld()

bool IsParticleCurrentRotationRelativeToWorld ( )

inlineprotected

Get the current orientation setting to be used by the managed Particle.

Возвращает

bool Whether the managed Particle is only updating position from parent

    {
        Particle p = GetParticle(); 
        
        if (p)
            return p.IsHierarchyPositionOnly();
        else
            return false;
    }

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

IsParticleRotationRelativeToWorld()

bool IsParticleRotationRelativeToWorld ( )

inlineprotected

Get the orientation setting to be used by the effect when the Effect starts.

Предупреждения

Only gets the cached variable, for immediate effect use IsParticleCurrentRotationRelativeToWorld

Возвращает

bool Whether to keep WS orientation when attaching it to parent

    {
        Particle p = GetParticle(); 
        
        if (p)
            return p.IsHierarchyPositionOnly();
        else
            return m_ForceRotationRelativeToWorld;
    }

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

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

ReAttach()

void ReAttach ( )

inlineprotected

Helper method to attach to parent using stored settings.

    {
        // Skip the updating, as we are going to reuse what was set before
        AddAsChild( GetParent(), GetLocalPosition(), GetAttachedLocalOri(), IsParticleRotationRelativeToWorld());
    }

Перекрестные ссылки AddAsChild(), GetAttachedLocalOri(), GetLocalPosition(), GetParent() и IsParticleRotationRelativeToWorld().

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

SetCurrentLocalPosition()

override void SetCurrentLocalPosition ( vector pos, bool updateCached = true )

inlineprotected

Set the current local position of the managed Particle.

Аргументы

pos	vector The current local position for the managed Particle
updateCached	bool Whether to update the cached variable

    {
        super.SetCurrentLocalPosition(pos, updateCached);
        
        Particle p = GetParticle();         
        if (p)
        {
            Object parent = GetParent();
            
            if (parent)
                ReAttach();
            else
                p.SetPosition(pos);
        }
    }

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

SetCurrentOrientation()

void SetCurrentOrientation ( vector ori, bool updateCached = true )

inlineprotected

Set the current orientation of the managed Particle.

Аргументы

ori	vector Orientation in degrees (yaw, pitch, roll)

    {
        if ( updateCached)
            SetOrientation(ori);
        
        Particle p = GetParticle(); 
                
        if (p)
            p.SetOrientation(ori);
    }

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

SetCurrentParent()

override void SetCurrentParent ( Object parent_obj, bool updateCached = true )

inlineprotected

Set current parent of the managed Particle.

Аргументы

parent_obj	Object The parent for the Particle
updateCached	bool Whether to update the cached variable

    {
        super.SetCurrentParent(parent_obj, updateCached);
        
        ReAttach();
    }

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

SetCurrentParticleID()

void SetCurrentParticleID ( int id )

inlineprotected

Sets the id of the particle to be used.

Заметки

Particle will not update immediately, but ParticleSource will

Аргументы

id	int Particle ID registered in ParticleList

    {
        m_ParticleID = id;
        
        Particle p = GetParticle();
        if (p)
        {
            p.SetSource(id);
        }
    }

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

SetCurrentPosition()

override void SetCurrentPosition ( vector pos, bool updateCached = true )

inlineprotected

Set the current world position of the managed Particle.

Аргументы

pos	vector The current world position for the Particle
updateCached	bool Whether to update the cached variable

    {
        super.SetCurrentPosition(pos, updateCached);
        
        Particle p = GetParticle();
        
        if (p)
            p.SetPosition(pos);
    }

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

SetDecalOwner()

void SetDecalOwner ( Object o )

inlineprotected

    {
        m_Object = o;
    }

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

SetOrientation()

void SetOrientation ( vector ori )

inlineprotected

Set orientation of the EffectParticle.

Предупреждения

Only sets the cached variable, for immediate effect use SetCurrent variant

Аргументы

ori	vector Orientation in degrees (yaw, pitch, roll)

    {
        m_Orientation = ori;
    }

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

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

SetParticle()

void SetParticle ( Particle p )

inlineprotected

Sets the main particle which this Effect will manage.

Аргументы

p	Particle Main particle which this Effect will manage

    {
        // Unregister the events on the old
        if (m_ParticleObj)
        {
            ParticleEvents ope = m_ParticleObj.GetEvents();
            ope.Event_OnParticleStart.Remove(Event_OnEffectStarted);
            ope.Event_OnParticleStop.Remove(Event_OnEffectEnded);
        }
        
        // Assign the new main Particle
        m_ParticleObj = p;
        
        // Register the events on the new
        if (m_ParticleObj)
        {
            ParticleEvents npe = m_ParticleObj.GetEvents();
            npe.Event_OnParticleStart.Insert(Event_OnEffectStarted);
            // We will use Stop instead of End, as old particles were destroyed when they stopped
            // And this system kinda relies on that
            npe.Event_OnParticleStop.Insert(Event_OnEffectEnded);
        }
    }

Перекрестные ссылки Event_OnEffectEnded, Event_OnEffectStarted и m_ParticleObj.

Используется в EffBulletImpactBase::Event_OnStarted(), Start() и Stop().

SetParticleID()

void SetParticleID ( int id )

inlineprotected

Sets the id of the particle to be used.

Заметки

Only changes the cached variable, for immediate, use SetCurrentParticleID

Аргументы

id	int Particle ID registered in ParticleList

    {
        m_ParticleID = id;
    }

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

Используется в BleedingSourceEffect::BleedingSourceEffect(), BleedingSourceEffect(), BloodSplatter::BloodSplatter(), EffBreathVapourHeavy::EffBreathVapourHeavy(), EffBreathVapourLight::EffBreathVapourLight(), EffBreathVapourMedium::EffBreathVapourMedium(), EffBulletImpactTest::EffBulletImpactTest(), EffGeneratorSmoke::EffGeneratorSmoke(), EffSwarmingFlies::EffSwarmingFlies(), EffVomit::EffVomit(), EffVomitBlood::EffVomitBlood(), LandmineExplosion::LandmineExplosion(), MenuCarEngineSmoke::MenuCarEngineSmoke(), MenuEvaporation::MenuEvaporation() и EffVehicleSmoke::SetParticleState().

Start()

override void Start ( )

inlineprotected

Plays all elements this effect consists of.

Заметки

Is called by SEffectManager.Play methods

    {       
        if (m_ParticleID > 0)
        {
            vector pos = GetPosition();         
            vector ori = GetOrientation();
            
            if (m_ParentObject)
            {
                pos = GetLocalPosition();
                ori = GetAttachedLocalOri();
            }       
            
            SetParticle(ParticleManager.GetInstance().CreateParticle(m_ParticleID, pos, true, GetParent(), ori, IsParticleRotationRelativeToWorld()));
        }
 
        super.Start();
    }

Перекрестные ссылки GetAttachedLocalOri(), GetLocalPosition(), GetOrientation(), GetParent(), GetPosition, IsParticleRotationRelativeToWorld(), m_ParentObject, m_ParticleID, ParticleManager() и SetParticle().

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

Stop()

override void Stop ( )

inlineprotected

Stops all elements this effect consists of.

Заметки

Alternatively use SEffectManager.Stop( effect_id )

    {
        if ( GetParticle() )
        {
            GetParticle().Stop();
            SetParticle(null);
        }
        
        super.Stop();
    }

Перекрестные ссылки GetParticle(), SetParticle() и Particle::Stop().

Используется в EffVehicleSmoke::SetParticleState() и ValidateStart().

ValidateStart()

override void ValidateStart ( )

inlineprotected

Validation whether an effect truly started playing or if the Effect should stop as none is present.

Заметки

Override this when inheriting to create own validation check

Is called from Event_OnStarted invoker after Event_OnStarted has been performed

    {
        if (!GetParticle())
        {
            ErrorEx(string.Format("No Particle started playing, stopping EffectParticle: %1", GetDebugName()), ErrorExSeverity.WARNING);
            Stop();
        }
    }

Перекрестные ссылки ErrorEx, GetDebugName(), GetParticle() и Stop().

Поля

m_ForceRotationRelativeToWorld

bool m_ForceRotationRelativeToWorld

protected

Orientation setting to be used by the effect when the Effect starts.

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

m_Object

Object m_Object

protected

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

m_Orientation

vector m_Orientation

protected

Orientation set by SetOrientation.

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

m_ParticleID

int m_ParticleID

protected

The ID in the ParticleList to create Particle from.

Используется в GetDebugName(), GetParticleID(), SetCurrentParticleID(), SetParticleID() и Start().

m_ParticleObj

Particle m_ParticleObj

protected

The main Particle effect that this Effect wrapper manages.

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

m_ParticleOrientation

vector m_ParticleOrientation

protected

---

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

• D:/Ishodniki/scripts/3_Game/Effects/EffectParticle.c