Function Value: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(8 intermediate revisions by 2 users not shown)
Line 4: Line 4:


===Overwrites===
===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 [[Building]] has, it can have its own Function Values as well. This means the used Function Values are determined as follows:
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.
* If a [[building]] has their own Function Value set, that value is used.
Line 53: Line 53:
}}
}}


===Building===
===Construction===
{{Function values|suppresscategory=yes|
{{Function values|suppresscategory=yes|
{{:Align elevation (Function Value)}}
{{:Align elevation (Function Value)}}
{{:Category weight (Function Value)}}
{{:Category weight (Function Value)}}
{{:Default floors (Function Value)}}
{{:Default floors (Function Value)}}
{{:Floating (Function Value)}}
{{:Floor height m (Function Value)}}
{{:Floor height m (Function Value)}}
{{:Height offset (Function Value)}}
{{:Height offset (Function Value)}}
Line 66: Line 65:
{{:Slanting roof height (Function Value)}}
{{:Slanting roof height (Function Value)}}
{{:Solar panels (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)}}
Line 74: Line 74:
{{:Bowen ratio (Function Value)}}
{{: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)}}
{{:Foliage crown factor (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)}}
{{:Vegetation fraction (Function Value)}}
{{:Vegetation fraction (Function Value)}}
}}
}}
Line 141: 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)}}
}}
}}


===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 buildings, 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 building 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.
{{Function values|suppresscategory=true
{{Function values|suppresscategory=true
| {{Function values|type=row
| {{Function values|type=row
  |functionvalue= | linkoverride= 
  |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)
   |functionvalue= | linkoverride=(user defined)
   |attribute=(user defined)
   |attribute=(user defined)
Line 164: Line 172:
* [[How to add an Attribute to a Function]]
* [[How to add an Attribute to a Function]]
* [[How to change Attributes for a Function]]
* [[How to change Attributes for a Function]]
|seealso=
|seealso= * [[Function Values Table]]
*[[Function]]
*[[Function Override]]
|videos=
|videos=
{{video|language=|link=https://www.youtube.com/watch?v=Vv1XA3HCOyQ&t=1500s|description=FAQ Webinar, which touches on Function Values.}}
}}
}}

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.