Function Value

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.

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 start |- | 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 -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. 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.

|- | 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. Template:Table end

Construction

Template:Function values table start Category weight (Function Value) Construction time in months (Function Value)

Default floors DEFAULT_FLOORS integer 1 to 250 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).

Demolish time in months (Function Value) Floating (Function Value)

Floor height m FLOOR_HEIGHT_M m 0 to 1.7976931348623157E308 The height of each floor of the Building. Max floors MAX_FLOORS integer 1 to 250 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. 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.

Unit size (Function Value)

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

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.

Green space (Function Value)

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 (Function Value) Template:Table end

Financial

Template:Function values table start Buyout cost (Function Value) Construction cost (Function Value) Demolition cost (Function Value) Sell price (Function Value) Template:Table end

Network

Template:Function values table start Heat flow change per year (Function Value) Heat flow formula start year (Function Value) Heat flow to power multiplier (Function Value) Heat flow value at start year (Function Value)

Pipes permitted PIPES_PERMITTED boolean 0 to 1 Whether net lines are allowed to be generated under this building.

Traffic

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. 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.

Parking lots (Function Value) Parking lots demand (Function Value)

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.

Units per hour (Function Value) Template:Table end

Water

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/(m^1/3) 0.01 to 0.255 The manning value of the building, which is a roughness in 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 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 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

• How to add Functions for editing
• How to change Function Values for a Function