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.
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 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
Function value
Attribute
Unit
Per category
Range
Description
Name
(Property of function value)
text
The name of the Function.
Assets and visualisation
Function value
Attribute
Unit
Per category
Range
Description
Image
(Property of function value)
Image (png, 200x100)
The image used to represent this function. This property is no longer used.
Attribute that determines whether a Building is aligned relative to the elevation model (in case of an uneven surface), flat on the ground, or floating.
How many floors a building of this function will have by default, unless otherwise specified. When using this Function as an Action, this is the default amount of floors created, unless the user changes this setting while performing the Action. This values must always be in the range of min floors and max floors (inclusive).
How many meters above or below the datum this building should be visualized. This is intended for bridges or other buildings on water, so that they can be lined up appropriately with the surrounding land, or float at an appropriate height.
The maximum amount of floors this Building (or any of its sections) can have. This also limits how many floors a Building can have when used as an action during a session.
The minimum amount of floors this Building (or any of its sections) should have. This also limits how many floors a Building must have when used as an action during a session.
How high the slanting roof at the top of the building should be visualized at its peak. The roof will slant inwards equally from all sides. This is a visual effect only, but it is possible to reference this value in custom calculations.
Whether the municipal stakeholder should be requested permission, when another user uses this function as an action to plan a new building during a session.
The amount of green which this building provides per m². Generally, this number is used along with the building's footprint, rather than its total floor size.
How much it costs, in addition to the demolition costs, to demolish this Building during a session, when the Building is notvacant. These costs are due to eviction or buyout of existing tenants.
How much it costs to demolish this Building during a session. If the building is not vacant, the buyout costs are applicable as well, in addition to the demolition costs.
How much revenue is generated for the owner, when a building of this function is created during a session. The income is only generated once, when the construction of the building has completed.
For any net load connected to an address part of a Building of this function, the amount of resources (FLOW) requested in addition to those in the starting year during every subsequent year. The amount of resources requested starts at HEAT_FLOW_M2_START_VALUE in the start year, and is then increased by this value every year until the building's year of creation, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
For any net load connected to an Address part of a Building of this function, the start year for the calculation of the amount of resources (FLOW) requested. The amount of resources requests starts at HEAT_FLOW_M2_START_VALUE in this year, and is then increased by HEAT_FLOW_M2_CHANGE_PER_YEAR every year until the building's year of creation, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
For any net load connected to an address part of a building of this function, the divisor used to convert the automatically calculated FLOW to an automatically calculated POWER attribute. The automatically calculated FLOW divided by this value is the automatically calculated POWER. Note that an explicitly defined FLOW attribute is not used in this calculation.
For any net load connected to an address part of a Building of this function, the amount of resources (FLOW) requested by the net load in the defined starting year. This value is increased with the HEAT_FLOW_M2_CHANGE_PER_YEAR, until the building's year of Building, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
Traffic is split up into two further categories, to differentiate between traffic which may apply to Traffic Overlays and alternative types of traffic.
How many lanes of traffic there are on this road. A negative value causes vehicles to move in the opposite direction. This is only relevant for roads, intersections, and bridges. This only affects the visualization.
Difference in noise intensity of vehicles for every order of magnitude difference with their reference speed. Effectively a speed-dependent modifier in noise.
How fast vehicles move on this building. This is only relevant for roads, intersections, and bridges. This affects the visualization, and the calculations for the Traffic Noise Overlay.
Factor indicating how much a building with a crop, tree or plant function facilitates evapotranspiration. This factor is multiplied with the weather's evaporation rate at a particular time in the simulation.
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.
