CityBuilderCore.BuildingAddonRenderer Class Reference

Detailed Description

copies over materials and properties from a renderer to the building while active
can be used to put things like animated dissolves on a building temporarily
(see BuildingPlayground3D for an example in the BigHouseTool_Appear tool)

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

Inheritance diagram for CityBuilderCore.BuildingAddonRenderer:

Public Types
enum	MaterialMode { Replace , Add , None }
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...

Public Member Functions
override void	InitializeAddon ()
	called by the Building after the addon has been instantiated and Building has been set
override void	Update ()
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	Add (Building building)
virtual 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
string[]	Targets
Renderer	Renderer
MaterialMode	CopyMaterial
bool	CopyMaterialBlock
bool	CopyProperties
Public Attributes inherited from CityBuilderCore.BuildingAddon
AddonAccumulationMode	Accumulation
bool	Save
bool	Scale
bool	Rotate
Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string	Key

Additional Inherited Members
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.BuildingAddonRenderer.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.BuildingAddonRenderer.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.

Update()

override void CityBuilderCore.BuildingAddonRenderer.Update ( )

inlinevirtual

Reimplemented from CityBuilderCore.BuildingAddon.