CityBuilderCore.WalkerAddonRenderer Class Reference

Detailed Description

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

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

Inheritance diagram for CityBuilderCore.WalkerAddonRenderer:

Public Types
enum	MaterialMode { Replace , Add , None }

Public Member Functions
override void	InitializeAddon ()
	called by the walker after the addon has been instantiated and Walker has been set
override void	Update ()
override void	TerminateAddon ()
	called by the walker when the addon gets removed this should usually terminate the addon(mark as terminated and Destroy)
Public Member Functions inherited from CityBuilderCore.WalkerAddon
virtual void	Awake ()
virtual void	Start ()
void	Remove ()
	Removes the addon from the walker it is located on this will usually result in the termination of the addon.
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
bool	InitializeHidden
Public Attributes inherited from CityBuilderCore.WalkerAddon
BuildingAddon.AddonAccumulationMode	Accumulation
bool	Save
Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string	Key

Additional Inherited Members
Protected Attributes inherited from CityBuilderCore.WalkerAddon
bool	_isTerminated
Properties inherited from CityBuilderCore.WalkerAddon
Walker	Walker [get, set]
Properties inherited from CityBuilderCore.IKeyed

Member Function Documentation

InitializeAddon()

override void CityBuilderCore.WalkerAddonRenderer.InitializeAddon ( )

inlinevirtual

called by the walker after the addon has been instantiated and Walker has been set

Reimplemented from CityBuilderCore.WalkerAddon.

TerminateAddon()

override void CityBuilderCore.WalkerAddonRenderer.TerminateAddon ( )

inlinevirtual

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

Reimplemented from CityBuilderCore.WalkerAddon.

Update()

override void CityBuilderCore.WalkerAddonRenderer.Update ( )

inlinevirtual

Reimplemented from CityBuilderCore.WalkerAddon.