Function Value

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.

For values related to a specific Function Category, which are handled differently, see Category Values.

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.

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.

Assets and visualization

Function value	Attribute	Unit	Range	Description
Basement color	BASEMENT_COLOR	color	-2147483648 to 2147483647	The color of walls at the basement floor of a building.
Ground color	GROUND_COLOR	Color	-2147483648 to 2147483647	The color of walls at the bottom floor of a Building.
Extra color	EXTRA_COLOR	color	-2147483648 to 2147483647	The color of the walls of the floors of the building which are neither the top nor bottom floor.
Top color	TOP_COLOR	color	-2147483648 to 2147483647	The color of the walls of the top floor of a building, unless that floor is also the bottom floor.
Roof color	ROOF_COLOR	color	-2147483648 to 2147483647	The color of the roof of a building. For flat building (such as gardens and roads), it is also the color of the ground surface.
Terrain mix	TERRAIN_MIX	fraction	0 to 1	The opacity of the ground color of the Function.

Construction

Function value	Attribute	Unit	Range	Description
Align Elevation	ALIGN_ELEVATION	Integer	0 to 2	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.
Default floors	DEFAULT_FLOORS	integer	1 to 250	The default number of floors for a building of this function. When used in an Action, it defines the initial floor count unless modified by the user. This value must always be in the range of min floors and max floors (inclusive).
Floor height m	FLOOR_HEIGHT_M	m	0 to 1.7976931348623157E308	The height of each floor of the Building.
Height offset	HEIGHT_OFFSET_M	m	-1.7976931348623157E308 to 1.7976931348623157E308	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.
Max floors	MAX_FLOORS	integer	1 to 250	The maximum number 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.
Min floors	MIN_FLOORS	integer	1 to 250	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.
Monumental	MONUMENTAL	boolean	0 to 1	Whether this building is monumental. Monumental buildings can be disallowed for demolition by the zoning plan.
Slanting roof height	SLANTING_ROOF_HEIGHT	m	0 to 10	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.
Solar Panels	SOLAR_PANELS	Boolean	0 to 1	Attribute that determines whether a Building has solar panels or not.
Solid	SOLID	boolean	0 to 1	Whether a building is part of the DSM.
Zoning permit required	ZONING_PERMIT_REQUIRED	boolean	0 to 1	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.

Environment

Function value	Attribute	Unit	Range	Description
Bowen ratio	BOWEN_RATIO	ratio	0.001 to 10	The ratio between two forms of heat transfer between this building's surface and the atmosphere.
Critical infrastructure	CRITICAL_INFRASTRUCTURE	integer	0 to 10	Number indicating the critical infrastructure priority of a building in case of calamities.
Distance zone m	DISTANCE_ZONE_M	m	0 to 2000.0	The distance drawn in Distance Overlays by this building.
Disturbance distance m	DISTURBANCE_DISTANCE_M	m	0 to 2000.0	The distance drawn in the Distance Overlay by this building.
Foliage crown factor	FOLIAGE_CROWN_FACTOR	ratio	0 to 10	The ratio between the height of tree trunks and the radius of the foliage of the tree.
Heat effect	HEAT_EFFECT	°C	-10 to 10	The capacity of this building for heat retention.
Livability effect	LIVABILITY_EFFECT	decimal	-10 to 10	The effect this building has on the Livability Overlay calculations.
Safety distance m	SAFETY_DISTANCE_M	m	0 to 2000.0	The distance drawn in a Distance Overlay by this building.
Vegetation fraction	VEGETATION_FRACTION	fraction	0 to 1	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.

Network

Function value	Attribute	Unit	Range	Description
Pipes permitted	PIPES_PERMITTED	boolean	0 to 1	Whether net lines are allowed to be generated under this building.

Traffic

Traffic is split up into two further categories, to differentiate between traffic which may apply to Traffic Overlays and alternative types of traffic. Values are generally set based on data from Traffic Plugin.

Car traffic

Function value	Attribute	Unit	Range	Description
Buses per hour	NUM_BUSES	vehicles/h	0 to 1.7976931348623157E308	How many buses move over any given cross-section of the road per hour, spread across all lanes.
Cars per hour	NUM_CARS	vehicles/h	0 to 1.7976931348623157E308	How many cars move over any given cross-section of the road per hour, spread across all lanes.
Trucks per hour	NUM_TRUCKS	vehicles/h	0 to 1.7976931348623157E308	How many trucks move over any given cross-section of the road per hour, spread across all lanes.
Vans per hour	NUM_VANS	vehicles/h	0 to 1.7976931348623157E308	How many vans move over any given cross-section of the road per hour, spread across all lanes.
Bus jam factor	JAM_FACTOR_BUSES	fraction	0 to 1	The fraction of buses considered to be in traffic jam.
Car jam factor	JAM_FACTOR_CARS	fraction	0 to 1	The fraction of cars considered to be in traffic jam.
Truck jam factor	JAM_FACTOR_TRUCKS	fraction	0 to 1	The fraction of trucks considered to be in traffic jam.
Van jam factor	JAM_FACTOR_VANS	fraction	0 to 1	The fraction of vans considered to be in traffic jam.
Lanes	TRAFFIC_LANES	integer	-1.7976931348623157E308 to 1.7976931348623157E308	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.
Noise sigma	TRAFFIC_NOISE_SIGMA	dB(A)	-1.7976931348623157E308 to 1.7976931348623157E308	Difference in noise intensity of vehicles at their reference speed. Effectively a flat modifier in noise.
Noise tau	TRAFFIC_NOISE_TAU	dB(A)	-1.7976931348623157E308 to 1.7976931348623157E308	Difference in noise intensity of vehicles for every order of magnitude difference with their reference speed. Effectively a speed-dependent modifier in noise.
Speedlimit	TRAFFIC_SPEED	km/h	0 to 1.7976931348623157E308	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.

Other traffic

Function value	Attribute	Unit	Range	Description
Airplanes per hour	NUM_AIRPLANES	vehicles/h	0 to 1.7976931348623157E308	How many airplanes move over the given air traffic route, per hour.
Bicycles per hour	NUM_BICYCLES	vehicles/h	0 to 1.7976931348623157E308	How many bicycles move over the given bicycle traffic route, per hour.
Pedestrians per hour	NUM_PEDESTRIANS	pedestrians/h	0 to 1.7976931348623157E308	How many pedestrians move over the given route, per hour.
Ships per hour	NUM_SHIPS	vehicles/h	0 to 1.7976931348623157E308	How many ships move over the given ship traffic route, per hour.
Trains per hour	NUM_TRAINS	vehicles/h	0 to 1.7976931348623157E308	How many trains move over the given tracks, per hour.
Trams per hour	NUM_TRAMS	vehicles/h	0 to 1.7976931348623157E308	How many trams move over the tracks, per hour.

Water

Function value	Attribute	Unit	Range	Description
Connected to sewer area	SEWERED	boolean	0 to 1	Whether this building can be connected to a sewer.
Depth of plant roots	ROOT_DEPTH_M	m	0 to 1.7976931348623157E308	The depth of the roots of the plants of this building.
Drainage	DRAINAGE	m	-10 to 10	Whether this Building has drainage, which affects the calculation of the Subsidence Overlay.
Ground infiltration per day	GROUND_INFILTRATION_MD	m/day	0 to 10	The permeability of this building to water trying to infiltrate into the ground.
Manning Value	WATER_MANNING	s/(m1/3)	0.01 to 0.255	The Manning Value of the Building, which is a measure of roughness with regards to water flow.
Water transpiration	WATER_TRANSPIRATION_FACTOR	factor	0 to 1.7976931348623157E308	Factor indicating how much a building with a crop, tree or plant function facilitates transpiration and how much surface water evaporates. This factor is multiplied with the weather's evaporation rate at a particular time in the simulation.
Water microrelief	WATER_MICRORELIEF_M	m	0 to 0.255	The height and depth of microrelief hills, in which water can be stored.
Water storage	WATER_STORAGE_M2	m³/m²	0 to 1.7976931348623157E308	How much water can be stored in this building.

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.

Attributes added to a function value always apply to the building as a whole, and cannot be category-specific.

Examples of Function Attributes:

Icon	Attribute	Unit	Range	Description
	PRIVATE_YARD	boolean		Whether the building is a private yard belonging to a residence or private stakeholder.

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

See also

• Function Values Table
• Category Values
• Function
• Function Override
• Functionmult (TQL Param)

API Endpoints

• Api session event editor functionoverride set function value
• Api session event editor functionoverride reset values
• Api session event editor building set function value
• Api session event editor building reset function values

---

Current Situation

Current Situation

Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals •  Queries • Geo Import

Buildings

Function • Function Override • Section • Category • Custom Geometry • Category Value • Function Value • Function Values Table • List of Functions

Traffic

Unit Type • Unit Data • Unit Data Override

Terrain

Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override • List of Terrain Types

Administrative

Neighborhood • Zone • Permission Popup • Plot • Zip Code

Queries

Query Tool • Measurement

Geo Import

Source • GeoShare

Network

Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting

Editor

Current Situation • Future Design • Multi Scenario • Tools • Community