Detailed Description

base class for building components implementing IBuildingComponent

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

Inheritance diagram for CityBuilderCore.BuildingComponent:

Public Member Functions
virtual void	SetupComponent ()
	only called when the building is originally placed, before Initialize

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

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	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

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
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
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

Member Function Documentation

◆ deregisterTrait< T >()

void CityBuilderCore.BuildingComponent.deregisterTrait< T > ( T trait )

inlineprotected

removes a previously registered trait
usually when a building is removed which calls TerminateComponent

Template Parameters

T

Parameters

trait

Type Constraints

T

:

IBuildingTrait<T>

◆ GetDebugText()

virtual string CityBuilderCore.BuildingComponent.GetDebugText ( )

virtual

returns text that gets displayed for debugging in the scene editor

Returns: a debugging string or null

Implements CityBuilderCore.IBuildingComponent.

Reimplemented in CityBuilderCore.AttackableComponent, CityBuilderCore.CollectionComponent, CityBuilderCore.DistributionComponent, CityBuilderCore.EmploymentComponent, CityBuilderCore.ItemsRetrieverComponent, CityBuilderCore.ProgressComponent, CityBuilderCore.StorageComponent, CityBuilderCore.VariantProductionComponent, CityBuilderTown.TownHomeComponent, and CityBuilderTown.TownMarketComponent.

◆ GetDescription()

virtual string CityBuilderCore.BuildingComponent.GetDescription ( )

virtual

gets displayed in dialogs to show the component status to players

Returns: a descriptive string or an empty one

Implements CityBuilderCore.IBuildingComponent.

Reimplemented in CityBuilderCore.EmploymentComponent, CityBuilderCore.EvolutionComponent, and CityBuilderCore.HousingComponent.

◆ getOther< T >()

T CityBuilderCore.BuildingComponent.getOther< T > ( )

protected

gets the first building component of the specified type on the same building

Template Parameters

T	type of the building component to return

Returns: a building component if one is found

Type Constraints

T	:	class
T	:	IBuildingComponent

◆ getOthers< T >()

IEnumerable< T > CityBuilderCore.BuildingComponent.getOthers< T > ( )

protected

gets all building components of the specified type on the same building

Template Parameters

T	type of the building components to return

Returns: any building components on the same building that match the type

Type Constraints

T	:	class
T	:	IBuildingComponent

◆ InitializeComponent()

virtual void CityBuilderCore.BuildingComponent.InitializeComponent ( )

inlinevirtual

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

Implements CityBuilderCore.IBuildingComponent.

◆ LoadData()

virtual void CityBuilderCore.BuildingComponent.LoadData ( string json )

inlinevirtual

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

Parameters

json

Implements CityBuilderCore.ISaveData.

◆ OnMoved()

virtual void CityBuilderCore.BuildingComponent.OnMoved	(	Vector2Int	oldPoint,
		BuildingRotation	oldRotation )

inlinevirtual

called after a building has been moved
can be used to register things at the new position

Parameters

oldPoint	point of the building before moving
oldRotation	rotation of the building before moving

Implements CityBuilderCore.IBuildingComponent.

◆ OnMoving()

virtual void CityBuilderCore.BuildingComponent.OnMoving ( )

inlinevirtual

called when the building is about to be moved
can be used to remove/deregister stuff from the old position

Implements CityBuilderCore.IBuildingComponent.

◆ OnReplacing()

virtual void CityBuilderCore.BuildingComponent.OnReplacing ( IBuilding replacement )

inlinevirtual

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

Parameters

replacement

Implements CityBuilderCore.IBuildingComponent.

◆ registerTrait< T >()

BuildingComponentReference< T > CityBuilderCore.BuildingComponent.registerTrait< T > ( T trait )

inlineprotected

registers the building component as a trait so it is globally accessible
usually done in InitializeComponent

Template Parameters

T	trait type to register, the building component or an interface it implements

Parameters

trait object that will be registered, almost always this building component

Returns

Type Constraints

T

:

IBuildingTrait<T>

◆ replaceTrait< T >()

void CityBuilderCore.BuildingComponent.replaceTrait< T >	(	T	trait,
		T	replacement )

inlineprotected

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

Template Parameters

T

Parameters

trait
replacement

Type Constraints

T

:

IBuildingTrait<T>

◆ ResumeComponent()

virtual void CityBuilderCore.BuildingComponent.ResumeComponent ( )

inlinevirtual

resumes work in the component after SuspendComponent has been called

Implements CityBuilderCore.IBuildingComponent.

Reimplemented in CityBuilderCore.RoadBlockerComponent, CityBuilderTown.TownFarmingComponent, CityBuilderTown.TownMarketComponent, CityBuilderTown.TownProductionComponent, and CityBuilderTown.TownWorkComponent.

◆ SaveData()

virtual string CityBuilderCore.BuildingComponent.SaveData ( )

virtual

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

Returns: serialized save data

Implements CityBuilderCore.ISaveData.

◆ SetupComponent()

virtual void CityBuilderCore.BuildingComponent.SetupComponent ( )

inlinevirtual

only called when the building is originally placed, before Initialize

Implements CityBuilderCore.IBuildingComponent.

Reimplemented in CityBuilderTown.TownConstructionComponent.

◆ SuspendComponent()

virtual void CityBuilderCore.BuildingComponent.SuspendComponent ( )

inlinevirtual

temporarily stops the component from working

Implements CityBuilderCore.IBuildingComponent.

Reimplemented in CityBuilderCore.HousingComponent, CityBuilderCore.RoadBlockerComponent, CityBuilderTown.TownConstructionComponent, CityBuilderTown.TownFarmingComponent, CityBuilderTown.TownForestingComponent, CityBuilderTown.TownGatheringComponent, CityBuilderTown.TownHomeComponent, CityBuilderTown.TownMarketComponent, CityBuilderTown.TownProductionComponent, and CityBuilderTown.TownWorkComponent.

◆ TerminateComponent()

virtual void CityBuilderCore.BuildingComponent.TerminateComponent ( )

inlinevirtual

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

Implements CityBuilderCore.IBuildingComponent.

Property Documentation

◆ Building

IBuilding CityBuilderCore.BuildingComponent.Building

getset

the building the component is attached to
is set by the building in awake

Implements CityBuilderCore.IBuildingComponent.

◆ Key

string CityBuilderCore.BuildingComponent.Key

getabstract

unique key used to identify the component in save/load

Implements CityBuilderCore.IBuildingComponent.

Detailed Description

Public Member Functions

Protected Member Functions

Properties

Member Function Documentation

◆ deregisterTrait< T >()

◆ GetDebugText()

◆ GetDescription()

◆ getOther< T >()

◆ getOthers< T >()

◆ InitializeComponent()

◆ LoadData()

◆ OnMoved()

◆ OnMoving()

◆ OnReplacing()

◆ registerTrait< T >()

◆ replaceTrait< T >()

◆ ResumeComponent()

◆ SaveData()

◆ SetupComponent()

◆ SuspendComponent()

◆ TerminateComponent()

Property Documentation

◆ Building

◆ Key