Function Value

This article is a stub.

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.

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.

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

Function value	Attribute	Unit	Per category	Description
Image	(Property of function value)	Image (png, 200x100)		The image used to represent this function. This property is currently unused.
Roof Color	ROOF_COLOR	color		The color of the roof of a construction. For flat constructions (such as gardens and roads), it is also the color of the ground surface.
Ground Color	GROUND_COLOR	color		The color of the walls of the bottom floor of a construction.
Extra Color	EXTRA_COLOR	color		The color of the walls of the floors of the construction which are neither the top nor bottom floor.
Top Color	TOP_COLOR	color		The color of the walls of the top floor of a construction, unless that floor is also the bottom floor.
Description	(Property of function value)	text		The textual description of this function, which is displayed to the user when using this function as as action.

Construction

Function value	Attribute	Unit	Per category	Description
Category weight	CATEGORY_WEIGHT	weight	Yes	How much of a construction of this function is classified under the specified category.
Construction time in months	CONSTRUCTION_TIME_IN_MONTHS	months		How long it takes to construct a construction of this function during a timeline session.
Default floors	DEFAULT_FLOORS	integer		How many floors a construction 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).
Demolish time in months	DEMOLISH_TIME_IN_MONTHS	months		How long it takes to demolish a construction of this functon during a timeline session.
Floating	FLOATING	boolean		Whether this construction should be visualized with a "floating" animation, as if on water.
Floor height m	FLOOR_HEIGHT_M	m		The height of each floor of the construction.
Max floors	MAX_FLOORS	integer		The maximum amount of floors this construction (or any of its sections) can have. This also limits how many floors a construction can have when used as an action during a session.
Min floors	MIN_FLOORS	integer		The minimum amount of floors this construction (or any of its sections) should have. This also limits how many floors a construction must have when used as an action during a session.
Monumental	MONUMENTAL	boolean		Whether this construction is monumental. Projects can be set up so that monumental constructions enjoy special protections or have additional qualitative value.
Slanting roof height	SLANTING_ROOF_HEIGHT	m		How high the slanting roof at the top of the construction should be visualized at its peak. The roof will slant inwards equally from all sides.
Unit size	UNIT_SIZE_M2	m²/unit	Yes	How large a single housing unit within this construction is. This is only relevant for residential categories.
Zoning permit required	ZONING_PERMIT_REQUIRED	boolean		Whether the municipal stakeholder should be requested permission, when another user uses this function as an action to plan a new construction during a session

Environment

Function value	Attribute	Unit	Per category	Description
Critical infrastructure	CRITICAL_INFRASTRUCTURE	boolean		Whether this construction counts as critical for Water Overlay calculations. See also: Critical structure (Water Overlay)
Distance zone	DISTANCE_ZONE_M	m		The distance drawn in the Distance Zone Overlay by this construction.
Disturbance distance	DISTURBANCE_DISTANCE_M	m		The distance drawn in the Disturbance Distance Overlay by this construction.
Green space	GREEN_M2	m²/m²		The amount of green which this construction provides per m² created. Generally, this number is used along with the constructon's footprint, rather than its total floor size.
Heat effect	HEAT_EFFECT	°C		The effect this construction has on the Heat Overlay calculations.
Livability effect	LIVABILITY_EFFECT	decimal		The effect this construction has on the Livability Overlay calculations.
Safety distance	SAFETY_DISTANCE_M	m		The distance drawn in the Safety Distance Overlay by this construction.

Financial

Function value	Attribute	Unit	Per category	Description
Buyout cost	BUYOUT_COST_M2	currency/m²	Yes	How much it costs, in addition to the demolition costs, to demolish this construction during a session, when the construction is not vacant. These costs are due to eviction or buyout of existing tenants.
Construction cost	CONSTRUCTION_COST_M2	currency/m²	Yes	How much it costs to create a new construction, when using this function as an action during a session.
Demolition cost	DEMOLISH_COST_M2	currency/m²	Yes	How much it costs to demolish this construction during a session. If the construction is not vacant, the buyout costs are applicable as well, in addition to the demolition costs.
Sell price	SELL_PRICE_M2	currency/m²	Yes	How much revenue is generated for the owner, when a construction of this function is created during a session. The income is only generated once.

Network

Function value	Attribute	Unit	Per category	Description
Heat flow change per year	HEAT_FLOW_M2_CHANGE_PER_YEAR	m²/year	Yes	For any net load connected to an address part of a construction 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 construction, 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.
Heat flow formula start year	HEAT_FLOW_M2_START_YEAR	year	Yes	For any net load connected to an address part of a construction 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 construction, 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.
Heat flow to power multiplier	HEAT_POWER_TO_FLOW_MULTIPLIER	factor	Yes	For any net load connected to an address part of a construction 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.
Heat flow value at start year	HEAT_FLOW_M2_START_VALUE	m²	Yes	For any net load connected to an address part of a construction 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 construction, 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.
Pipes permitted	PIPES_PERMITTED	boolean		Whether net lines are allowed to be generated under this construction.

Traffic

Function value	Attribute	Unit	Per category	Description
Height offset	HEIGHT_OFFSET_M	m		How many meters above or below the calculated ground this construction should be visualized. This is intended for bridges, so that they can be lined up appropriately with the surrounding land.
Lanes	TRAFFIC_LANES	integer		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 affects the visualisation.
Noise sigma	TRAFFIC_NOISE_SIGMA	dB(A)		Difference in noise intensity of vehicles at their reference speed, used in the traffic model. Effectively a flat modifier in noise.
Noise tau	TRAFFIC_NOISE_TAU	dB(A)		Difference in noise intensity of vehicles for every order of magnitude difference with their reference speed, used in the traffic model. Effectively a speed-dependent modifier in noise.
Parking lots	PARKING_LOTS_PER_M2	parking lot/m²	Yes	How many parking lots are available per m² of this construction.
Parking lots demand	PARKING_LOTS_DEMAND_PER_M2	parking lot/m²	Yes	How many parking lots are required per m² of this construction.
Speedlimit	TRAFFIC_SPEED	km/h		How fast vehicles move on this construction. This is only relevant for roads, intersections, and bridges. This affects the visualisation, and the calculations for the Traffic Noise Overlay and the Traffic NO2 Overlay
Units per hour	TRAFFIC_FLOW	vehicles/h		How many vehicles move over any given cross-section of the road per hour, spread across all lanes. This is only relevant for roads, intersections, and bridges. This affects the visualisation, and is part of the traffic model, in turn affecting the calculations for the Traffic Noise Overlay and the Traffic NO2 Overlay.

Water

Function value	Attribute	Unit	Per category	Description	Model-specific articles
Connected top sewer area	SEWERED	boolean		Whether this construction can be connected to a sewer.	Sewered (Water Overlay)
Depth of plant roots	ROOT_DEPTH_M	m		The depth of the roots of the plants of this construction.	Root depth m (Water Overlay)
Drainage	DRAINAGE	m		Whether this construction has drainage, which affects the calculation of the Subsidence Overlay. A negative value means passive drainage. A positive value means active drainage.
Ground infiltration per day	GROUND_INFILTRATION_MD	m/day		The permeability of this construction to water trying to infiltrate into the ground.	Ground infiltration md (Water Overlay)
Manning value	WATER_MANNING	s/(m1/3)		The manning value of the construction, which is a roughness in regards to water flow.	Water manning (Water Overlay)
Water evaporation	WATER_EVAPORATION_FACTOR	factor		How much this construction facilitates water evaporating from the underground.	Water evaporation factor (Water Overlay)
Water storage	WATER_STORAGE_M2	m³/m²		How much water can be stored in this construction. This affects the calculation of the Water Storage Indicator and calculation of the Water Overlay.	Water storage (Water Overlay)

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.