View source for Function Value

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.

===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 window]]. 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 [[Construction]] has, it can have its own Function Values as well. This means the used Function Values are determined as follows:

* If a Construction has their own Function Value set, that value is used.
* Otherwise, if the Construction'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 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.

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==
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===
{|class=wikitable
! Function value
! Attribute
! Unit
! Per category
! Description
|-
| Name
| (Property of function value)
| text
|
| The name of the Function.
|}

===Assets and visualisation===
{{Function values|suppresscategory=yes|
 <tr>
  <td> Image </td>
  <td> (Property of function value) </td>
  <td> {{image|dimensions=200x100}} </td>
  <td> </td>
  <td> The image used to represent this function. This property is currently unused. </td>
 </tr>
{{:Extra color (Function Value)}}
{{:Ground color (Function Value)}}
{{:Roof color (Function Value)}}
{{:Terrain mix (Function Value)}}
{{:Top color (Function Value)}}
 <tr>
  <td> Description </td>
  <td> (Property of function value) </td>
  <td> text </td>
  <td> </td>
  <td> The textual description of this function, which is displayed to the user when using this function as as [[action]]. </td>
 </tr>
}}

===Construction===
{{Function values|suppresscategory=yes|
{{:Category weight (Function Value)}}
{{:Construction time in months (Function Value)}}
{{:Default floors (Function Value)}}
{{:Demolish time in months (Function Value)}}
{{:Floating (Function Value)}}
{{:Floor height m (Function Value)}}
{{:Max floors (Function Value)}}
{{:Min floors (Function Value)}}
{{:Monumental (Function Value)}}
{{:Slanting roof height (Function Value)}}
{{:Unit size (Function Value)}}
{{:Zoning permit required (Function Value)}}
}}

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

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

===Network===
{{Function values table|suppresscategory=yes|
{{:Heat flow change per year (Function Value)}}
{{:Heat flow formula start year (Function Value)}}
{{:Heat flow to power multiplier (Function Value)}}
{{:Heat flow value at start year (Function Value)}}
{{:Pipes permitted (Function Value)}}
}}

===Traffic===
{{Function values table|suppresscategory=yes|
{{:Height offset (Function Value)}}
{{:Lanes (Function Value)}}
{{:Noise sigma (Function Value)}}
{{:Noise tau (Function Value)}}
{{:Parking lots (Function Value)}}
{{:Parking lots demand (Function Value)}}
{{:Speedlimit (Function Value)}}
{{:Units per hour (Function Value)}}
}}

===Water===
{{Function values table|suppresscategory=yes|
{{:Connected to sewer area (Function Value)}}
{{:Depth of plant roots (Function Value)}}
{{:Drainage (Function Value)}}
{{:Ground infiltration per day (Function Value)}}
{{:Manning value (Function Value)}}
{{:Water evaporation (Function Value)}}
{{:Water storage (Function Value)}}
}}

===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.

User-defined attributes added to a function value always apply to the construction as a whole, and cannot be category-specific.
{|class=wikitable
! Function value
! Attribute
! Unit
! Per category
! Description
|-
| (user defined)
| (user defined)
| (user defined)
|
| Attributes can be used to assign any additional values or properties to functions and the constructions which derive from them.
|}

==How-to's==
* [[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]]