Detailed Description
scriptable object that describes the properties of an item
Public Member Functions | |
| 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 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 | |
| int | GetGlobalQuantity () |
| int | GetStoredQuantity () |
| int | GetBuildingOwnedQuantity () |
| int | GetWalkerOwnedQuantity () |
Public Attributes | |
| string | Name |
| int | Priority |
| int | UnitSize = 1 |
| Sprite | Icon |
| Material | Material |
| StorageQuantityVisual[] | Visuals |
 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.Item.GetMaximum | ( | IBuilding | building | ) |
the maximum value this value may get to
important for bars that use a ratio
- Parameters
-
building the building in question
- Returns
- max value the building might ever return
Implements CityBuilderCore.IBuildingValue.
◆ GetMaximum() [2/2]
| float CityBuilderCore.Item.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
Implements CityBuilderCore.IWalkerValue.
◆ GetPosition() [1/2]
| Vector3 CityBuilderCore.Item.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
-
building the building in question
- Returns
- where the value should be visualized
Implements CityBuilderCore.IBuildingValue.
◆ GetPosition() [2/2]
| Vector3 CityBuilderCore.Item.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
Implements CityBuilderCore.IWalkerValue.
◆ GetValue() [1/2]
| float CityBuilderCore.Item.GetValue | ( | IBuilding | building | ) |
checks for the value the building currently has
- Parameters
-
building the building of which we want to know the value
- Returns
- the value of the building
Implements CityBuilderCore.IBuildingValue.
◆ GetValue() [2/2]
| float CityBuilderCore.Item.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
Implements CityBuilderCore.IWalkerValue.
◆ HasValue() [1/2]
| bool CityBuilderCore.Item.HasValue | ( | IBuilding | building | ) |
whether the value even applies to the building in question
- Parameters
-
building the building in question
- Returns
- true when the building has this value
Implements CityBuilderCore.IBuildingValue.
◆ HasValue() [2/2]
| bool CityBuilderCore.Item.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
Implements CityBuilderCore.IWalkerValue.
