Файл ParticleBase.c

См. исходные тексты.

Структуры данных
class	ParticleEvents
	Invokers for ParticleBase events, called from events. Подробнее...

Функции
void	ParticleBase ()
	ctor
override bool	IsParticle ()
	Have script recognize this as a Particle without casting.
Playback
Methods regarding playing/stopping of particle
void	PlayParticle (int particle_id=-1)
	Method to tell the particle to start playing.
bool	PlayParticleEx (int particle_id=-1, int flags=0)
	Method to tell the particle to start playing.
bool	StopParticle (int flags=0)
	Method to tell the particle to stop playing.
bool	ResetParticle ()
	Method to tell the particle to reset.
bool	RestartParticle ()
	Method to tell the particle to restart (reset + play)
bool	IsParticlePlaying ()
	Ask if the particle is still playing.
ParticleEvents	GetEvents ()
	Get the events.
Events
ParticleBase events For ParticleSource, these are handed on C++ side For more information, read ParticleEvents
void	OnParticleStart ()
	Event when the particle starts.
void	OnParticleStop ()
	Event when the particle stops.
void	OnParticleReset ()
	Event when the particle is restarted.
void	OnParticleEnd ()
	Event when the particle ends.
void	OnParticleParented (IEntity parent)
	Event when the particle receives a parent.
void	OnParticleUnParented (IEntity parent)
	Event when the particle is orphaned.

Переменные
class ParticleEvents	m_IsPlaying
	Engine base class with internal functionality.
ref ParticleEvents	m_EventInvokers
	Event invokers.

Функции

GetEvents()

ParticleEvents GetEvents ( )

protected

Get the events.

Возвращает

ParticleEvents If there is any events set, this will return them so that additional functionality can be bound to them

    {
        return m_EventInvokers;
    }

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

Используется в OnAllocation(), OnAllocationEnd(), OnParticleEnd(), OnParticleParented(), OnParticleReset(), OnParticleStart(), OnParticleStop() и OnParticleUnParented().

IsParticle()

override bool IsParticle ( )

protected

Have script recognize this as a Particle without casting.

    {
        return true;
    }

IsParticlePlaying()

bool IsParticlePlaying ( )

protected

Ask if the particle is still playing.

Возвращает

bool Whether the particle is playing

    {
        ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
        return false;
    }

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

OnParticleEnd()

void OnParticleEnd ( )

protected

Event when the particle ends.

Заметки

Looping particles will never end

    {
        GetEvents().Event_OnParticleEnd.Invoke(this);
    }

Перекрестные ссылки ParticleEvents::Event_OnParticleEnd и GetEvents().

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

OnParticleParented()

void OnParticleParented ( IEntity parent )

protected

Event when the particle receives a parent.

    {
        GetEvents().Event_OnParticleParented.Invoke(this);
    }

Перекрестные ссылки ParticleEvents::Event_OnParticleParented и GetEvents().

OnParticleReset()

void OnParticleReset ( )

protected

Event when the particle is restarted.

    {
        GetEvents().Event_OnParticleReset.Invoke(this);
    }

Перекрестные ссылки ParticleEvents::Event_OnParticleReset и GetEvents().

OnParticleStart()

void OnParticleStart ( )

protected

Event when the particle starts.

    {
        m_IsPlaying = true;
        GetEvents().Event_OnParticleStart.Invoke(this);
    }

Перекрестные ссылки ParticleEvents::Event_OnParticleStart, GetEvents() и m_IsPlaying.

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

OnParticleStop()

void OnParticleStop ( )

protected

Event when the particle stops.

    {
        m_IsPlaying = false;
        GetEvents().Event_OnParticleStop.Invoke(this);
    }

Перекрестные ссылки ParticleEvents::Event_OnParticleStop, GetEvents() и m_IsPlaying.

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

OnParticleUnParented()

void OnParticleUnParented ( IEntity parent )

protected

Event when the particle is orphaned.

    {
        GetEvents().Event_OnParticleUnParented.Invoke(this);
    }

Перекрестные ссылки ParticleEvents::Event_OnParticleUnParented и GetEvents().

ParticleBase()

void ParticleBase ( )

protected

ctor

    {
        m_EventInvokers = new ParticleEvents();
    }

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

PlayParticle()

void PlayParticle ( int particle_id = -1 )

protected

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

    {
        ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
    }

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

Используется в ParticleFireEndStart(), ParticleFireStartStart(), ParticleFireWindyNoIgniteStart(), ParticleNormalFireStart(), ParticleNormalSmokeStart(), FireplaceBase::ParticleNormalSmokeStart(), ParticleSmallFireStart(), ParticleSmallSmokeStart(), FireplaceBase::ParticleSmallSmokeStart(), ParticleSteamEndStart(), ParticleSteamExtinguishingStart() и ParticleWetNoIgniteStart().

PlayParticleEx()

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

protected

Method to tell the particle to start playing.

Аргументы

particle_id	int Particle ID registered in ParticleList to start playing
flags	int Flags to pass to the playing

Возвращает

bool Whether the particle successfully started

    {
        ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
        return false;
    }

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

ResetParticle()

bool ResetParticle ( )

protected

Method to tell the particle to reset.

Возвращает

bool Whether the particle successfully reset

    {
        ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
        return false;
    }

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

RestartParticle()

bool RestartParticle ( )

protected

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

Возвращает

bool Whether the particle successfully restarted

    {
        ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
        return false;
    }

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

StopParticle()

bool StopParticle ( int flags = 0 )

protected

Method to tell the particle to stop playing.

Аргументы

flags

int Flags to pass to the stopping

Возвращает

bool Whether the particle successfully stopped

    {
        ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
        return false;
    }

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

Используется в ParticleFireEndStop(), ParticleFireStartStop(), ParticleNormalFireStop(), ParticleNormalSmokeStop(), ParticleSmallFireStop(), ParticleSmallSmokeStop(), ParticleSteamEndStop(), ParticleSteamExtinguishingStop(), ParticleWetNoIgniteStop() и StopAllParticlesAndSounds().

Переменные

m_EventInvokers

ref ParticleEvents m_EventInvokers

protected

Event invokers.

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

m_IsPlaying

class ParticleEvents m_IsPlaying

Engine base class with internal functionality.

Заметки

Is NOT intended for direct creation As this does not have an actual particle Use either Particle or ParticleSource Whether the particle is currently playing