Detailed Description
any kind of value a walker might have(items, ...)
Public Member Functions | |
| bool | HasValue (Walker walker) |
| whether the value even applies to the walker in question | |
| float | 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 | |
| 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 | |
Member Function Documentation
◆ GetMaximum()
| float CityBuilderCore.IWalkerValue.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
-
walker the walker in question
- Returns
- max value the walker might ever return
Implemented in CityBuilderCore.Item, CityBuilderCore.ItemCategory, CityBuilderCore.ItemSet, CityBuilderCore.Layer, CityBuilderCore.Risk, CityBuilderCore.RiskCategory, CityBuilderCore.Service, CityBuilderCore.ServiceCategory, CityBuilderCore.ViewWalkerHealthBar, CityBuilderTown.TownViewWalkerEnergyBar, CityBuilderTown.TownViewWalkerFoodBar, and CityBuilderTown.TownViewWalkerWarmthBar.
◆ GetPosition()
| Vector3 CityBuilderCore.IWalkerValue.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
-
walker the walker in question
- Returns
- where the value should be visualized
Implemented in CityBuilderCore.Item, CityBuilderCore.ItemCategory, CityBuilderCore.ItemSet, CityBuilderCore.Layer, CityBuilderCore.Risk, CityBuilderCore.RiskCategory, CityBuilderCore.Service, CityBuilderCore.ServiceCategory, CityBuilderCore.ViewWalkerHealthBar, CityBuilderTown.TownViewWalkerEnergyBar, CityBuilderTown.TownViewWalkerFoodBar, and CityBuilderTown.TownViewWalkerWarmthBar.
◆ GetValue()
| float CityBuilderCore.IWalkerValue.GetValue | ( | Walker | walker | ) |
checks for the value the walker currently has
- Parameters
-
walker the walker of which we want to know the value
- Returns
- the value of the walker
Implemented in CityBuilderCore.Item, CityBuilderCore.ItemCategory, CityBuilderCore.ItemSet, CityBuilderCore.Layer, CityBuilderCore.Risk, CityBuilderCore.RiskCategory, CityBuilderCore.Service, CityBuilderCore.ServiceCategory, CityBuilderCore.ViewWalkerHealthBar, CityBuilderTown.TownViewWalkerEnergyBar, CityBuilderTown.TownViewWalkerFoodBar, and CityBuilderTown.TownViewWalkerWarmthBar.
◆ HasValue()
| bool CityBuilderCore.IWalkerValue.HasValue | ( | Walker | walker | ) |
whether the value even applies to the walker in question
- Parameters
-
walker the walker in question
- Returns
- true when the walker has this value
Implemented in CityBuilderCore.Item, CityBuilderCore.ItemCategory, CityBuilderCore.ItemSet, CityBuilderCore.Layer, CityBuilderCore.Risk, CityBuilderCore.RiskCategory, CityBuilderCore.Service, CityBuilderCore.ServiceCategory, CityBuilderCore.ViewWalkerHealthBar, CityBuilderTown.TownViewWalkerEnergyBar, CityBuilderTown.TownViewWalkerFoodBar, and CityBuilderTown.TownViewWalkerWarmthBar.
