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

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 currently unused.
Extra color	EXTRA_COLOR	color	No	-2147483648 to 2147483647	The color of the walls of the floors of the building which are neither the top nor bottom floor.
Ground color	GROUND_COLOR	color	No	-2147483648 to 2147483647	The color of the walls of the bottom floor of a building.
Roof color	ROOF_COLOR	color	No	-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	No	0 to 1	The transparency of the ground color of the function.
Top color	TOP_COLOR	color	No	-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.

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
• How to add an Attribute to a Function
• How to change Attributes for a Function