PC Stable Documentation
 
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
FireplaceBase Class Reference

Private Member Functions

void BarrelHoles_ColorBase ()
 
override protected void InitializeTemperatureSources ()
 
override bool CanCookOnStick ()
 
override bool IsBaseFireplace ()
 
override void CreateAreaDamage ()
 
override int GetDamageSystemVersionChange ()
 
override string GetInvulnerabilityTypeString ()
 
override void OnWasAttached (EntityAI parent, int slot_id)
 
override void OnWasDetached (EntityAI parent, int slot_id)
 
override bool CanDetachAttachment (EntityAI parent)
 
override void OnStoreSave (ParamsWriteContext ctx)
 
override bool OnStoreLoad (ParamsReadContext ctx, int version)
 
override bool IsBarrelWithHoles ()
 
override void OnVariablesSynchronized ()
 
override bool CanReceiveAttachment (EntityAI attachment, int slotId)
 
override bool CanLoadAttachment (EntityAI attachment)
 
override void EEItemAttached (EntityAI item, string slot_name)
 
override bool IsPrepareToDelete ()
 
override void EEItemDetached (EntityAI item, string slot_name)
 
override bool CanPutInCargo (EntityAI parent)
 
override bool CanRemoveFromCargo (EntityAI parent)
 
override bool CanReceiveItemIntoCargo (EntityAI item)
 
override bool CanLoadItemIntoCargo (EntityAI item)
 
override bool CanReleaseCargo (EntityAI cargo)
 
override bool CanPutIntoHands (EntityAI parent)
 
override bool CanDisplayCargo ()
 
override bool CanDisplayAttachmentCategory (string category_name)
 
override void Open ()
 
void OpenLoad ()
 
override void Close ()
 
void CloseLoad ()
 
override bool IsOpen ()
 
protected void UpdateVisualState ()
 
override bool CanExtinguishFire ()
 
override bool CanShowSmoke ()
 
override bool HasFlammableMaterial ()
 
override bool CanBeIgnitedBy (EntityAI igniter=NULL)
 
override bool CanIgniteItem (EntityAI ignite_target=NULL)
 
override bool IsIgnited ()
 
override void OnIgnitedTarget (EntityAI target_item)
 
override void OnIgnitedThis (EntityAI fire_source)
 
void DestroyClutterCutter (Object clutter_cutter)
 
override bool IsThisIgnitionSuccessful (EntityAI item_source=NULL)
 
string GetBarrelOpenSoundset ()
 
string GetBarrelCloseSoundset ()
 
override string GetDeploySoundset ()
 
override void InitItemSounds ()
 
override void SetActions ()
 
override void OnDebugSpawn ()
 
void SoundBarrelOpenPlay ()
 
void SoundBarrelClosePlay ()
 
void Fireplace ()
 
override protected void InitializeTemperatureSources ()
 
override bool IsBaseFireplace ()
 
override bool CanObstruct ()
 
override bool CanProxyObstruct ()
 
override void EOnTouch (IEntity other, int extra)
 
override void EOnContact (IEntity other, Contact extra)
 
void ContactEvent (IEntity other, vector position)
 
override protected void EOnPostSimulate (IEntity other, float timeSlice)
 
override bool CanReceiveAttachment (EntityAI attachment, int slotId)
 
override bool CanDisplayAttachmentSlot (int slot_id)
 
override bool CanLoadAttachment (EntityAI attachment)
 
override bool CanReleaseAttachment (EntityAI attachment)
 
override void EEItemAttached (EntityAI item, string slot_name)
 
override void EEItemDetached (EntityAI item, string slot_name)
 
override void SetCookingEquipment (ItemBase equipment)
 
override void OnBeforeTryDelete ()
 
override bool IsPrepareToDelete ()
 
override bool CanPutInCargo (EntityAI parent)
 
override bool CanRemoveFromCargo (EntityAI parent)
 
override bool CanReceiveItemIntoCargo (EntityAI item)
 
override bool CanLoadItemIntoCargo (EntityAI item)
 
override bool CanPutIntoHands (EntityAI parent)
 
override bool CanDisplayAttachmentCategory (string category_name)
 
override bool CanAssignAttachmentsToQuickbar ()
 
override float HeightStartCheckOverride ()
 
override bool CanShowSmoke ()
 
void DestroyClutterCutter (Object clutter_cutter)
 
override void RefreshPhysics ()
 
override void RefreshFireplacePhysics ()
 
override void OnStoreSave (ParamsWriteContext ctx)
 
override bool OnStoreLoad (ParamsReadContext ctx, int version)
 
override void AfterStoreLoad ()
 
override bool HasFlammableMaterial ()
 
override bool CanBeIgnitedBy (EntityAI igniter=NULL)
 
override bool CanIgniteItem (EntityAI ignite_target=NULL)
 
override bool IsIgnited ()
 
override void OnIgnitedTarget (EntityAI target_item)
 
override void OnIgnitedThis (EntityAI fire_source)
 
override bool IsThisIgnitionSuccessful (EntityAI item_source=NULL)
 
override void SetActions ()
 
void OvenIndoor ()
 
override void OnStoreSave (ParamsWriteContext ctx)
 
override bool OnStoreLoad (ParamsReadContext ctx, int version)
 
void SetFirePointIndex (int fire_point_index)
 
void SetSmokePointPosition (vector smoke_point_pos)
 
override protected vector GetSmokeEffectPosition ()
 
override void ParticleSmallSmokeStart ()
 
override void ParticleNormalSmokeStart ()
 
override bool IsIndoorOven ()
 
override bool CanReleaseAttachment (EntityAI attachment)
 
override void EEItemAttached (EntityAI item, string slot_name)
 
override void EEItemDetached (EntityAI item, string slot_name)
 
override bool CanPutInCargo (EntityAI parent)
 
override bool CanRemoveFromCargo (EntityAI parent)
 
override bool CanPutIntoHands (EntityAI parent)
 
override bool CanRemoveFromHands (EntityAI parent)
 
override bool HasFlammableMaterial ()
 
override bool CanBeIgnitedBy (EntityAI igniter=NULL)
 
override bool CanIgniteItem (EntityAI ignite_target=NULL)
 
override bool IsIgnited ()
 
override void OnIgnitedTarget (EntityAI target_item)
 
override void OnIgnitedThis (EntityAI fire_source)
 
override bool IsThisIgnitionSuccessful (EntityAI item_source=NULL)
 

Static Private Member Functions

static Fireplace IgniteEntityAsFireplace (notnull EntityAI entity, notnull EntityAI fire_source)
 
static bool CanIgniteEntityAsFireplace (notnull EntityAI entity)
 
static int GetFirePointIndex (string action_selection)
 
static bool CanPlaceFireplaceInSelectedSpot (Object building, int fire_point_index, out vector fire_point_pos_world, out vector fire_point_rot_world)
 

Private Attributes

const string ANIMATION_OPENED = "LidOff"
 
const string ANIMATION_CLOSED = "LidOn"
 
protected bool m_IsOpenedClient = false
 
protected ref OpenableBehaviour m_Openable
 
bool m_ContactEventProcessing = false
 
protected bool m_ContactDeletionProcessing = false
 
protected float m_SmokePosX
 
protected float m_SmokePosY
 
protected float m_SmokePosZ
 
protected int m_FirePointIndex = 1
 

Static Private Attributes

static const string OVENPOINT_ACTION_SELECTION = "oven_action"
 
static const string OVENPOINT_FIRE_POSITION = "oven_point"
 
static const string OVENPOINT_PLACE_ROT = "oven_rot"
 
static const string OVENPOINT_SMOKE_POSITION = "oven_smoke"
 

Member Function Documentation

◆ AfterStoreLoad()

◆ BarrelHoles_ColorBase()

◆ CanAssignAttachmentsToQuickbar()

override bool CanAssignAttachmentsToQuickbar ( )
inlineprivate

◆ CanBeIgnitedBy() [1/3]

override bool CanBeIgnitedBy ( EntityAI  igniter = NULL)
inlineprivate

◆ CanBeIgnitedBy() [2/3]

override bool CanBeIgnitedBy ( EntityAI  igniter = NULL)
inlineprivate

References HasAnyKindling(), and IsBurning().

◆ CanBeIgnitedBy() [3/3]

override bool CanBeIgnitedBy ( EntityAI  igniter = NULL)
inlineprivate

References HasAnyKindling().

◆ CanCookOnStick()

override bool CanCookOnStick ( )
inlineprivate

◆ CanDetachAttachment()

override bool CanDetachAttachment ( EntityAI  parent)
inlineprivate

References GetNumberOfItems().

◆ CanDisplayAttachmentCategory() [1/2]

override bool CanDisplayAttachmentCategory ( string  category_name)
inlineprivate

References IsOpen().

◆ CanDisplayAttachmentCategory() [2/2]

override bool CanDisplayAttachmentCategory ( string  category_name)
inlineprivate

References IsOven().

◆ CanDisplayAttachmentSlot()

override bool CanDisplayAttachmentSlot ( int  slot_id)
inlineprivate

◆ CanDisplayCargo()

override bool CanDisplayCargo ( )
inlineprivate

References IsOpen().

◆ CanExtinguishFire()

override bool CanExtinguishFire ( )
inlineprivate

References IsBurning(), and IsOpen().

Referenced by ActionCondition().

◆ CanIgniteEntityAsFireplace()

static bool CanIgniteEntityAsFireplace ( notnull EntityAI  entity)
inlinestaticprivate

◆ CanIgniteItem() [1/3]

override bool CanIgniteItem ( EntityAI  ignite_target = NULL)
inlineprivate

References IsBurning(), and IsOpen().

◆ CanIgniteItem() [2/3]

override bool CanIgniteItem ( EntityAI  ignite_target = NULL)
inlineprivate

References IsBurning().

◆ CanIgniteItem() [3/3]

override bool CanIgniteItem ( EntityAI  ignite_target = NULL)
inlineprivate

References IsBurning().

◆ CanLoadAttachment() [1/2]

override bool CanLoadAttachment ( EntityAI  attachment)
inlineprivate

◆ CanLoadAttachment() [2/2]

override bool CanLoadAttachment ( EntityAI  attachment)
inlineprivate

◆ CanLoadItemIntoCargo() [1/2]

override bool CanLoadItemIntoCargo ( EntityAI  item)
inlineprivate

◆ CanLoadItemIntoCargo() [2/2]

override bool CanLoadItemIntoCargo ( EntityAI  item)
inlineprivate

◆ CanObstruct()

override bool CanObstruct ( )
inlineprivate

References IsOven().

◆ CanPlaceFireplaceInSelectedSpot()

static bool CanPlaceFireplaceInSelectedSpot ( Object  building,
int  fire_point_index,
out vector  fire_point_pos_world,
out vector  fire_point_rot_world 
)
inlinestaticprivate

◆ CanProxyObstruct()

override bool CanProxyObstruct ( )
inlineprivate

References IsOven().

◆ CanPutInCargo() [1/3]

override bool CanPutInCargo ( EntityAI  parent)
inlineprivate

◆ CanPutInCargo() [2/3]

override bool CanPutInCargo ( EntityAI  parent)
inlineprivate

◆ CanPutInCargo() [3/3]

override bool CanPutInCargo ( EntityAI  parent)
inlineprivate

◆ CanPutIntoHands() [1/3]

override bool CanPutIntoHands ( EntityAI  parent)
inlineprivate

◆ CanPutIntoHands() [2/3]

override bool CanPutIntoHands ( EntityAI  parent)
inlineprivate

◆ CanPutIntoHands() [3/3]

override bool CanPutIntoHands ( EntityAI  parent)
inlineprivate

◆ CanReceiveAttachment() [1/2]

◆ CanReceiveAttachment() [2/2]

override bool CanReceiveAttachment ( EntityAI  attachment,
int  slotId 
)
inlineprivate

◆ CanReceiveItemIntoCargo() [1/2]

override bool CanReceiveItemIntoCargo ( EntityAI  item)
inlineprivate

◆ CanReceiveItemIntoCargo() [2/2]

override bool CanReceiveItemIntoCargo ( EntityAI  item)
inlineprivate

◆ CanReleaseAttachment() [1/2]

override bool CanReleaseAttachment ( EntityAI  attachment)
inlineprivate

◆ CanReleaseAttachment() [2/2]

override bool CanReleaseAttachment ( EntityAI  attachment)
inlineprivate

References IsBurning(), IsFuel(), and IsKindling().

◆ CanReleaseCargo()

override bool CanReleaseCargo ( EntityAI  cargo)
inlineprivate

References IsOpen().

◆ CanRemoveFromCargo() [1/3]

override bool CanRemoveFromCargo ( EntityAI  parent)
inlineprivate

◆ CanRemoveFromCargo() [2/3]

override bool CanRemoveFromCargo ( EntityAI  parent)
inlineprivate

◆ CanRemoveFromCargo() [3/3]

override bool CanRemoveFromCargo ( EntityAI  parent)
inlineprivate

◆ CanRemoveFromHands()

override bool CanRemoveFromHands ( EntityAI  parent)
inlineprivate

◆ CanShowSmoke() [1/2]

override bool CanShowSmoke ( )
inlineprivate

References IsOpen().

Referenced by RefreshFireParticlesAndSounds().

◆ CanShowSmoke() [2/2]

override bool CanShowSmoke ( )
inlineprivate

References IsOven().

◆ Close()

override void Close ( )
inlineprivate

References SetTakeable().

◆ CloseLoad()

void CloseLoad ( )
inlineprivate

References SetTakeable().

◆ ContactEvent()

void ContactEvent ( IEntity  other,
vector  position 
)
inlineprivate

References dBodyIsActive(), and GetGame().

Referenced by EOnContact(), and EOnTouch().

◆ CreateAreaDamage()

override void CreateAreaDamage ( )
inlineprivate

◆ DestroyClutterCutter() [1/2]

void DestroyClutterCutter ( Object  clutter_cutter)
inlineprivate

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

◆ DestroyClutterCutter() [2/2]

void DestroyClutterCutter ( Object  clutter_cutter)
inlineprivate

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

◆ EEItemAttached() [1/3]

override void EEItemAttached ( EntityAI  item,
string  slot_name 
)
inlineprivate

◆ EEItemAttached() [2/3]

◆ EEItemAttached() [3/3]

override void EEItemAttached ( EntityAI  item,
string  slot_name 
)
inlineprivate

◆ EEItemDetached() [1/3]

◆ EEItemDetached() [2/3]

◆ EEItemDetached() [3/3]

◆ EOnContact()

override void EOnContact ( IEntity  other,
Contact  extra 
)
inlineprivate

◆ EOnPostSimulate()

override protected void EOnPostSimulate ( IEntity  other,
float  timeSlice 
)
inlineprivate

References CheckForDestroy().

◆ EOnTouch()

override void EOnTouch ( IEntity  other,
int  extra 
)
inlineprivate

References ContactEvent(), and GetPosition.

◆ Fireplace()

◆ GetBarrelCloseSoundset()

string GetBarrelCloseSoundset ( )
inlineprivate

◆ GetBarrelOpenSoundset()

string GetBarrelOpenSoundset ( )
inlineprivate

◆ GetDamageSystemVersionChange()

override int GetDamageSystemVersionChange ( )
inlineprivate

◆ GetDeploySoundset()

override string GetDeploySoundset ( )
inlineprivate

◆ GetFirePointIndex()

static int GetFirePointIndex ( string  action_selection)
inlinestaticprivate

◆ GetInvulnerabilityTypeString()

override string GetInvulnerabilityTypeString ( )
inlineprivate

◆ GetSmokeEffectPosition()

override protected vector GetSmokeEffectPosition ( )
inlineprivate

◆ HasFlammableMaterial() [1/3]

override bool HasFlammableMaterial ( )
inlineprivate

◆ HasFlammableMaterial() [2/3]

override bool HasFlammableMaterial ( )
inlineprivate

◆ HasFlammableMaterial() [3/3]

override bool HasFlammableMaterial ( )
inlineprivate

◆ HeightStartCheckOverride()

override float HeightStartCheckOverride ( )
inlineprivate

◆ IgniteEntityAsFireplace()

static Fireplace IgniteEntityAsFireplace ( notnull EntityAI  entity,
notnull EntityAI  fire_source 
)
inlinestaticprivate

References ECE_PLACE_ON_SURFACE, and GetGame().

◆ InitializeTemperatureSources() [1/2]

◆ InitializeTemperatureSources() [2/2]

◆ InitItemSounds()

override void InitItemSounds ( )
inlineprivate

◆ IsBarrelWithHoles()

override bool IsBarrelWithHoles ( )
inlineprivate

◆ IsBaseFireplace() [1/2]

◆ IsBaseFireplace() [2/2]

override bool IsBaseFireplace ( )
inlineprivate

◆ IsIgnited() [1/3]

override bool IsIgnited ( )
inlineprivate

References IsBurning().

◆ IsIgnited() [2/3]

override bool IsIgnited ( )
inlineprivate

References IsBurning().

◆ IsIgnited() [3/3]

override bool IsIgnited ( )
inlineprivate

References IsBurning().

◆ IsIndoorOven()

override bool IsIndoorOven ( )
inlineprivate

◆ IsOpen()

◆ IsPrepareToDelete() [1/2]

override bool IsPrepareToDelete ( )
inlineprivate

Referenced by CheckForDestroy().

◆ IsPrepareToDelete() [2/2]

override bool IsPrepareToDelete ( )
inlineprivate

References HasAshes(), and IsBurning().

◆ IsThisIgnitionSuccessful() [1/3]

override bool IsThisIgnitionSuccessful ( EntityAI  item_source = NULL)
inlineprivate

◆ IsThisIgnitionSuccessful() [2/3]

◆ IsThisIgnitionSuccessful() [3/3]

override bool IsThisIgnitionSuccessful ( EntityAI  item_source = NULL)
inlineprivate

References HasAnyKindling(), and IsWet().

◆ OnBeforeTryDelete()

override void OnBeforeTryDelete ( )
inlineprivate

References m_HalfExtents.

◆ OnDebugSpawn()

override void OnDebugSpawn ( )
inlineprivate

◆ OnIgnitedTarget() [1/3]

override void OnIgnitedTarget ( EntityAI  target_item)
inlineprivate

◆ OnIgnitedTarget() [2/3]

override void OnIgnitedTarget ( EntityAI  target_item)
inlineprivate

◆ OnIgnitedTarget() [3/3]

override void OnIgnitedTarget ( EntityAI  target_item)
inlineprivate

◆ OnIgnitedThis() [1/3]

◆ OnIgnitedThis() [2/3]

◆ OnIgnitedThis() [3/3]

override void OnIgnitedThis ( EntityAI  fire_source)
inlineprivate

References StartFire().

◆ OnStoreLoad() [1/3]

override bool OnStoreLoad ( ParamsReadContext  ctx,
int  version 
)
inlineprivate

References Serializer::Read().

◆ OnStoreLoad() [2/3]

override bool OnStoreLoad ( ParamsReadContext  ctx,
int  version 
)
inlineprivate

◆ OnStoreLoad() [3/3]

override bool OnStoreLoad ( ParamsReadContext  ctx,
int  version 
)
inlineprivate

◆ OnStoreSave() [1/3]

override void OnStoreSave ( ParamsWriteContext  ctx)
inlineprivate

References Serializer::Write().

◆ OnStoreSave() [2/3]

override void OnStoreSave ( ParamsWriteContext  ctx)
inlineprivate

◆ OnStoreSave() [3/3]

override void OnStoreSave ( ParamsWriteContext  ctx)
inlineprivate

◆ OnVariablesSynchronized()

override void OnVariablesSynchronized ( )
inlineprivate

◆ OnWasAttached()

override void OnWasAttached ( EntityAI  parent,
int  slot_id 
)
inlineprivate

References Open.

◆ OnWasDetached()

override void OnWasDetached ( EntityAI  parent,
int  slot_id 
)
inlineprivate

References Close().

◆ Open()

override void Open ( )
inlineprivate

References SetTakeable().

◆ OpenLoad()

void OpenLoad ( )
inlineprivate

References SetTakeable().

◆ OvenIndoor()

◆ ParticleNormalSmokeStart()

override void ParticleNormalSmokeStart ( )
inlineprivate

◆ ParticleSmallSmokeStart()

override void ParticleSmallSmokeStart ( )
inlineprivate

◆ RefreshFireplacePhysics()

override void RefreshFireplacePhysics ( )
inlineprivate

◆ RefreshPhysics()

override void RefreshPhysics ( )
inlineprivate

◆ SetActions() [1/2]

override void SetActions ( )
inlineprivate

References ActionPlaceObject(), and AddAction().

◆ SetActions() [2/2]

◆ SetCookingEquipment()

override void SetCookingEquipment ( ItemBase  equipment)
inlineprivate

◆ SetFirePointIndex()

void SetFirePointIndex ( int  fire_point_index)
inlineprivate

References m_FirePointIndex.

◆ SetSmokePointPosition()

void SetSmokePointPosition ( vector  smoke_point_pos)
inlineprivate

◆ SoundBarrelClosePlay()

void SoundBarrelClosePlay ( )
private

◆ SoundBarrelOpenPlay()

void SoundBarrelOpenPlay ( )
private

◆ UpdateVisualState()

protected void UpdateVisualState ( )
inlineprivate

References IsOpen().

Field Documentation

◆ ANIMATION_CLOSED

const string ANIMATION_CLOSED = "LidOn"
private

◆ ANIMATION_OPENED

const string ANIMATION_OPENED = "LidOff"
private

◆ m_ContactDeletionProcessing

protected bool m_ContactDeletionProcessing = false
private

◆ m_ContactEventProcessing

bool m_ContactEventProcessing = false
private

◆ m_FirePointIndex

protected int m_FirePointIndex = 1
private

◆ m_IsOpenedClient

protected bool m_IsOpenedClient = false
private

◆ m_Openable

protected ref OpenableBehaviour m_Openable
private

◆ m_SmokePosX

protected float m_SmokePosX
private

◆ m_SmokePosY

protected float m_SmokePosY
private

◆ m_SmokePosZ

protected float m_SmokePosZ
private

◆ OVENPOINT_ACTION_SELECTION

const string OVENPOINT_ACTION_SELECTION = "oven_action"
staticprivate

◆ OVENPOINT_FIRE_POSITION

const string OVENPOINT_FIRE_POSITION = "oven_point"
staticprivate

◆ OVENPOINT_PLACE_ROT

const string OVENPOINT_PLACE_ROT = "oven_rot"
staticprivate

◆ OVENPOINT_SMOKE_POSITION

const string OVENPOINT_SMOKE_POSITION = "oven_smoke"
staticprivate

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