Function Value: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
Line 35: Line 35:


===Assets and visualisation===
===Assets and visualisation===
{{Function values table start|suppresscategory=yes}}
{{Function values table|suppresscategory=yes|
|-
{{!}}-
| Image
{{!}} Image
| (Property of function value)
{{!}} (Property of function value)
| {{image|dimensions=200x100}}
{{!}} {{image|dimensions=200x100}}
|
{{!}}
| The image used to represent this function. This property is currently unused.
{{!}} The image used to represent this function. This property is currently unused.
{{:Extra color (Function Value)}}
{{:Extra color (Function Value)}}
{{:Ground color (Function Value)}}
{{:Ground color (Function Value)}}
Line 47: Line 47:
{{:Terrain mix (Function Value)}}
{{:Terrain mix (Function Value)}}
{{:Top color (Function Value)}}
{{:Top color (Function Value)}}
|-
{{!}}-
| Description
{{!}} Description
| (Property of function value)
{{!}} (Property of function value)
| text
{{!}} text
|
{{!}}
| The textual description of this function, which is displayed to the user when using this function as as [[action]].
{{!}} 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 table|suppresscategory=yes|
{{:Category weight (Function Value)}}
{{:Category weight (Function Value)}}
{{:Construction time in months (Function Value)}}
{{:Construction time in months (Function Value)}}
Line 69: Line 69:
{{: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 table|suppresscategory=yes|
{{:Bowen ratio (Function Value)}}
{{:Bowen ratio (Function Value)}}
{{:Critical infrastructure (Function Value)}}
{{:Critical infrastructure (Function Value)}}
Line 82: Line 82:
{{:Livability effect (Function Value)}}
{{:Livability effect (Function Value)}}
{{:Safety distance (Function Value)}}
{{:Safety distance (Function Value)}}
{{Table end}}
}}


===Financial===
===Financial===
{{Function values table start|suppresscategory=yes}}
{{Function values table|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 table|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 99: Line 99:
{{: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}}
{{Function values table|suppresscategory=yes|
{{:Height offset (Function Value)}}
{{:Height offset (Function Value)}}
{{:Lanes (Function Value)}}
{{:Lanes (Function Value)}}
Line 111: Line 111:
{{:Speedlimit (Function Value)}}
{{:Speedlimit (Function Value)}}
{{:Units per hour (Function Value)}}
{{:Units per hour (Function Value)}}
{{Table end}}
}}


===Water===
===Water===

Revision as of 13:11, 25 June 2020

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 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 is 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 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: 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

Function value Attribute Unit Per category Description
Name (Property of function value) text The name of the Function.

Assets and visualisation

Template:Function values table

Construction

Template:Function values table

Environment

Template:Function values table

Financial

Template:Function values table

Network

Template:Function values table

Traffic

Template:Function values table

Water

Template:Function values table

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.

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