Function Value
Redirect page
Redirect to:
Overview of all function values
Assets and visualisation
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Image | (Property of function value) | Image (png, 200x100) | The image used to represent this function. This property is currently unused. | |
| Roof Color | ROOF_COLOR | color | The color of the roof of a construction. For flat constructions (such as gardens and roads), it is also the color of the ground surface. | |
| Ground Color | GROUND_COLOR | color | The color of the walls of the bottom floor of a construction. | |
| Extra Color | EXTRA_COLOR | color | The color of the walls of the floors of the construction which are neither the top nor bottom floor. | |
| Top Color | TOP_COLOR | color | The color of the walls of the top floor of a construction, unless that floor is also the bottom floor. | |
| Description | (Property of function value) | text | The textual description of this function, which is displayed to the user when using this function as as action. |
Construction
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Category weight | CATEGORY_WEIGHT | weight | Yes | How much of a construction of this function is classified under the specified category. |
| Construction time in months | CONSTRUCTION_TIME_IN_MONTHS | months | How long it takes to construct a construction of this function during a timeline session. | |
| Default floors | DEFAULT_FLOORS | integer | How many floors a construction of this function will have by default, unless otherwise specified. This values must always be in the range of min floors and max floors (inclusive). | |
| Demolish time in months | DEMOLISH_TIME_IN_MONTHS | months | How long it takes to demolish a construction of this functon during a timeline session. | |
| Floating | FLOATING | boolean | Whether this construction should be visualized with a "floating" animation, as if on water. | |
| Floor height m | FLOOR_HEIGHT_M | m | The height of each floor of the construction. | |
| Max floors | MAX_FLOORS | integer | The maximum amount of floors this construction (or any of its sections) can have. This also limits how many floors a construction can have when used as an action during a session. | |
| Min floors | MIN_FLOORS | integer | The minimum amount of floors this construction (or any of its sections) should have. This also limits how many floors a construction must have when used as an action during a session. | |
| Monumental | MONUMENTAL | boolean | Whether this construction is monumental. Projects can be set up so that monumental constructions enjoy special protections or have additional qualitative value. | |
| Slanting roof height | SLANTING_ROOF_HEIGHT | m | How high the slanting roof at the top of the construction should be visualized at its peak. The roof will slant inwards equally from all sides. | |
| Unit size | UNIT_SIZE_M2 | m²/unit | Yes | How large a single housing unit within this construction is. This is only relevant for residential categories. |
| Zoning permit required | ZONING_PERMIT_REQUIRED | boolean | Whether the municipal stakholder should be requested permission, when another user uses this function as an action to plan a new construction during a session |
Environment
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Critical infrastructure | CRITICAL_INFRASTRUCTURE | boolean | Whether this construction counts as critical for Water Overlay calculations. See also: Critical structure (Water Overlay) | |
| Distance zone | DISTANCE_ZONE_M | m | ||
| Disturbance distance | DISTURBANCE_DISTANCE_M | m | ||
| Green space | GREEN_M2 | m²/m² | ||
| Heat effect | HEAT_EFFECT | decimal | ||
| Livability effect | LIVABILITY_EFFECT | decimal | ||
| Safety distance | SAFETY_DISTANCE_M | m |
Financial
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Buyout cost | BUYOUT_COST_M2 | currency/m² | Yes | |
| Construction cost | CONSTRUCTION_COST_M2 | currency/m² | Yes | |
| Demolition cost | DEMOLISH_COST_M2 | currency/m² | Yes | |
| Sell price | SELL_PRICE_M2 | currency/m² | Yes |
Network
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Heat flow change per year | HEAT_FLOW_M2_CHANGE_PER_YEAR | m²/year | Yes | |
| Heat flow formula start year | HEAT_FLOW_M2_START_YEAR | year | Yes | |
| Heat flow to power multiplier | HEAT_POWER_TO_FLOW_MULTIPLIER | factor | Yes | |
| Heat flow value at start year | HEAT_FLOW_M2_START_VALUE | m² | Yes | |
| Pipes permitted | PIPES_PERMITTED | boolean |
Traffic
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Height offset | HEIGHT_OFFSET_M | m | ||
| Lanes | TRAFFIC_LANES | integer | ||
| Noise sigma | TRAFFIC_NOISE_SIGMA | |||
| Noise tau | TRAFFIC_NOISE_TAU | |||
| Parking lots | PARKING_LOTS_PER_M2 | parking lot/m² | Yes | |
| Parking lots demand | PARKING_LOTS_DEMAND_PER_M2 | parking lot/m² | Yes | |
| Speedlimit | TRAFFIC_SPEED | km/h | ||
| Units per hour | TRAFFIC_FLOW | vehicles/h |
Water
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| Connected top sewer area | SEWERED | boolean | ||
| Depth of plant roots | ROOT_DEPTH_M | m | ||
| Drainage | DRAINAGE | boolean, or m | ||
| Ground infiltration per day | GROUND_INFILTRATION_MD | m/day | ||
| Manning value | WATER_MANNING | s/(m1/3) | ||
| Water evaporation | WATER_EVAPORATION_FACTOR | factor | ||
| Water storage | WATER_STORAGE_M2 | m³/m² |
Attributes
| Function value | Attribute | Unit | Per category | Description |
|---|---|---|---|---|
| (user defined) | (user defined) |