Detailed Description

base class for building components implementing IProgressComponent
basically any component that progresses over time, does something and resets

Inheritance diagram for CityBuilderCore.ProgressComponent:

Public Member Functions
override string	GetDebugText ()
	returns text that gets displayed for debugging in the scene editor

override void	InitializeComponent ()
	initialization is performed when the building is placed or loaded use to create references, register traits, ...

Public Member Functions inherited from CityBuilderCore.BuildingComponent
virtual void	SetupComponent ()
	only called when the building is originally placed, before Initialize

virtual void	OnReplacing (IBuilding replacement)
	called when a component gets replaced use to transfer resources, replace references

virtual void	TerminateComponent ()
	termination is performed when the building is destroyed use to deregister traits, remove references from other systems

virtual void	OnMoving ()
	called when the building is about to be moved can be used to remove/deregister stuff from the old position

virtual void	OnMoved (Vector2Int oldPoint, BuildingRotation oldRotation)
	called after a building has been moved can be used to register things at the new position

virtual void	SuspendComponent ()
	temporarily stops the component from working

virtual void	ResumeComponent ()
	resumes work in the component after SuspendComponent has been called

virtual string	GetDescription ()
	gets displayed in dialogs to show the component status to players

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

Protected Member Functions
bool	addProgress (float multiplier)

void	resetProgress ()

Protected Member Functions inherited from CityBuilderCore.BuildingComponent
T	getOther< T > ()
	gets the first building component of the specified type on the same building

IEnumerable< T >	getOthers< T > ()
	gets all building components of the specified type on the same building

BuildingComponentReference< T >	registerTrait< T > (T trait)
	registers the building component as a trait so it is globally accessible usually done in InitializeComponent

void	replaceTrait< T > (T trait, T replacement)
	replaces the reference a trait points to in the global manager done when a building is replaced(OnReplacing(IBuilding)) so the trait now points to the new component instead of the one that has been removed

void	deregisterTrait< T > (T trait)
	removes a previously registered trait usually when a building is removed which calls TerminateComponent

Properties
float	Progress `[get]`
	progress from 0 to 1

Properties inherited from CityBuilderCore.BuildingComponent
string	Key `[get]`
	unique key used to identify the component in save/load

IBuilding	Building `[get, set]`
	the building the component is attached to is set by the building in awake

Properties inherited from CityBuilderCore.IBuildingComponent
Properties inherited from CityBuilderCore.IProgressComponent

Events
Action	ProgressReset

Action< float >	ProgressChanged

Events inherited from CityBuilderCore.IProgressComponent
Action	ProgressReset
	progress has finished and is reset to 0

Action< float >	ProgressChanged
	progress has changed, carries new progress

Member Function Documentation

override string CityBuilderCore.ProgressComponent.GetDebugText ( )

virtual

returns text that gets displayed for debugging in the scene editor

override void CityBuilderCore.ProgressComponent.InitializeComponent ( )

inlinevirtual

initialization is performed when the building is placed or loaded
use to create references, register traits, ...

float CityBuilderCore.ProgressComponent.Progress

get

progress from 0 to 1