PC Stable Documentation
 
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Private Member Functions | Private Attributes | Static Private Attributes
Roadflare Class Reference

Private Member Functions

void Roadflare ()
 
void SetModelState (int enum_state)
 
override void EEDelete (EntityAI parent)
 
override void OnStoreSave (ParamsWriteContext ctx)
 
override bool OnStoreLoad (ParamsReadContext ctx, int version)
 
void UpdateModelSelections ()
 
override void OnWorkStart ()
 
void SetBurningState (int state_number)
 
void SetBurningStateSynchronized (int state_number)
 
override void OnWork (float consumed_energy)
 
override void OnWorkStop ()
 
void UpdateActiveParticles ()
 
void DestroyParticle (Particle p)
 
void DestroyParticleEx (out Particle p)
 
void DestroyAllParticles ()
 
void StopSmoking ()
 
override void OnInventoryExit (Man player)
 
override bool CanPutInCargo (EntityAI parent)
 
override void OnInventoryEnter (Man player)
 
override void OnActivatedByItem (notnull ItemBase item)
 
override bool CanIgniteItem (EntityAI ignite_target=NULL)
 
override void OnVariablesSynchronized ()
 
override void SetActions ()
 

Private Attributes

private int m_BurningState = RoadflareBurningState.NOT_BURNING
 
RoadflareLight m_Light
 
protected Particle m_ParInitialFire
 
protected Particle m_ParMainFire
 
protected Particle m_ParFinalFire
 
protected Particle m_ParJustSmoke
 
protected EffectSound m_BurningSound
 
protected EffectSound m_IgniteSound
 
ref Timer m_FinalSmokeTimer
 
private int m_ModelState = RoadflareModelStates.DEFAULT
 
ref NoiseParams m_NoisePar
 
private float m_NoiseTimer
 

Static Private Attributes

static protected const int INITIAL_BURNING_STATE_TIME = 5
 
static protected const int FINAL_BURNING_STATE_TIME = 60
 
static protected vector m_FlameLocalPos = "0 0.285 0"
 
static protected int PARTICLE_INIT_FIRE = ParticleList.ROADFLARE_BURNING_INIT
 
static protected int PARTICLE_MAIN_FIRE = ParticleList.ROADFLARE_BURNING_MAIN
 
static protected int PARTICLE_FINAL_FIRE = ParticleList.ROADFLARE_BURNING_ENDING
 
static protected int PARTICLE_FINAL_SMOKE = ParticleList.ROADFLARE_BURNING_SMOKE
 
static protected const string BURNING_SOUND = "roadflareLoop_SoundSet"
 
static protected const string IGNITE_SOUND = "roadflareTurnOn_SoundSet"
 
static protected const int BURNING_NOISE_RANGE = 30
 
static const string STANDS_FOLDED = "Sticks_Flare_Folded"
 
static const string STANDS_UNFOLDED = "Sticks_Flare_Unfolded"
 
static const string FLARE_CAP = "Flare_cap"
 
static const string UNIGNITED_TIP = "Pristine"
 
static const string IGNITED_TIP = "Burning"
 
static const string EXTINGUISHED_TIP = "Burned_out"
 
static const int SELECTION_Burning = 0
 
static const int SELECTION_Burned_out = 1
 
static const int SELECTION_Pristine = 2
 
static const int SELECTION_All = 3
 
static const string DEFAULT_TEXTURE = "dz\\gear\\consumables\\data\\road_flare_co.paa"
 
static const string BURNING_TEXTURE = "dz\\gear\\consumables\\data\\road_flare_e_co.paa"
 
static const string DEFAULT_MATERIAL = "dz\\gear\\consumables\\data\\road_flare.rvmat"
 
static const string BURNING_MATERIAL = "dz\\gear\\consumables\\data\\road_flare_on.rvmat"
 

Constructor & Destructor Documentation

◆ Roadflare()

void Roadflare ( )
inlineprivate

Member Function Documentation

◆ CanIgniteItem()

override bool CanIgniteItem ( EntityAI  ignite_target = NULL)
inlineprivate

◆ CanPutInCargo()

override bool CanPutInCargo ( EntityAI  parent)
inlineprivate

References m_BurningState.

◆ DestroyAllParticles()

void DestroyAllParticles ( )
inlineprivate

References DestroyParticleEx(), m_ParFinalFire, m_ParInitialFire, m_ParJustSmoke, and m_ParMainFire.

Referenced by EEDelete(), and UpdateActiveParticles().

◆ DestroyParticle()

void DestroyParticle ( Particle  p)
inlineprivate

References Particle::SetWiggle(), and Particle::Stop().

Referenced by DestroyParticleEx().

◆ DestroyParticleEx()

void DestroyParticleEx ( out Particle  p)
inlineprivate

References DestroyParticle().

Referenced by DestroyAllParticles(), and UpdateActiveParticles().

◆ EEDelete()

override void EEDelete ( EntityAI  parent)
inlineprivate

References DestroyAllParticles(), SEffectManager::DestroyEffect(), GetGame(), m_BurningSound, m_FinalSmokeTimer, m_IgniteSound, and m_Light.

◆ OnActivatedByItem()

override void OnActivatedByItem ( notnull ItemBase  item)
inlineprivate

References TripwireTrap().

◆ OnInventoryEnter()

override void OnInventoryEnter ( Man  player)
inlineprivate

References STANDS_FOLDED, and STANDS_UNFOLDED.

◆ OnInventoryExit()

override void OnInventoryExit ( Man  player)
inlineprivate

References m_BurningState, STANDS_FOLDED, STANDS_UNFOLDED, and Vector().

◆ OnStoreLoad()

override bool OnStoreLoad ( ParamsReadContext  ctx,
int  version 
)
inlineprivate

References Serializer::Read(), and SetModelState().

◆ OnStoreSave()

override void OnStoreSave ( ParamsWriteContext  ctx)
inlineprivate

References m_ModelState, and Serializer::Write().

◆ OnVariablesSynchronized()

override void OnVariablesSynchronized ( )
inlineprivate

References UpdateActiveParticles().

◆ OnWork()

override void OnWork ( float  consumed_energy)
inlineprivate

References FINAL_BURNING_STATE_TIME, GetGame(), INITIAL_BURNING_STATE_TIME, m_BurningState, SetBurningStateSynchronized(), and UpdateActiveParticles().

◆ OnWorkStart()

override void OnWorkStart ( )
inlineprivate

References BURNING_SOUND, GetGame(), IGNITE_SOUND, m_BurningSound, m_IgniteSound, m_Light, SetBurningState(), SetModelState(), and Vector().

◆ OnWorkStop()

override void OnWorkStop ( )
inlineprivate

References CALL_CATEGORY_SYSTEM, GetEnergy(), GetGame(), m_BurningSound, m_FinalSmokeTimer, m_Light, SetBurningState(), SetBurningStateSynchronized(), SetModelState(), and UpdateActiveParticles().

◆ SetActions()

override void SetActions ( )
inlineprivate

References ActionAttach(), ActionDetach(), ActionLightItemOnFire(), and AddAction().

◆ SetBurningState()

void SetBurningState ( int  state_number)
inlineprivate

References m_BurningState.

Referenced by OnWorkStart(), and OnWorkStop().

◆ SetBurningStateSynchronized()

void SetBurningStateSynchronized ( int  state_number)
inlineprivate

References GetGame(), and m_BurningState.

Referenced by OnWork(), OnWorkStop(), and StopSmoking().

◆ SetModelState()

void SetModelState ( int  enum_state)
inlineprivate

References m_ModelState, and UpdateModelSelections().

Referenced by ActionTurnOnWhileInHands::OnStartClient(), ActionTurnOnWhileInHands::OnStartServer(), OnStoreLoad(), OnWorkStart(), and OnWorkStop().

◆ StopSmoking()

void StopSmoking ( )
inlineprivate

References SetBurningStateSynchronized(), and UpdateActiveParticles().

◆ UpdateActiveParticles()

void UpdateActiveParticles ( )
inlineprivate

References DestroyAllParticles(), DestroyParticleEx(), GetGame(), m_BurningState, m_FlameLocalPos, m_ParFinalFire, m_ParInitialFire, m_ParJustSmoke, m_ParMainFire, PARTICLE_FINAL_FIRE, PARTICLE_FINAL_SMOKE, PARTICLE_INIT_FIRE, PARTICLE_MAIN_FIRE, ParticleManager(), and Particle::SetWiggle().

Referenced by OnVariablesSynchronized(), OnWork(), OnWorkStop(), and StopSmoking().

◆ UpdateModelSelections()

void UpdateModelSelections ( )
inlineprivate

References DEFAULT_MATERIAL, DEFAULT_TEXTURE, EXTINGUISHED_TIP, FLARE_CAP, IGNITED_TIP, m_ModelState, SELECTION_Burned_out, SELECTION_Pristine, and UNIGNITED_TIP.

Referenced by SetModelState().

Field Documentation

◆ BURNING_MATERIAL

const string BURNING_MATERIAL = "dz\\gear\\consumables\\data\\road_flare_on.rvmat"
staticprivate

◆ BURNING_NOISE_RANGE

protected const int BURNING_NOISE_RANGE = 30
staticprivate

◆ BURNING_SOUND

protected const string BURNING_SOUND = "roadflareLoop_SoundSet"
staticprivate

Referenced by OnWorkStart().

◆ BURNING_TEXTURE

const string BURNING_TEXTURE = "dz\\gear\\consumables\\data\\road_flare_e_co.paa"
staticprivate

◆ DEFAULT_MATERIAL

const string DEFAULT_MATERIAL = "dz\\gear\\consumables\\data\\road_flare.rvmat"
staticprivate

Referenced by UpdateModelSelections().

◆ DEFAULT_TEXTURE

const string DEFAULT_TEXTURE = "dz\\gear\\consumables\\data\\road_flare_co.paa"
staticprivate

Referenced by UpdateModelSelections().

◆ EXTINGUISHED_TIP

const string EXTINGUISHED_TIP = "Burned_out"
staticprivate

Referenced by UpdateModelSelections().

◆ FINAL_BURNING_STATE_TIME

protected const int FINAL_BURNING_STATE_TIME = 60
staticprivate

Referenced by OnWork().

◆ FLARE_CAP

const string FLARE_CAP = "Flare_cap"
staticprivate

Referenced by UpdateModelSelections().

◆ IGNITE_SOUND

protected const string IGNITE_SOUND = "roadflareTurnOn_SoundSet"
staticprivate

Referenced by OnWorkStart().

◆ IGNITED_TIP

const string IGNITED_TIP = "Burning"
staticprivate

Referenced by UpdateModelSelections().

◆ INITIAL_BURNING_STATE_TIME

protected const int INITIAL_BURNING_STATE_TIME = 5
staticprivate

Referenced by OnWork().

◆ m_BurningSound

protected EffectSound m_BurningSound
private

Referenced by EEDelete(), OnWorkStart(), and OnWorkStop().

◆ m_BurningState

private int m_BurningState = RoadflareBurningState.NOT_BURNING
private

Referenced by CanPutInCargo(), OnInventoryExit(), OnWork(), SetBurningState(), SetBurningStateSynchronized(), and UpdateActiveParticles().

◆ m_FinalSmokeTimer

ref Timer m_FinalSmokeTimer
private

Referenced by EEDelete(), and OnWorkStop().

◆ m_FlameLocalPos

protected vector m_FlameLocalPos = "0 0.285 0"
staticprivate

Referenced by UpdateActiveParticles().

◆ m_IgniteSound

protected EffectSound m_IgniteSound
private

Referenced by EEDelete(), and OnWorkStart().

◆ m_Light

RoadflareLight m_Light
private

Referenced by EEDelete(), OnWorkStart(), and OnWorkStop().

◆ m_ModelState

private int m_ModelState = RoadflareModelStates.DEFAULT
private

Referenced by OnStoreSave(), SetModelState(), and UpdateModelSelections().

◆ m_NoisePar

ref NoiseParams m_NoisePar
private

◆ m_NoiseTimer

private float m_NoiseTimer
private

◆ m_ParFinalFire

protected Particle m_ParFinalFire
private

Referenced by DestroyAllParticles(), and UpdateActiveParticles().

◆ m_ParInitialFire

protected Particle m_ParInitialFire
private

Referenced by DestroyAllParticles(), and UpdateActiveParticles().

◆ m_ParJustSmoke

protected Particle m_ParJustSmoke
private

Referenced by DestroyAllParticles(), and UpdateActiveParticles().

◆ m_ParMainFire

protected Particle m_ParMainFire
private

Referenced by DestroyAllParticles(), and UpdateActiveParticles().

◆ PARTICLE_FINAL_FIRE

protected int PARTICLE_FINAL_FIRE = ParticleList.ROADFLARE_BURNING_ENDING
staticprivate

Referenced by UpdateActiveParticles().

◆ PARTICLE_FINAL_SMOKE

protected int PARTICLE_FINAL_SMOKE = ParticleList.ROADFLARE_BURNING_SMOKE
staticprivate

Referenced by UpdateActiveParticles().

◆ PARTICLE_INIT_FIRE

protected int PARTICLE_INIT_FIRE = ParticleList.ROADFLARE_BURNING_INIT
staticprivate

Referenced by UpdateActiveParticles().

◆ PARTICLE_MAIN_FIRE

protected int PARTICLE_MAIN_FIRE = ParticleList.ROADFLARE_BURNING_MAIN
staticprivate

Referenced by UpdateActiveParticles().

◆ SELECTION_All

const int SELECTION_All = 3
staticprivate

◆ SELECTION_Burned_out

const int SELECTION_Burned_out = 1
staticprivate

Referenced by UpdateModelSelections().

◆ SELECTION_Burning

const int SELECTION_Burning = 0
staticprivate

◆ SELECTION_Pristine

const int SELECTION_Pristine = 2
staticprivate

Referenced by UpdateModelSelections().

◆ STANDS_FOLDED

const string STANDS_FOLDED = "Sticks_Flare_Folded"
staticprivate

Referenced by OnInventoryEnter(), and OnInventoryExit().

◆ STANDS_UNFOLDED

const string STANDS_UNFOLDED = "Sticks_Flare_Unfolded"
staticprivate

Referenced by OnInventoryEnter(), and OnInventoryExit().

◆ UNIGNITED_TIP

const string UNIGNITED_TIP = "Pristine"
staticprivate

Referenced by UpdateModelSelections().

The documentation for this class was generated from the following file: