FlammableBase Class Reference

Private Member Functions
void	FlammableBase ()
override void	DeferredInit ()
void	Init ()
override void	EEInit ()
override vector	GetUniversalTemperatureSourcePosition ()
override void	EEDelete (EntityAI parent)
override bool	CanReceiveAttachment (EntityAI attachment, int slotId)
override bool	CanPutInCargo (EntityAI parent)
override bool	CanReleaseAttachment (EntityAI attachment)
override bool	CanRemoveFromCargo (EntityAI parent)
override bool	CanPutAsAttachment (EntityAI parent)
bool	CanBeTakenAsCargo ()
override bool	IsIgnited ()
override bool	CanIgniteItem (EntityAI ignite_target=NULL)
override bool	HasFlammableMaterial ()
override bool	CanBeIgnitedBy (EntityAI igniter=NULL)
bool	IsRagDryEnough (ItemBase rag)
void	UpdateCheckForReceivingUpgrade ()
override void	OnIgnitedThis (EntityAI fire_source)
override void	OnSwitchOn ()
override void	OnSwitchOff ()
void	SetTorchDecraftResult (string type)
bool	ConsumeRag ()
void	ConsumeLard (Lard lard)
void	Upgrade (ItemBase source)
void	ConsumeFuelFromBottle (ItemBase vessel)
void	ConsumeFuelFromGasStation ()
void	RuinRags ()
override void	OnInventoryExit (Man player)
bool	StandUp ()
void	CalculateQuantity ()
bool	CanReceiveUpgrade ()
void	CraftingInit (float quantity)
override void	EEItemAttached (EntityAI item, string slot_name)
override void	EEItemDetached (EntityAI item, string slot_name)
bool	CanTransformIntoStick ()
void	TryTransformIntoStick ()
override void	OnWorkStart ()
void	StopAllParticles ()
Rag	GetRag ()
void	LockRags (bool do_lock)
void	UpdateLight ()
override void	OnItemInHandsPlayerSwimStart (PlayerBase player)
override void	OnWork (float consumed_energy)
string	GetSoundName ()
void	UpdateParticle ()
override void	OnWorkStop ()
override int	GetMeleeMode ()
override int	GetMeleeHeavyMode ()
override int	GetMeleeSprintMode ()
override void	SetActions ()
override void	OnAttachmentQuantityChangedEx (ItemBase item, float delta)
override bool	DisassembleOnLastDetach ()
override void	OnDebugSpawn ()
int	GetRagQuantity ()
string	GetBurningMaterial ()
string	GetBurntMaterial ()
void	UpdateMaterial ()
override void	OnStoreSave (ParamsWriteContext ctx)
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
void	ApplyResultModifications (ItemBase result)

Private Attributes
private SoundOnVehicle	m_LoopSoundEntity
Particle	m_FireParticle
bool	m_CanReceiveUpgrade
bool	m_IsBeingDestructed = false
float	m_BurnTimePerRagEx
float	m_BurnTimePerFullLardEx
float	m_BurnTimePerFullFuelDoseEx
float	m_MaxConsumableLardQuantityEx
float	m_MaxConsumableFuelQuantityEx
float	m_WaterEvaporationByFireIntensityEx = 0.001
int	m_StartFadeOutOfLightAtQuantityEx = 3
int	m_RagsUpgradedCount
bool	m_ConsumeRagFlipFlop
vector	m_ParticleLocalPos = Vector(0, 0.50, 0)
string	m_DecraftResult = "WoodenStick"
TorchLight	m_Light
bool	m_WasLit
protected ref UniversalTemperatureSource	m_UTSource
protected ref UniversalTemperatureSourceSettings	m_UTSSettings
protected ref UniversalTemperatureSourceLambdaConstant	m_UTSLConstant

Constructor & Destructor Documentation

FlammableBase()

void FlammableBase ( )

inlineprivate

References Init().

Member Function Documentation

ApplyResultModifications()

void ApplyResultModifications ( ItemBase  result )

inlineprivate

References ItemBase::SetQuantity().

Referenced by TorchLambda::CopyOldPropertiesToNew(), and TryTransformIntoStick().

CalculateQuantity()

void CalculateQuantity ( )

inlineprivate

References GetGame(), and SetQuantityNormalized().

Referenced by ConsumeFuelFromBottle(), ConsumeFuelFromGasStation(), ConsumeLard(), EEItemAttached(), EEItemDetached(), OnAttachmentQuantityChangedEx(), OnDebugSpawn(), OnWork(), OnWorkStop(), and Upgrade().

CanBeIgnitedBy()

override bool CanBeIgnitedBy ( EntityAI  igniter = NULL )

inlineprivate

References GetEnergy(), GetRag(), and IsRagDryEnough().

CanBeTakenAsCargo()

bool CanBeTakenAsCargo ( )

inlineprivate

Referenced by CanPutInCargo(), and CanRemoveFromCargo().

CanIgniteItem()

override bool CanIgniteItem ( EntityAI  ignite_target = NULL )

inlineprivate

CanPutAsAttachment()

override bool CanPutAsAttachment ( EntityAI  parent )

inlineprivate

CanPutInCargo()

override bool CanPutInCargo ( EntityAI  parent )

inlineprivate

References CanBeTakenAsCargo().

CanReceiveAttachment()

override bool CanReceiveAttachment ( EntityAI  attachment, int  slotId  )

inlineprivate

References ItemBase::CanReceiveAttachment().

CanReceiveUpgrade()

bool CanReceiveUpgrade ( )

inlineprivate

References m_CanReceiveUpgrade.

Referenced by ActionUpgradeTorchFromGasPump::ActionCondition(), and RecipeBase::CanDo().

CanReleaseAttachment()

override bool CanReleaseAttachment ( EntityAI  attachment )

inlineprivate

CanRemoveFromCargo()

override bool CanRemoveFromCargo ( EntityAI  parent )

inlineprivate

References CanBeTakenAsCargo().

CanTransformIntoStick()

bool CanTransformIntoStick ( )

inlineprivate

References GetGame(), GetRag(), and IsIgnited().

Referenced by TryTransformIntoStick().

ConsumeFuelFromBottle()

void ConsumeFuelFromBottle ( ItemBase  vessel )

inlineprivate

References CalculateQuantity(), m_BurnTimePerFullFuelDoseEx, m_MaxConsumableFuelQuantityEx, and UpdateCheckForReceivingUpgrade().

ConsumeFuelFromGasStation()

void ConsumeFuelFromGasStation ( )

inlineprivate

References CalculateQuantity(), m_BurnTimePerFullFuelDoseEx, and UpdateCheckForReceivingUpgrade().

ConsumeLard()

void ConsumeLard ( Lard  lard )

inlineprivate

References CalculateQuantity(), m_BurnTimePerFullLardEx, m_MaxConsumableLardQuantityEx, and UpdateCheckForReceivingUpgrade().

ConsumeRag()

bool ConsumeRag ( )

inlineprivate

References GetRag(), and LockRags().

Referenced by OnIgnitedThis(), and OnWork().

CraftingInit()

void CraftingInit ( float  quantity )

inlineprivate

References m_BurnTimePerRagEx, and m_CanReceiveUpgrade.

Referenced by OnDebugSpawn().

DeferredInit()

override void DeferredInit ( )

inlineprivate

References LockRags(), and m_RagsUpgradedCount.

DisassembleOnLastDetach()

override bool DisassembleOnLastDetach ( )

inlineprivate

EEDelete()

override void EEDelete ( EntityAI  parent )

inlineprivate

References GetGame(), m_LoopSoundEntity, CGame::ObjectDelete(), and StopAllParticles().

EEInit()

override void EEInit ( )

inlineprivate

References GetGame(), GameConstants::ITEM_TEMPERATURE_NEUTRAL_ZONE_MIDDLE, UniversalTemperatureSourceSettings::m_RangeFull, UniversalTemperatureSourceSettings::m_RangeMax, UniversalTemperatureSourceSettings::m_TemperatureCap, UniversalTemperatureSourceSettings::m_TemperatureItemCap, UniversalTemperatureSourceSettings::m_Updateable, UniversalTemperatureSourceSettings::m_UpdateInterval, m_UTSLConstant, m_UTSource, and m_UTSSettings.

EEItemAttached()

override void EEItemAttached ( EntityAI  item, string  slot_name  )

inlineprivate

References CalculateQuantity(), and UpdateCheckForReceivingUpgrade().

EEItemDetached()

override void EEItemDetached ( EntityAI  item, string  slot_name  )

inlineprivate

References CalculateQuantity(), CALL_CATEGORY_SYSTEM, ScriptCallQueue::CallLater(), ECE_PLACE_ON_SURFACE, CGame::GetCallQueue(), GetGame(), GetPosition, m_IsBeingDestructed, TryTransformIntoStick(), and UpdateCheckForReceivingUpgrade().

GetBurningMaterial()

string GetBurningMaterial ( )

inlineprivate

Referenced by UpdateMaterial().

GetBurntMaterial()

string GetBurntMaterial ( )

inlineprivate

Referenced by UpdateMaterial().

GetMeleeHeavyMode()

override int GetMeleeHeavyMode ( )

inlineprivate

GetMeleeMode()

override int GetMeleeMode ( )

inlineprivate

GetMeleeSprintMode()

override int GetMeleeSprintMode ( )

inlineprivate

GetRag()

Rag GetRag ( )

inlineprivate

Referenced by CanBeIgnitedBy(), CanTransformIntoStick(), ConsumeRag(), GetRagQuantity(), LockRags(), OnWork(), OnWorkStop(), RuinRags(), and Upgrade().

GetRagQuantity()

int GetRagQuantity ( )

inlineprivate

References GetQuantity(), GetRag(), and Math::Round().

Referenced by OnDebugSpawn(), OnWork(), OnWorkStop(), UpdateCheckForReceivingUpgrade(), and Upgrade().

GetSoundName()

string GetSoundName ( )

inlineprivate

Referenced by OnWork().

GetUniversalTemperatureSourcePosition()

override vector GetUniversalTemperatureSourcePosition ( )

inlineprivate

HasFlammableMaterial()

override bool HasFlammableMaterial ( )

inlineprivate

Init()

void Init ( )

inlineprivate

References CGame::ConfigGetFloat(), GetGame(), GetType(), m_BurnTimePerFullFuelDoseEx, m_BurnTimePerFullLardEx, m_BurnTimePerRagEx, m_MaxConsumableFuelQuantityEx, and m_MaxConsumableLardQuantityEx.

Referenced by FlammableBase().

IsIgnited()

override bool IsIgnited ( )

inlineprivate

Referenced by RecipeBase::CanDo(), BroomBase::CanTransformIntoStick(), and CanTransformIntoStick().

IsRagDryEnough()

bool IsRagDryEnough ( ItemBase  rag )

inlineprivate

Referenced by CanBeIgnitedBy().

LockRags()

void LockRags ( bool  do_lock )

inlineprivate

References GetRag(), and m_RagsUpgradedCount.

Referenced by ConsumeRag(), DeferredInit(), OnWasAttached(), OnWasDetached(), OnWorkStart(), OnWorkStop(), and Upgrade().

OnAttachmentQuantityChangedEx()

override void OnAttachmentQuantityChangedEx ( ItemBase  item, float  delta  )

inlineprivate

References CalculateQuantity(), m_BurnTimePerRagEx, and UpdateCheckForReceivingUpgrade().

OnDebugSpawn()

override void OnDebugSpawn ( )

inlineprivate

References CalculateQuantity(), CraftingInit(), and GetRagQuantity().

OnIgnitedThis()

override void OnIgnitedThis ( EntityAI  fire_source )

inlineprivate

References ConsumeRag().

Referenced by BroomBase::OnAction().

OnInventoryExit()

override void OnInventoryExit ( Man  player )

inlineprivate

References StandUp().

OnItemInHandsPlayerSwimStart()

override void OnItemInHandsPlayerSwimStart ( PlayerBase  player )

inlineprivate

OnStoreLoad()

override bool OnStoreLoad ( ParamsReadContext  ctx, int  version  )

inlineprivate

References m_WasLit, Serializer::Read(), and UpdateMaterial().

OnStoreSave()

override void OnStoreSave ( ParamsWriteContext  ctx )

inlineprivate

References m_WasLit, and Serializer::Write().

OnSwitchOff()

override void OnSwitchOff ( )

inlineprivate

References GetGame(), and m_UTSource.

OnSwitchOn()

override void OnSwitchOn ( )

inlineprivate

References GetGame(), and m_UTSource.

OnWork()

override void OnWork ( float  consumed_energy )

inlineprivate

References AddWet(), CalculateQuantity(), ConsumeRag(), GetEnergy(), GetGame(), GetRag(), GetRagQuantity(), GetSoundName(), m_BurnTimePerRagEx, m_ConsumeRagFlipFlop, m_LoopSoundEntity, m_RagsUpgradedCount, m_WaterEvaporationByFireIntensityEx, RuinRags(), UpdateCheckForReceivingUpgrade(), UpdateLight(), UpdateMaterial(), and UpdateParticle().

OnWorkStart()

override void OnWorkStart ( )

inlineprivate

References LockRags(), m_WasLit, and UpdateMaterial().

OnWorkStop()

override void OnWorkStop ( )

inlineprivate

References CalculateQuantity(), GetEnergy(), GetGame(), GetRag(), GetRagQuantity(), LockRags(), m_FireParticle, m_Light, m_LoopSoundEntity, CGame::ObjectDelete(), Particle::Stop(), TryTransformIntoStick(), UpdateCheckForReceivingUpgrade(), and UpdateMaterial().

RuinRags()

void RuinRags ( )

inlineprivate

References GetRag().

Referenced by OnWork(), and Upgrade().

SetActions()

override void SetActions ( )

inlineprivate

References ActionLightItemOnFire(), and AddAction().

SetTorchDecraftResult()

void SetTorchDecraftResult ( string  type )

inlineprivate

References m_DecraftResult.

StandUp()

bool StandUp ( )

inlineprivate

References GetGame(), GetPosition, CGame::IsSurfaceDigable(), Math::RandomFloat(), and CGame::SurfaceGetType().

Referenced by OnInventoryExit().

StopAllParticles()

void StopAllParticles ( )

inlineprivate

References m_FireParticle, and Particle::Stop().

Referenced by EEDelete(), and TryTransformIntoStick().

TryTransformIntoStick()

void TryTransformIntoStick ( )

inlineprivate

References ApplyResultModifications(), CanTransformIntoStick(), ECE_PLACE_ON_SURFACE, GetGame(), GetOrientation(), GetPosition, GetType(), m_DecraftResult, m_IsBeingDestructed, CGame::ObjectDelete(), StopAllParticles(), and Vector().

Referenced by EEItemDetached(), and OnWorkStop().

UpdateCheckForReceivingUpgrade()

void UpdateCheckForReceivingUpgrade ( )

inlineprivate

References GetGame(), GetRagQuantity(), m_BurnTimePerRagEx, m_CanReceiveUpgrade, and m_RagsUpgradedCount.

Referenced by ConsumeFuelFromBottle(), ConsumeFuelFromGasStation(), ConsumeLard(), EEItemAttached(), EEItemDetached(), OnAttachmentQuantityChangedEx(), OnStoreLoad(), OnWork(), OnWorkStop(), and Upgrade().

UpdateLight()

void UpdateLight ( )

inlineprivate

References Particle::GetDirectParticleEffect(), GetQuantity(), m_FireParticle, m_Light, m_ParticleLocalPos, m_StartFadeOutOfLightAtQuantityEx, and Vector().

Referenced by OnWork().

UpdateMaterial()

void UpdateMaterial ( )

inlineprivate

References GetBurningMaterial(), GetBurntMaterial(), GetGame(), and m_WasLit.

Referenced by OnStoreLoad(), OnWork(), OnWorkStart(), and OnWorkStop().

UpdateParticle()

void UpdateParticle ( )

inlineprivate

References Particle::GetParticleID(), GetQuantity(), m_FireParticle, m_ParticleLocalPos, ParticleManager(), Particle::ScaleParticleParamFromOriginal(), Particle::Stop(), ParticleList::TORCH_T1, and ParticleList::TORCH_T2.

Referenced by OnWork().

Upgrade()

void Upgrade ( ItemBase  source )

inlineprivate

References CalculateQuantity(), Math::Ceil(), GetRag(), GetRagQuantity(), LockRags(), m_BurnTimePerRagEx, m_ConsumeRagFlipFlop, m_RagsUpgradedCount, Math::Max(), Math::Min(), RuinRags(), and UpdateCheckForReceivingUpgrade().

Referenced by RecipeBase::Do().

Field Documentation

m_BurnTimePerFullFuelDoseEx

float m_BurnTimePerFullFuelDoseEx

private

Referenced by ConsumeFuelFromBottle(), ConsumeFuelFromGasStation(), Init(), and Init().

m_BurnTimePerFullLardEx

float m_BurnTimePerFullLardEx

private

Referenced by ConsumeLard(), Init(), and Init().

m_BurnTimePerRagEx

float m_BurnTimePerRagEx

private

Referenced by CraftingInit(), Init(), Init(), OnAttachmentQuantityChangedEx(), OnWork(), UpdateCheckForReceivingUpgrade(), and Upgrade().

m_CanReceiveUpgrade

bool m_CanReceiveUpgrade

private

Referenced by CanReceiveUpgrade(), CraftingInit(), and UpdateCheckForReceivingUpgrade().

m_ConsumeRagFlipFlop

bool m_ConsumeRagFlipFlop

private

Referenced by OnWork(), and Upgrade().

m_DecraftResult

string m_DecraftResult = "WoodenStick"

private

Referenced by BroomBase::Init(), SetTorchDecraftResult(), and TryTransformIntoStick().

m_FireParticle

Particle m_FireParticle

private

Referenced by OnWorkStop(), StopAllParticles(), UpdateLight(), BroomBase::UpdateParticle(), and UpdateParticle().

m_IsBeingDestructed

bool m_IsBeingDestructed = false

private

Referenced by EEItemDetached(), and TryTransformIntoStick().

m_Light

TorchLight m_Light

private

Referenced by OnWorkStop(), and UpdateLight().

m_LoopSoundEntity

private SoundOnVehicle m_LoopSoundEntity

private

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

m_MaxConsumableFuelQuantityEx

float m_MaxConsumableFuelQuantityEx

private

Referenced by ConsumeFuelFromBottle(), Init(), and Init().

m_MaxConsumableLardQuantityEx

float m_MaxConsumableLardQuantityEx

private

Referenced by ConsumeLard(), Init(), and Init().

m_ParticleLocalPos

vector m_ParticleLocalPos = Vector(0, 0.50, 0)

private

Referenced by BroomBase::Init(), UpdateLight(), BroomBase::UpdateParticle(), and UpdateParticle().

m_RagsUpgradedCount

int m_RagsUpgradedCount

private

Referenced by DeferredInit(), LockRags(), OnWork(), UpdateCheckForReceivingUpgrade(), and Upgrade().

m_StartFadeOutOfLightAtQuantityEx

int m_StartFadeOutOfLightAtQuantityEx = 3

private

Referenced by UpdateLight().

m_UTSLConstant

protected ref UniversalTemperatureSourceLambdaConstant m_UTSLConstant

private

Referenced by EEInit().

m_UTSource

protected ref UniversalTemperatureSource m_UTSource

private

Referenced by EEInit(), OnSwitchOff(), and OnSwitchOn().

m_UTSSettings

protected ref UniversalTemperatureSourceSettings m_UTSSettings

private

Referenced by EEInit().

m_WasLit

bool m_WasLit

private

Referenced by OnStoreLoad(), OnStoreSave(), OnWorkStart(), and UpdateMaterial().

m_WaterEvaporationByFireIntensityEx

float m_WaterEvaporationByFireIntensityEx = 0.001

private

Referenced by OnWork().

---

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

• P:/scripts/4_World/Entities/ItemBase/Torch.c