Function Value: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(99 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{stub}}
Function values are specific values which form the general properties of any [[building]] with a specific [[function]]. A function has many function values, and any building of that function also has those function values.
Function values are specific values which form the general properties of any [[construction]] with a specific function. A function has many function values, and any construction of that function also has those function values.


Function values can be changed for an individual construction, or for a function, which in turn would affect all constructions of that function.
Function values can be changed for an individual building, or for a function, which in turn would affect all buildings of that function.
 
===Overwrites===
Function Values can be defined on several levels. Primarily, they can be defined on [[Functions]]. The Function Values of Functions can be overwritten by adding them to the [[How to add Functions for editing|Function Values Table]]. Additionally, a Function can be duplicated, and that new Function will effectively have the same values of the original Function. Lastly, regardless of the Function a [[Building]] has, it can have its own Function Values as well. This means the used Function Values are determined as follows:
 
* If a [[building]] has their own Function Value set, that value is used.
* Otherwise, if the building's Function has an explicit Function Value defined, that value is used.
* Otherwise, if that Function was created by duplicating another Function, that Function's value is used. This step is repeated until either a value is found, or the original Function (from which all the others are derived) is found.
* The original Function always has a valid Function Value.


===Category values===
===Category values===
Some function values are construction-related, and some function values are category-related. The difference between them is only applicable if a single function consists of multiple [[function category|function categorie]]s. For example, the function value indicating the maximum amount of floors for the construction is related to the construction as a whole. However, if the function contains both social housing and luxury housing, the individual types of housing can have different unit sizes configured, as one type of housing may offer bigger housing units than the other.
Some function values are building-related, and some function values are category-related. The difference between them is only applicable if a single function consists of multiple [[Function Category|function categories]]. For example, the function value indicating the maximum amount of floors for the building is related to the building as a whole. However, if the function contains both social housing and luxury housing, the individual types of housing can have different unit sizes configured, as one type of housing may offer bigger housing units than the other.
 
When accessing a category value as an attribute, the attribute's name is prefixed by the category's name. For example: <code>UNIT_SIZE_M2</code> becomes <code>SOCIAL_UNIT_SIZE_M2</code>.


==Overview of all function values==
==Overview of all function values==
Most function values have specific effects in the context of the Tygron Platform. Individual function values can be grouped into categories based on their effects or themes.
Most function values have specific effects in the context of the {{software}}. Individual function values can be grouped into categories based on their effects or themes.
 
===Name===
{{Function values|suppresscategory=true
| {{Function values|type=row
  |functionvalue= | linkoverride=Name
  |attribute=(Property of function value)
  |unit=text
  |category=
  |description=The name of the Function.
  }}
}}


===Assets and visualisation===
===Assets and visualisation===
{|class=wikitable
{{Function values|suppresscategory=yes|
! Function value
{{Function values|type=row
! Attribute
  |functionvalue= | linkoverride=Image
! Unit
  |attribute=(Property of function value)
! Per category
  |unit={{image|dimensions=200x100}}
! Description
  |category=
|-
  |description=The image used to represent this function. This property is no longer used.
| Image
  }}
| (Property of function value)
{{:Extra color (Function Value)}}
| {{image|dimensions=200x100}}
{{:Ground color (Function Value)}}
|
{{:Roof color (Function Value)}}
| The image used to represent this function. This property is currently unused.
{{:Terrain mix (Function Value)}}
|-
{{:Top color (Function Value)}}
| Roof Color
{{Function values|type=row
| ROOF_COLOR
  |functionvalue= | linkoverride=Description
| [[color]]
  |attribute=(Property of function value)
|
  |unit=text
| 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.
  |category=
|-
  |description=The textual description of this function, which is displayed to the user when using this function as as [[action]].
| 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===
===Construction===
{|class=wikitable
{{Function values|suppresscategory=yes|
! Function value
{{:Align elevation (Function Value)}}
! Attribute
{{:Category weight (Function Value)}}
! Unit
{{:Default floors (Function Value)}}
! Per category
{{:Floor height m (Function Value)}}
! Description
{{:Height offset (Function Value)}}
|-
{{:Max floors (Function Value)}}
| Category weight
{{:Min floors (Function Value)}}
| CATEGORY_WEIGHT
{{:Monumental (Function Value)}}
| [[weight]]
{{:Slanting roof height (Function Value)}}
| Yes
{{:Solar panels (Function Value)}}
| How much of a construction of this function is classified under the specified category.
{{:Solid (Function Value)}}
|-
{{:Unit size (Function Value)}}
| Construction time in months
{{:Zoning permit required (Function Value)}}
| 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 {{inlink|min floors}} and {{inlink|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. [[Project]]s 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===
===Environment===
{|class=wikitable
{{Function values|suppresscategory=yes|
! Function value
{{:Bowen ratio (Function Value)}}
! Attribute
{{:Critical infrastructure (Function Value)}}
! Unit
{{:Distance zone m (Function Value)}}
! Per category
{{:Disturbance distance (Function Value)}}
! Description
{{:Foliage crown factor (Function Value)}}
|-
{{:Heat effect (Function Value)}}
| Critical infrastructure
{{:Livability effect (Function Value)}}
| CRITICAL_INFRASTRUCTURE
{{:Safety distance m (Function Value)}}
| [[boolean]]
{{:Vegetation fraction (Function Value)}}
|
}}
| Whether this construction counts as critical for [[Water Overlay]] calculations. {{see also|Critical structure (Water Overlay)}}
|-
| Distance zone
| DISTANCE_ZONE_M
| m
|
| The distance drawn in the [[Distance Zone (Overlay)|Distance Zone Overlay]] by this construction.
|-
| Disturbance distance
| DISTURBANCE_DISTANCE_M
| m
|
| The distance drawn in the [[Disturbance Distance (Overlay)|Disturbance Distance Overlay]] by this construction.
|-
| Green space
| GREEN_M2
| m²/m²
|
| The amount of green which this construction provides per m² created. Generally, this number is used along with the constructon's footprint, rather than its total floor size.
|-
| Heat effect
| HEAT_EFFECT
| decimal
|
| The effect this construction has on the [[Heat (Overlay)|Heat Overlay]] calculations.
|-
| Livability effect
| LIVABILITY_EFFECT
| decimal
|
| The effect this construction has on the [[Livability (Overlay)|Livability Overlay]] calculations.
|-
| Safety distance
| SAFETY_DISTANCE_M
| m
|
| The distance drawn in the [[Safety Distance (Overlay)|Safety Distance Overlay]] by this construction.
|}


===Financial===
===Financial===
{|class=wikitable
{{Function values|suppresscategory=yes|
! Function value
{{:Buyout cost (Function Value)}}
! Attribute
{{:Construction cost (Function Value)}}
! Unit
{{:Demolition cost (Function Value)}}
! Per category
{{:Sell price (Function Value)}}
! Description
}}
|-
| Buyout cost
| BUYOUT_COST_M2
| [[currency]]/m²
| Yes
| How much it costs, in addition to the demolition costs, to demolish this construction during a [[session]], when the construction is ''not'' [[vacant]].
|-
| Construction cost
| CONSTRUCTION_COST_M2
| [[currency]]/m²
| Yes
| How much it costs to create a new construction, when using this function as an [[action]] during a [[session]].
|-
| Demolition cost
| DEMOLISH_COST_M2
| [[currency]]/m²
| Yes
| How much it costs to demolish thic construction during a [[session]].
|-
| Sell price
| SELL_PRICE_M2
| [[currency]]/m²
| Yes
| How much revenue is generated for the owner, when a construction of this function is created during a [[session]]. The income is only generated once.
|}


===Network===
===Network===
{|class=wikitable
{{Function values|suppresscategory=yes|
! Function value
{{:Heat flow change per year (Function Value)}}
! Attribute
{{:Heat flow formula start year (Function Value)}}
! Unit
{{:Heat flow to power multiplier (Function Value)}}
! Per category
{{:Heat flow value at start year (Function Value)}}
! Description
{{:Pipes permitted (Function Value)}}
|-
}}
| Heat flow change per year
| HEAT_FLOW_M2_CHANGE_PER_YEAR
| m²/year
| Yes
| Currently unused
|-
| Heat flow formula start year
| HEAT_FLOW_M2_START_YEAR
| year
| Yes
| Currently unused
|-
| Heat flow to power multiplier
| HEAT_POWER_TO_FLOW_MULTIPLIER
| factor
| Yes
| Currently unused
|-
| Heat flow value at start year
| HEAT_FLOW_M2_START_VALUE
| m²
| Yes
| For any [[net load]] connected to an address part of a construction of this function, the amount of resources requested by the net load in the defined starting year. This value is increased with the HEAT_FLOW_M2_CHANGE_PER_YEAR, until the year 1991, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
|-
| Pipes permitted
| PIPES_PERMITTED
| [[boolean]]
|
| Whether [[net line]]s are allowed to be [[generating network|generated]] under this construction.
|}


===Traffic===
===Traffic===
{|class=wikitable
Traffic is split up into two further categories, to differentiate between traffic which may apply to [[Traffic Overlay]]s and alternative types of traffic.
! Function value
 
! Attribute
====Car traffic====
! Unit
{{Function values|suppresscategory=yes|
! Per category
{{:Buses per hour (Function Value)}}
! Description
{{:Cars per hour (Function Value)}}
|-
{{:Trucks per hour (Function Value)}}
| Height offset
{{:Vans per hour (Function Value)}}
| HEIGHT_OFFSET_M
 
| m
{{:Bus jam factor (Function Value)}}
|
{{:Car jam factor (Function Value)}}
| How many meters above or below the calculated ground this construction should be visualized. This is intended for bridges, so that they can be lined up appropriately with the surrounding land.
{{:Truck jam factor (Function Value)}}
|-
{{:Van jam factor (Function Value)}}
| Lanes
{{:Lanes (Function Value)}}
| TRAFFIC_LANES
{{:Noise sigma (Function Value)}}
| integer
{{:Noise tau (Function Value)}}
|
{{:Parking lots (Function Value)}}
| How many lanes of traffic there are on this road. A negative value causes vehicles to move in the opposite direction. This is only relevant for roads, intersections, and bridges. This affects the visualisation.
{{:Parking lots demand (Function Value)}}
|-
{{:Speedlimit (Function Value)}}
| Noise sigma
}}
| TRAFFIC_NOISE_SIGMA
 
|
====Other traffic====
|
 
|
{{Function values|suppresscategory=yes|
|-
  {{:Airplanes per hour (Function Value)}}
| Noise tau
  {{:Bicycles per hour (Function Value)}}
| TRAFFIC_NOISE_TAU
  {{:Pedestrians per hour (Function Value)}}
|
  {{:Ships per hour (Function Value)}}
|
  {{:Trains per hour (Function Value)}}
|
  {{:Trams per hour (Function Value)}}
|-
}}
| Parking lots
| PARKING_LOTS_PER_M2
| parking lot/m²
| Yes
| How many parking lots are available per m² of this construction.
|-
| Parking lots demand
| PARKING_LOTS_DEMAND_PER_M2
| parking lot/m²
| Yes
| How many parking lots are required per m² of this construction.
|-
| Speedlimit
| TRAFFIC_SPEED
| km/h
|
| How fast vehicles move on this construction. This is only relevant for roads, intersections, and bridges. This affects the visualisation, and the calculations for the [[Traffic Noise (Overlay)|Traffic Noise Overlay]] and the [[Traffic NO2 (Overlay)|Traffic NO2 Overlay]]
|-
| Units per hour
| TRAFFIC_FLOW
| vehicles/h
|
| How many vehicles move over any given cross-section of the road per hour, spread across all lanes. This is only relevant for roads, intersections, and bridges. This affects the visualisation, and the calculations for the [[Traffic Noise (Overlay)|Traffic Noise Overlay]] and the [[Traffic NO2 (Overlay)|Traffic NO2 Overlay]]
|}


===Water===
===Water===
{|class=wikitable
{{Function values|suppresscategory=yes|
! Function value
{{:Connected to sewer area (Function Value)}}
! Attribute
{{:Depth of plant roots (Function Value)}}
! Unit
{{:Drainage (Function Value)}}
! Per category
{{:Ground infiltration per day (Function Value)}}
! Description
{{:Manning value (Function Value)}}
|-
{{:Water evaporation (Function Value)}}
| Connected top sewer area
{{:Water microrelief (Function Value)}}
| SEWERED
{{:Water storage (Function Value)}}
| [[boolean]]
}}
|
| Whether this construction can be connected to a sewer. {{see also|sewered (Water Overlay)}}
|-
| Depth of plant roots
| ROOT_DEPTH_M
| m
|
| The depth of the roots of the plants of this construction. {{see also|root depth m (Water Overlay)}}
|-
| Drainage
| DRAINAGE
| m
|
| Whether this construction has drainage, which affects the calculation of the [[Subsidence (Overlay)|Subsidence Overlay]]. A negative value means passive drainage. A positive value means active drainage.
|-
| Ground infiltration per day
| GROUND_INFILTRATION_MD
| m/day
|
| The permeability of this construction to water trying to infiltrate into the ground. {{see also|ground infiltration md (Water Overlay)}}
|-
| Manning value
| WATER_MANNING
| s/(m<sup>1/3</sup>)
|
| The manning value of the construction, which is a roughness in regards to water flow. {{see also|water manning (Water Overlay)}}
|-
| Water evaporation
| WATER_EVAPORATION_FACTOR
| factor
|
| How much this construction facilitates water evaporating from the underground. {{see also|water evaporation factor (Water Overlay)}}
|-
| Water storage
| WATER_STORAGE_M2
| m³/m²
|
| How much water can be stored in this construction. This affects the calculation of the [[Water Storage (Indicator)|Water Storage Indicator]] and calculation of the [[Water Overlay]]. {{see also|water storage (Water Overlay)}}
|}


===Attributes===
===Attributes===
Besides the function values which are provided by default, it is possible to add user-defined attributes to function values as well. Any attribute added is automatically available as an attribute for all functions, and all constructions, although the default value of the attribute will be 0.
Besides the function values which are provided by default, it is possible to add user-defined attributes to function values as well. Any attribute added is automatically available as an [[Attribute]] for all [[Function]]s, and all [[Building]]s, although the default value of the [[Attribute]] will be 0.
 
User-defined [[Attribute]]s added to a function value always apply to the building as a whole, and cannot be category-specific.
{{Function values|suppresscategory=true
| {{Function values|type=row
  |functionvalue= | linkoverride=&nbsp;
  |attribute=[[Private yard (Building Attribute)|PRIVATE_YARD]]
  |unit={{boolean}}
  |category=
  |description=Whether the building is a private yard belonging to a residence or private stakeholder.
  }}
{{Function values|type=row
  |functionvalue= | linkoverride=(user defined)
  |attribute=(user defined)
  |unit=(user defined)
  |category=
  |description=Attributes can be used to assign any additional values or properties to functions and the buildings which derive from them.
  }}
}}


User-defined attributes added to a function value always apply to the construction as a whole, and cannot be category-specific.
{{article end|
{|class=wikitable
howtos=
! Function value
* [[How to add Functions for editing]]
! Attribute
* [[How to change Function Values for a Function]]
! Unit
* [[How to add an Attribute to a Function]]
! Per category
* [[How to change Attributes for a Function]]
! Description
|seealso= * [[Function Values Table]]
|-
*[[Function]]
| (user defined)
*[[Function Override]]
| (user defined)
|videos=
| (user defined)
}}
|
| Attributes can be used to assign any additional values or properties to functions and the constructions which derive from them.
|}

Latest revision as of 14:55, 29 February 2024

Function values are specific values which form the general properties of any building with a specific function. A function has many function values, and any building of that function also has those function values.

Function values can be changed for an individual building, or for a function, which in turn would affect all buildings of that function.

Overwrites

Function Values can be defined on several levels. Primarily, they can be defined on Functions. The Function Values of Functions can be overwritten by adding them to the Function Values Table. Additionally, a Function can be duplicated, and that new Function will effectively have the same values of the original Function. Lastly, regardless of the Function a Building has, it can have its own Function Values as well. This means the used Function Values are determined as follows:

  • If a building has their own Function Value set, that value is used.
  • Otherwise, if the building's Function has an explicit Function Value defined, that value is used.
  • Otherwise, if that Function was created by duplicating another Function, that Function's value is used. This step is repeated until either a value is found, or the original Function (from which all the others are derived) is found.
  • The original Function always has a valid Function Value.

Category values

Some function values are building-related, and some function values are category-related. The difference between them is only applicable if a single function consists of multiple function categories. For example, the function value indicating the maximum amount of floors for the building is related to the building as a whole. However, if the function contains both social housing and luxury housing, the individual types of housing can have different unit sizes configured, as one type of housing may offer bigger housing units than the other.

When accessing a category value as an attribute, the attribute's name is prefixed by the category's name. For example: UNIT_SIZE_M2 becomes SOCIAL_UNIT_SIZE_M2.

Overview of all function values

Most function values have specific effects in the context of the Tygron Platform. Individual function values can be grouped into categories based on their effects or themes.

Name

Assets and visualisation

Construction

Environment

Financial

Network

Traffic

Traffic is split up into two further categories, to differentiate between traffic which may apply to Traffic Overlays and alternative types of traffic.

Car traffic

Other traffic

Water

Attributes

Besides the function values which are provided by default, it is possible to add user-defined attributes to function values as well. Any attribute added is automatically available as an Attribute for all Functions, and all Buildings, although the default value of the Attribute will be 0.

User-defined Attributes added to a function value always apply to the building as a whole, and cannot be category-specific.