Loading...
Searching...
No Matches
CityBuilderCore.IProgressComponent Interface Reference

Detailed Description

building component that has come kind of progress
common interface so different progressors can use the same visualizers

Inheritance diagram for CityBuilderCore.IProgressComponent:
CityBuilderCore.IBuildingComponent CityBuilderCore.ISaveData CityBuilderCore.IGenerationComponent CityBuilderCore.IProductionComponent CityBuilderCore.ProgressComponent CityBuilderCore.VariantProductionComponent CityBuilderCore.GenerationComponent CityBuilderCore.ProductionComponent CityBuilderCore.VariantProductionComponent CityBuilderCore.GenerationComponent CityBuilderCore.ProductionComponent CityBuilderCore.VariantProductionWalkerComponent CityBuilderCore.ProductionWalkerComponent CityBuilderTown.TownProductionComponent CityBuilderCore.VariantProductionWalkerComponent CityBuilderCore.ProductionWalkerComponent CityBuilderTown.TownProductionComponent

Properties

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
 

Events

Action ProgressReset
 progress has finished and is reset to 0
 
Action< float > ProgressChanged
 progress has changed, carries new progress
 

Additional Inherited Members

- 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
 

Property Documentation

◆ Progress

float CityBuilderCore.IProgressComponent.Progress
get