Detailed Description

a building component that generates items

Inheritance diagram for CityBuilderCore.IGenerationComponent:

Public Member Functions
void	Collect (ItemStorage storage, Item[] items)
	moves certain generated items from the component to the passed storage

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

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

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

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

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

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

void	SuspendComponent ()
	temporarily stops the component from working

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

string	GetDebugText ()
	text displayed in scene editor

string	GetDescription ()
	text that may be displayed in dialogs

Public Member Functions inherited from CityBuilderCore.ISaveData
string	SaveData ()
	serializes the objects state(usually to json) and returns it

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

Properties
ItemProducer[]	ItemsProducers `[get]`
	exposes the different producers of the generator so they can be visualized

Properties inherited from CityBuilderCore.IProgressComponent
float	Progress `[get]`
	progress from 0 to 1

Properties inherited from CityBuilderCore.IBuildingComponent
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.IItemOwner
IItemContainer	ItemContainer `[get]`
	holds and manages the items for the owner

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

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

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