Detailed Description

building component that goes through multiple stages of building before being replaced be the finished building
the building process uses workers and items, the workers can take custom paths in and out of the site

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

Inheritance diagram for CityBuilderCore.MonumentSiteComponent:

Classes
class	MonumentSiteData

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

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

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

ItemQuantity	GetItemsNeeded (Worker worker)
	gets the items a worker has to bring if any

float	GetWorkerNeed (Worker worker)
	how much the user needs a worker, makes sure users who already have a worker on site have lower priority

void	ReportAssigned (WorkerWalker walker)
	worker has been assigned to the user and will start walking there

Vector3[]	ReportArrived (WorkerWalker walker)
	worker has arrived at the user and receives his path into the user(optional)

void	ReportInside (WorkerWalker walker)
	if a path inside was returned on arrival the worker will report inside after following that path

IEnumerable< Worker >	GetAssigned ()
	gets which workers are assigned but have not arrived at the user does not contain empty entries like queued and working

IEnumerable< Worker >	GetQueued ()
	gets the queue slots in its entire length, null for unfilled slots

IEnumerable< Worker >	GetWorking ()
	gets the worker slots in its entire length, null for unfilled slots

override string	SaveData ()
	serializes the objects state(usually to json) and returns it

override void	LoadData (string json)
	deserializes the serialized json data and loads the data as its new state

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

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	GetDebugText ()
	returns text that gets displayed for debugging in the scene editor

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

Public Attributes
Building	Monument

MonumentStage[]	Stages

Properties
override string	Key `[get]`
	unique key used to identify the component in save/load

MonumentStage	CurrentStage `[get]`

BuildingComponentReference< IWorkerUser >	Reference `[get, set]`

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.IBuildingTrait< IWorkerUser >
BuildingComponentReference< T >	Reference `[get, set]`
	reference to the building trait, use when the building might be replaced and when the reference has to be saved

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

Member Function Documentation

◆ GetAssigned()

IEnumerable< Worker > CityBuilderCore.MonumentSiteComponent.GetAssigned ( )

gets which workers are assigned but have not arrived at the user
does not contain empty entries like queued and working

Returns

Implements CityBuilderCore.IWorkerUser.

◆ GetItemsNeeded()

ItemQuantity CityBuilderCore.MonumentSiteComponent.GetItemsNeeded ( Worker worker )

gets the items a worker has to bring if any

Parameters

worker

Returns

Implements CityBuilderCore.IWorkerUser.

◆ GetQueued()

IEnumerable< Worker > CityBuilderCore.MonumentSiteComponent.GetQueued ( )

gets the queue slots in its entire length, null for unfilled slots

Returns

Implements CityBuilderCore.IWorkerUser.

◆ GetWorkerNeed()

float CityBuilderCore.MonumentSiteComponent.GetWorkerNeed ( Worker worker )

how much the user needs a worker, makes sure users who already have a worker on site have lower priority

Parameters

worker

Returns

Implements CityBuilderCore.IWorkerUser.

◆ GetWorking()

IEnumerable< Worker > CityBuilderCore.MonumentSiteComponent.GetWorking ( )

gets the worker slots in its entire length, null for unfilled slots

Returns

Implements CityBuilderCore.IWorkerUser.

◆ InitializeComponent()

override void CityBuilderCore.MonumentSiteComponent.InitializeComponent ( )

inlinevirtual

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

Reimplemented from CityBuilderCore.BuildingComponent.

◆ LoadData()

override void CityBuilderCore.MonumentSiteComponent.LoadData ( string json )

inlinevirtual

deserializes the serialized json data and loads the data as its new state

Parameters

json

Reimplemented from CityBuilderCore.BuildingComponent.

◆ OnReplacing()

override void CityBuilderCore.MonumentSiteComponent.OnReplacing ( IBuilding replacement )

inlinevirtual

called when a component gets replaced
use to transfer resources, replace references

Parameters

replacement

Reimplemented from CityBuilderCore.BuildingComponent.

◆ ReportArrived()

Vector3[] CityBuilderCore.MonumentSiteComponent.ReportArrived ( WorkerWalker walker )

worker has arrived at the user and receives his path into the user(optional)

Parameters

walker

Returns

Implements CityBuilderCore.IWorkerUser.

◆ ReportAssigned()

void CityBuilderCore.MonumentSiteComponent.ReportAssigned ( WorkerWalker walker )

worker has been assigned to the user and will start walking there

Parameters

walker

Implements CityBuilderCore.IWorkerUser.

◆ ReportInside()

void CityBuilderCore.MonumentSiteComponent.ReportInside ( WorkerWalker walker )

if a path inside was returned on arrival the worker will report inside after following that path

Parameters

walker

Implements CityBuilderCore.IWorkerUser.

◆ SaveData()

override string CityBuilderCore.MonumentSiteComponent.SaveData ( )

inlinevirtual

serializes the objects state(usually to json) and returns it

Returns: serialized save data

Reimplemented from CityBuilderCore.BuildingComponent.

◆ TerminateComponent()

override void CityBuilderCore.MonumentSiteComponent.TerminateComponent ( )

inlinevirtual

termination is performed when the building is destroyed
use to deregister traits, remove references from other systems

Reimplemented from CityBuilderCore.BuildingComponent.

Property Documentation

◆ Key

override string CityBuilderCore.MonumentSiteComponent.Key

get

unique key used to identify the component in save/load

Implements CityBuilderCore.IBuildingComponent.

Detailed Description

Classes

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Member Function Documentation

◆ GetAssigned()

◆ GetItemsNeeded()

◆ GetQueued()

◆ GetWorkerNeed()

◆ GetWorking()

◆ InitializeComponent()

◆ LoadData()

◆ OnReplacing()

◆ ReportArrived()

◆ ReportAssigned()

◆ ReportInside()

◆ SaveData()

◆ TerminateComponent()

Property Documentation

◆ Key