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

Detailed Description

changes materials of renderers on the building while active
for example for outline or highlight materials

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

Inheritance diagram for CityBuilderCore.BuildingAddonMaterial:
CityBuilderCore.BuildingAddon CityBuilderCore.KeyedBehaviour CityBuilderCore.ISaveData CityBuilderCore.IKeyed

Public Member Functions

override void InitializeAddon ()
 called by the Building after the addon has been instantiated and Building has been set
 
override void TerminateAddon ()
 called by the Building when the addon gets removed
this should usually terminate the addon(mark as terminated and Destroy)
 
- Public Member Functions inherited from CityBuilderCore.BuildingAddon
virtual void Awake ()
 
virtual void Start ()
 
virtual void Update ()
 
void Remove ()
 Removes the addon from the Building it is located on
this will usually result in the termination of the addon.
 
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
 
virtual string SaveData ()
 serializes the objects state(usually to json) and returns it
 
virtual void LoadData (string json)
 deserializes the serialized json data and loads the data as its new state
 

Public Attributes

bool Replace
 
string[] Targets
 
Material[] Materials
 
- Public Attributes inherited from CityBuilderCore.BuildingAddon
AddonAccumulationMode Accumulation
 
bool Save
 
bool Center
 
bool Scale
 
- Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string Key
 

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
 
- Properties inherited from CityBuilderCore.BuildingAddon
IBuilding Building [get, set]
 
- Properties inherited from CityBuilderCore.IKeyed

Member Function Documentation

◆ InitializeAddon()

override void CityBuilderCore.BuildingAddonMaterial.InitializeAddon ( )
inlinevirtual

called by the Building after the addon has been instantiated and Building has been set

Reimplemented from CityBuilderCore.BuildingAddon.

◆ TerminateAddon()

override void CityBuilderCore.BuildingAddonMaterial.TerminateAddon ( )
inlinevirtual

called by the Building when the addon gets removed
this should usually terminate the addon(mark as terminated and Destroy)

Reimplemented from CityBuilderCore.BuildingAddon.