Loading...
Searching...
No Matches
CityBuilderCore.FireAddon Class Reference

Detailed Description

addon that simulates a fire

burns for some time, then replaces the building with a defined structure(eg Rubble)
also completely disrupts building efficiency for obvious reasons

https://citybuilder.softleitner.com/manual/risks

Inheritance diagram for CityBuilderCore.FireAddon:
CityBuilderCore.BuildingAddon CityBuilderCore.IEfficiencyFactor CityBuilderCore.KeyedBehaviour CityBuilderCore.ISaveData CityBuilderCore.IKeyed

Classes

class  FireData
 

Public Member Functions

override void Update ()
 
void Extinguish (float amount)
 
override string SaveData ()
 serializes the objects state(usually to json) and returns it
 
override void LoadData (string json)
 deserializes the serialized json data and loads the data as its new state
 
- Public Member Functions inherited from CityBuilderCore.BuildingAddon
virtual void Awake ()
 
virtual void Start ()
 
void Remove ()
 Removes the addon from the Building it is located on
this will usually result in the termination of the addon.
 
virtual void InitializeAddon ()
 called by the Building after the addon has been instantiated and Building has been set
 
virtual void TerminateAddon ()
 called by the Building when the addon gets removed
this should usually terminate the addon(mark as terminated and Destroy)
 
virtual void OnReplacing (Transform parent, IBuilding replacement)
 called be the addons building when the building gets replaced
this has to move the addon over to the new building
otherwise it will be destroyed with the old one
 

Public Attributes

Risk Risk
 
string StructureCollectionKey
 
float Duration
 
float ExtinguishAmount
 
- Public Attributes inherited from CityBuilderCore.BuildingAddon
AddonAccumulationMode Accumulation
 
bool Save
 
bool Center
 
bool Scale
 
- Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string Key
 

Properties

bool IsWorking [get]
 false disrupts the building
 
float Factor [get]
 how efficiency is changed by this component(0-1), a buildings efficiency is calculated by multiplying all of its efficiency factors
 
bool IsExtinguished [get]
 
- Properties inherited from CityBuilderCore.BuildingAddon
IBuilding Building [get, set]
 
- Properties inherited from CityBuilderCore.IKeyed
- Properties inherited from CityBuilderCore.IEfficiencyFactor

Additional Inherited Members

- Public Types inherited from CityBuilderCore.BuildingAddon
enum  AddonAccumulationMode { Stack , Queue , Replace , Single }
 specifies how the addon behaves when there is more than one at the same time More...
 
- Protected Attributes inherited from CityBuilderCore.BuildingAddon
bool _isTerminated
 

Member Function Documentation

◆ LoadData()

override void CityBuilderCore.FireAddon.LoadData ( string json)
inlinevirtual

deserializes the serialized json data and loads the data as its new state

Parameters
json

Reimplemented from CityBuilderCore.BuildingAddon.

◆ SaveData()

override string CityBuilderCore.FireAddon.SaveData ( )
inlinevirtual

serializes the objects state(usually to json) and returns it

Returns
serialized save data

Reimplemented from CityBuilderCore.BuildingAddon.

◆ Update()

override void CityBuilderCore.FireAddon.Update ( )
inlinevirtual

Reimplemented from CityBuilderCore.BuildingAddon.

Property Documentation

◆ Factor

float CityBuilderCore.FireAddon.Factor
get

how efficiency is changed by this component(0-1), a buildings efficiency is calculated by multiplying all of its efficiency factors

Implements CityBuilderCore.IEfficiencyFactor.

◆ IsWorking

bool CityBuilderCore.FireAddon.IsWorking
get

false disrupts the building

Implements CityBuilderCore.IEfficiencyFactor.