Function Value: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(54 intermediate revisions by 6 users not shown)
Line 1: Line 1:
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 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 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 categories]]. 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===
===Name===
{|class=wikitable
{{Function values|suppresscategory=true
! Function value
| {{Function values|type=row
! Attribute
  |functionvalue= | linkoverride=Name
! Unit
  |attribute=(Property of function value)
! Per category
  |unit=text
! Description
  |category=
|-
  |description=The name of the Function.
| Name
  }}
| (Property of function value)
}}
| text
|
| The name of the Function.
|}


===Assets and visualisation===
===Assets and visualisation===
{{Function values table start|suppresscategory=yes}}
{{Function values|suppresscategory=yes|
|-
{{Function values|type=row
| Image
  |functionvalue= | linkoverride=Image
| (Property of function value)
  |attribute=(Property of function value)
| {{image|dimensions=200x100}}
  |unit={{image|dimensions=200x100}}
|
  |category=
| The image used to represent this function. This property is currently unused.
  |description=The image used to represent this function. This property is no longer used.
  }}
{{:Extra color (Function Value)}}
{{:Ground color (Function Value)}}
{{:Roof color (Function Value)}}
{{:Roof color (Function Value)}}
{{:Ground color (Function Value)}}
{{:Terrain mix (Function Value)}}
{{:Extra color (Function Value)}}
{{:Top color (Function Value)}}
{{:Top color (Function Value)}}
|-
{{Function values|type=row
| Description
  |functionvalue= | linkoverride=Description
| (Property of function value)
  |attribute=(Property of function value)
| text
  |unit=text
|
  |category=
| The textual description of this function, which is displayed to the user when using this function as as [[action]].
  |description=The textual description of this function, which is displayed to the user when using this function as as [[action]].
{{table end}}
  }}
}}


===Construction===
===Construction===
{{Function values table start|suppresscategory=yes}}
{{Function values|suppresscategory=yes|
{{:Align elevation (Function Value)}}
{{:Category weight (Function Value)}}
{{:Category weight (Function Value)}}
{{:Construction time in months (Function Value)}}
{{:Default floors (Function Value)}}
{{:Default floors (Function Value)}}
{{:Demolish time in months (Function Value)}}
{{:Floating (Function Value)}}
{{:Floor height m (Function Value)}}
{{:Floor height m (Function Value)}}
{{:Height offset (Function Value)}}
{{:Max floors (Function Value)}}
{{:Max floors (Function Value)}}
{{:Min floors (Function Value)}}
{{:Min floors (Function Value)}}
{{:Monumental (Function Value)}}
{{:Monumental (Function Value)}}
{{:Slanting roof height (Function Value)}}
{{:Slanting roof height (Function Value)}}
{{:Solar panels (Function Value)}}
{{:Solid (Function Value)}}
{{:Unit size (Function Value)}}
{{:Unit size (Function Value)}}
{{:Zoning permit required (Function Value)}}
{{:Zoning permit required (Function Value)}}
{{Table end}}
}}


===Environment===
===Environment===
{{Function values table start|suppresscategory=yes}}
{{Function values|suppresscategory=yes|
{{:Bowen ratio (Function Value)}}
{{:Critical infrastructure (Function Value)}}
{{:Critical infrastructure (Function Value)}}
{{:Distance zone (Function Value)}}
{{:Distance zone m (Function Value)}}
{{:Disturbance distance (Function Value)}}
{{:Disturbance distance (Function Value)}}
{{:Green space (Function Value)}}
{{:Foliage crown factor (Function Value)}}
{{:Heat effect (Function Value)}}
{{:Heat effect (Function Value)}}
{{:Livability effect (Function Value)}}
{{:Livability effect (Function Value)}}
{{:Safety distance (Function Value)}}
{{:Safety distance m (Function Value)}}
{{Table end}}
{{:Vegetation fraction (Function Value)}}
}}


===Financial===
===Financial===
{{Function values table start|suppresscategory=yes}}
{{Function values|suppresscategory=yes|
{{:Buyout cost (Function Value)}}
{{:Buyout cost (Function Value)}}
{{:Construction cost (Function Value)}}
{{:Construction cost (Function Value)}}
{{:Demolition cost (Function Value)}}
{{:Demolition cost (Function Value)}}
{{:Sell price (Function Value)}}
{{:Sell price (Function Value)}}
{{Table end}}
}}


===Network===
===Network===
{{Function values table start|suppresscategory=yes}}
{{Function values|suppresscategory=yes|
{{:Heat flow change per year (Function Value)}}
{{:Heat flow change per year (Function Value)}}
{{:Heat flow formula start year (Function Value)}}
{{:Heat flow formula start year (Function Value)}}
Line 86: Line 98:
{{:Heat flow value at start year (Function Value)}}
{{:Heat flow value at start year (Function Value)}}
{{:Pipes permitted (Function Value)}}
{{:Pipes permitted (Function Value)}}
{{Table end}}
}}


===Traffic===
===Traffic===
{{Function values table start|suppresscategory=yes}}
Traffic is split up into two further categories, to differentiate between traffic which may apply to [[Traffic Overlay]]s and alternative types of traffic.
{{:Height offset (Function Value)}}
 
====Car traffic====
{{Function values|suppresscategory=yes|
{{:Buses per hour (Function Value)}}
{{:Cars per hour (Function Value)}}
{{:Trucks per hour (Function Value)}}
{{:Vans per hour (Function Value)}}
 
{{:Bus jam factor (Function Value)}}
{{:Car jam factor (Function Value)}}
{{:Truck jam factor (Function Value)}}
{{:Van jam factor (Function Value)}}
{{:Lanes (Function Value)}}
{{:Lanes (Function Value)}}
{{:Noise sigma (Function Value)}}
{{:Noise sigma (Function Value)}}
Line 97: Line 120:
{{:Parking lots demand (Function Value)}}
{{:Parking lots demand (Function Value)}}
{{:Speedlimit (Function Value)}}
{{:Speedlimit (Function Value)}}
{{:Units per hour (Function Value)}}
}}
{{Table end}}
 
====Other traffic====
 
{{Function values|suppresscategory=yes|
  {{:Airplanes per hour (Function Value)}}
  {{:Bicycles per hour (Function Value)}}
  {{:Pedestrians per hour (Function Value)}}
  {{:Ships per hour (Function Value)}}
  {{:Trains per hour (Function Value)}}
  {{:Trams per hour (Function Value)}}
}}


===Water===
===Water===
{{Function values table start|suppresscategory=yes}}
{{Function values|suppresscategory=yes|
{{:Connected to sewer area (Function Value)}}
{{:Connected to sewer area (Function Value)}}
{{:Depth of plant roots (Function Value)}}
{{:Depth of plant roots (Function Value)}}
Line 108: Line 141:
{{:Manning value (Function Value)}}
{{:Manning value (Function Value)}}
{{:Water evaporation (Function Value)}}
{{:Water evaporation (Function Value)}}
{{:Water microrelief (Function Value)}}
{{:Water storage (Function Value)}}
{{:Water storage (Function Value)}}
{{Table end}}
}}


===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 attributes added to a function value always apply to the construction as a whole, and cannot be category-specific.
User-defined [[Attribute]]s added to a function value always apply to the building as a whole, and cannot be category-specific.
{|class=wikitable
{{Function values|suppresscategory=true
! Function value
| {{Function values|type=row
! Attribute
  |functionvalue= | linkoverride=&nbsp;
! Unit
  |attribute=[[Private yard (Building Attribute)|PRIVATE_YARD]]
! Per category
  |unit={{boolean}}
! Description
  |category=
|-
  |description=Whether the building is a private yard belonging to a residence or private stakeholder.
| (user defined)
  }}
| (user defined)
{{Function values|type=row
| (user defined)
  |functionvalue= | linkoverride=(user defined)
|
  |attribute=(user defined)
| Attributes can be used to assign any additional values or properties to functions and the constructions which derive from them.
  |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.
  }}
}}


==How-to's==
{{article end|
howtos=
* [[How to add Functions for editing]]
* [[How to add Functions for editing]]
* [[How to change Function Values for a Function]]
* [[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.