Function Value: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(114 intermediate revisions by 6 users not shown)
Line 1: Line 1:
#REDIRECT [[Functions#Function values]]
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 [[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===
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 {{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)}}
|
{{: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
|
  |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]]
|
|
|-
| Extra Color
| EXTRA_COLOR
| [[color]]
|
|
|-
| Top Color
| TOP_COLOR
| [[color]]
|
|
|-
| Description
| (Property of function value)
| text
|
|
|}


===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)}}
|
{{:Solid (Function Value)}}
|-
{{:Unit size (Function Value)}}
| Construction time in months
{{:Zoning permit required (Function Value)}}
| CONSTRUCTION_TIME_IN_MONTHS
}}
| months
|
|
|-
| Default floors
| DEFAULT_FLOORS
| integer
|
|
|-
| Demolish time in months
| DEMOLISH_TIME_IN_MONTHS
| months
|
|
|-
| Floating
| FLOATING
| [[boolean]]
|
|
|-
| Floor height m
| FLOOR_HEIGHT_M
| m
|
|
|-
| Max floors
| MAX_FLOORS
| integer
|
|
|-
| Min floors
| MIN_FLOORS
| integer
|
|
|-
| Monumental
| MONUMENTAL
| [[boolean]]
|
|
|-
| Slanting roof height
| SLANTING_ROOF_HEIGHT
| m
|
|
|-
| Unit size
| UNIT_SIZE_M2
| m²/unit
| Yes
|
|-
| Zoning permit required
| ZONING_PERMIT_REQUIRED
| boolean
|
|
|}


===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)}}
|
}}
|
|-
| 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===
===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
|
|-
| 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===
===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
|
|-
| 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===
===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)}}
|
{{: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)}}
|
{{: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
|
|-
| 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===
===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]]
}}
|
|
|-
| 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/(m<sup>1/3</sup>)
|
|
|-
| Water evaporation
| WATER_EVAPORATION_FACTOR
| factor
|
|
|-
| Water storage
| WATER_STORAGE_M2
| m³/m²
|
|
|}


===Attributes===
===Attributes===
{|class=wikitable
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.
! Function value
 
! Attribute
User-defined [[Attribute]]s added to a function value always apply to the building as a whole, and cannot be category-specific.
! Unit
{{Function values|suppresscategory=true
! Per category
| {{Function values|type=row
! Description
  |functionvalue= | linkoverride=&nbsp;
|-
  |attribute=[[Private yard (Building Attribute)|PRIVATE_YARD]]
| (user defined)
  |unit={{boolean}}
| (user defined)
  |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.
  }}
}}
 
{{article end|
howtos=
* [[How to add Functions for editing]]
* [[How to change Function Values for a Function]]
* [[How to add an Attribute to a Function]]
* [[How to change Attributes for a Function]]
|seealso= * [[Function Values Table]]
*[[Function]]
*[[Function Override]]
|videos=
}}

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.