CityBuilderCore.LayerModifierHappening Class Reference

Detailed Description

an event that, during its activity, globally modifies a layers values
might be used for weather or seasons(heat, fertility, ...)

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

Inheritance diagram for CityBuilderCore.LayerModifierHappening:

Public Member Functions
override void	Activate ()
	called whenever the happening becomes active, this may be when the happening starts or when a game is loaded at a time when the happening is active used for ongoing stuff like modifers to layers and services or for visuals like rain particles
override void	Deactivate ()
	called whenever the happening becomes inactive, this may be when the happening ends or when a game is unloaded used to reset ongoing stuff from Activate
int	Modify (int value)
	takes the unmodified value and returns the modified one
Public Member Functions inherited from CityBuilderCore.TimingHappening
virtual void	Start ()
	called when the happening first starts, meaning when its condition switches from being false to true use for thing that persist on their own like adding items to buildings or changing risk values the difference to Activate is that start will not be called again when the game is loaded
virtual void	End ()
	called when the happening first end, meaning when its condition switches from bein true to being false the difference to Deactivate is that end will not be called again when the game is unloaded

Public Attributes
Layer	Layer
float	Multiplier = 1f
int	Addend
Public Attributes inherited from CityBuilderCore.TimingHappening
string	Name
string	StartTitle
string	StartDescription
string	EndTitle
string	EndDescription

Events
Action< ILayerModifier >	Changed
Events inherited from CityBuilderCore.ILayerModifier
Action< ILayerModifier >	Changed
	event the modifier has to fire when it changes how it modifies the layer

Additional Inherited Members

Properties inherited from CityBuilderCore.ILayerModifier

Member Function Documentation

Activate()

override void CityBuilderCore.LayerModifierHappening.Activate ( )

inlinevirtual

called whenever the happening becomes active, this may be when the happening starts or when a game is loaded at a time when the happening is active used for ongoing stuff like modifers to layers and services or for visuals like rain particles

Reimplemented from CityBuilderCore.TimingHappening.

Deactivate()

override void CityBuilderCore.LayerModifierHappening.Deactivate ( )

inlinevirtual

called whenever the happening becomes inactive, this may be when the happening ends or when a game is unloaded
used to reset ongoing stuff from Activate

Reimplemented from CityBuilderCore.TimingHappening.

Modify()

int CityBuilderCore.LayerModifierHappening.Modify ( int value )

inline

takes the unmodified value and returns the modified one

Parameters

value

the layer value before modification

Returns

the modified value

Implements CityBuilderCore.ILayerModifier.