Loading...
Searching...
No Matches
CityBuilderCore.RiskCategory Class Reference

Detailed Description

bundels of risks for whenever instead of a specific risk just a general type of risk is needed
useful mainly for views and visualizations that encompass multiple risks

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

Inheritance diagram for CityBuilderCore.RiskCategory:
CityBuilderCore.KeyedObject CityBuilderCore.IBuildingValue CityBuilderCore.IWalkerValue CityBuilderCore.IKeyed

Public Member Functions

bool Contains (Risk risk)
 
string GetName (int quantity)
 
bool HasValue (IBuilding building)
 whether the value even applies to the building in question
 
float GetMaximum (IBuilding building)
 the maximum value this value may get to
important for bars that use a ratio
 
float GetValue (IBuilding building)
 checks for the value the building currently has
 
Vector3 GetPosition (IBuilding building)
 the world position that the value should be visualized at
especially relevant for global values that are not created as a child of the building
 
bool HasValue (Walker walker)
 whether the value even applies to the walker in question
 
float GetMaximum (Walker _)
 the maximum value this value may get to
for example storage capacity for item quantities
important for bars that use a ratio
 
float GetValue (Walker walker)
 checks for the value the walker currently has
 
Vector3 GetPosition (Walker walker)
 the world position that the value should be visualized at
especially relevant for global values that are not created as a child of the walker
 

Public Attributes

string NameSingular
 
string NamePlural
 
Risk[] Risks
 
- Public Attributes inherited from CityBuilderCore.KeyedObject
string Key
 

Additional Inherited Members

- Static Public Member Functions inherited from CityBuilderCore.KeyedObject
static T GetKeyedObject< T > (string key)
 
- Properties inherited from CityBuilderCore.IKeyed

Member Function Documentation

◆ GetMaximum() [1/2]

float CityBuilderCore.RiskCategory.GetMaximum ( IBuilding building)

the maximum value this value may get to
important for bars that use a ratio

Parameters
buildingthe building in question
Returns
max value the building might ever return

Implements CityBuilderCore.IBuildingValue.

◆ GetMaximum() [2/2]

float CityBuilderCore.RiskCategory.GetMaximum ( Walker walker)

the maximum value this value may get to
for example storage capacity for item quantities
important for bars that use a ratio

Parameters
walkerthe walker in question
Returns
max value the walker might ever return

Implements CityBuilderCore.IWalkerValue.

◆ GetPosition() [1/2]

Vector3 CityBuilderCore.RiskCategory.GetPosition ( IBuilding building)

the world position that the value should be visualized at
especially relevant for global values that are not created as a child of the building

Parameters
buildingthe building in question
Returns
where the value should be visualized

Implements CityBuilderCore.IBuildingValue.

◆ GetPosition() [2/2]

Vector3 CityBuilderCore.RiskCategory.GetPosition ( Walker walker)

the world position that the value should be visualized at
especially relevant for global values that are not created as a child of the walker

Parameters
walkerthe walker in question
Returns
where the value should be visualized

Implements CityBuilderCore.IWalkerValue.

◆ GetValue() [1/2]

float CityBuilderCore.RiskCategory.GetValue ( IBuilding building)

checks for the value the building currently has

Parameters
buildingthe building of which we want to know the value
Returns
the value of the building

Implements CityBuilderCore.IBuildingValue.

◆ GetValue() [2/2]

float CityBuilderCore.RiskCategory.GetValue ( Walker walker)

checks for the value the walker currently has

Parameters
walkerthe walker of which we want to know the value
Returns
the value of the walker

Implements CityBuilderCore.IWalkerValue.

◆ HasValue() [1/2]

bool CityBuilderCore.RiskCategory.HasValue ( IBuilding building)

whether the value even applies to the building in question

Parameters
buildingthe building in question
Returns
true when the building has this value

Implements CityBuilderCore.IBuildingValue.

◆ HasValue() [2/2]

bool CityBuilderCore.RiskCategory.HasValue ( Walker walker)

whether the value even applies to the walker in question

Parameters
walkerthe walker in question
Returns
true when the walker has this value

Implements CityBuilderCore.IWalkerValue.