CityBuilderCore.BuildingAddonTransformer Class Reference

Detailed Description

addon that transfers its scale and rotation to the attached building
this can be used to attach animations to any building by animating the addon

in THREE this is used to make buildings pop up with an animation when they are built
to make this happen a BuildingAddonTransform with an animation is assigned to DefaultBuildingManager.AddingAddon

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

Inheritance diagram for CityBuilderCore.BuildingAddonTransformer:

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)
override void	Update ()
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	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

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...
Public Attributes inherited from CityBuilderCore.BuildingAddon
AddonAccumulationMode	Accumulation
bool	Save
bool	Center
bool	Scale
Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string	Key
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.BuildingAddonTransformer.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.BuildingAddonTransformer.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.BuildingAddonTransformer.Update ( )

inlinevirtual

Reimplemented from CityBuilderCore.BuildingAddon.