CityBuilderCore.GenerationComponent Class Reference

Detailed Description

building component that periodically generates items(speed influenced by efficiency)

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

Inheritance diagram for CityBuilderCore.GenerationComponent:

Classes
class	GenerationData

Public Types
enum	GenerationState { Generating , Done }

Public Member Functions
override void	OnReplacing (IBuilding replacement)
	called when a component gets replaced use to transfer resources, replace references
void	Collect (ItemStorage storage, Item[] items)
	moves certain generated items from the component to the passed storage
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.ProgressComponent
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	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

Public Attributes
ItemProducer[]	ItemsProducers
Public Attributes inherited from CityBuilderCore.ProgressComponent
float	ProgressInterval
BoolEvent	IsProgressing

Properties
override string	Key [get]
	unique key used to identify the component in save/load
IItemContainer	ItemContainer [get]
	holds and manages the items for the owner
Properties inherited from CityBuilderCore.ProgressComponent
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
Properties inherited from CityBuilderCore.IGenerationComponent
Properties inherited from CityBuilderCore.IItemOwner

Additional Inherited Members
Protected Member Functions inherited from CityBuilderCore.ProgressComponent
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
Protected Attributes inherited from CityBuilderCore.ProgressComponent
float	_progressTime
Events inherited from CityBuilderCore.ProgressComponent
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

Collect()

void CityBuilderCore.GenerationComponent.Collect ( ItemStorage storage, Item[] items )

inline

moves certain generated items from the component to the passed storage

Parameters

storage	storage that gets the items
items	the items that can be moved

Implements CityBuilderCore.IGenerationComponent.

LoadData()

override void CityBuilderCore.GenerationComponent.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.GenerationComponent.OnReplacing ( IBuilding replacement )

inlinevirtual

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

Parameters

replacement

Reimplemented from CityBuilderCore.BuildingComponent.

SaveData()

override string CityBuilderCore.GenerationComponent.SaveData ( )

inlinevirtual

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

Returns

serialized save data

Reimplemented from CityBuilderCore.BuildingComponent.

Property Documentation

ItemContainer

IItemContainer CityBuilderCore.GenerationComponent.ItemContainer

get

holds and manages the items for the owner

Implements CityBuilderCore.IItemOwner.

Key

override string CityBuilderCore.GenerationComponent.Key

get

unique key used to identify the component in save/load

Implements CityBuilderCore.IBuildingComponent.