CityBuilderCore.BuildingAddonEffect Class Reference

Detailed Description

blank building addon that can be used to attach particle effects for example
removal is either done when the building is replaced(Evolution went through) or from the outside(evolution canceled)

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

Inheritance diagram for CityBuilderCore.BuildingAddonEffect:

Public Member Functions
override void	Update ()
override 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 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 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	RemoveOnReplace
Vector3	Rotation
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

OnReplacing()

override void CityBuilderCore.BuildingAddonEffect.OnReplacing ( Transform parent, IBuilding replacement )

inlinevirtual

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

Parameters

parent
replacement

Reimplemented from CityBuilderCore.BuildingAddon.

Update()

override void CityBuilderCore.BuildingAddonEffect.Update ( )

inlinevirtual

Reimplemented from CityBuilderCore.BuildingAddon.