CityBuilderCore.IServiceRecipient Interface Reference

Detailed Description

building components that have services that can be filled by a RiskWalker

Inheritance diagram for CityBuilderCore.IServiceRecipient:

Public Member Functions
bool	HasServiceValue (Service service)
	whether the recipient handles a particular serviec for example a bar visualization should not be created on a building that does not even have the service that is visualized
float	GetServiceValue (Service service)
	check how much service value is left in the recipient
void	ModifyService (Service service, float amount)
	changes a services value in the recipient services have to be increased regularly or access will be lost
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

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

Member Function Documentation

GetServiceValue()

float CityBuilderCore.IServiceRecipient.GetServiceValue

(

Service

service

)

check how much service value is left in the recipient

Parameters

service

the service for which we want the value

Returns

value in percent of much is left before service access is lost

Implemented in CityBuilderCore.EvolutionComponent, and CityBuilderCore.ServiceEfficiencyComponent.

HasServiceValue()

bool CityBuilderCore.IServiceRecipient.HasServiceValue

(

Service

service

)

whether the recipient handles a particular serviec
for example a bar visualization should not be created on a building that does not even have the service that is visualized

Parameters

service

the service to check

Returns

true if the service is present in the recipient

Implemented in CityBuilderCore.EvolutionComponent, and CityBuilderCore.ServiceEfficiencyComponent.

ModifyService()

void CityBuilderCore.IServiceRecipient.ModifyService	(	Service	service,
		float	amount )

changes a services value in the recipient
services have to be increased regularly or access will be lost

Parameters

service	the service that will have its value changed
amount	positive to refill the service, negative to bring down closer to losing access

Implemented in CityBuilderCore.EvolutionComponent, and CityBuilderCore.ServiceEfficiencyComponent.