Function: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{learned|what functions are|how functions relate to the {{software}}|where functions are used|how to change existing functions|how to create your own functions}}
[[File:Api_current_situation_building.png|thumb|right|400px|[[Function]] related to [[Buildings]] and [[Function Overrides]]]]
 
Functions are the blueprints for [[Building]]s in your projects. They describe the purpose and basic [[Function Value|properties]] of [[Building]]s. A Function also references which model sets and colors are used in the 2D and 3D visualization. A Function is effectively a "type of Building".
==What are functions==
A function is the purpose of a type of building. The term function comes from urban planning jargon, when dealing with zoning plans.
 
==How do functions relate to the {{software}}==
Functions are the blueprints of [[Construction]]s in the [[3D world]]. They describe the purpose and [[Function Value|properties]] of [[Construction]]s. A Function also defines which 3D model is placed in the 3D world. A Function is effectively a "type of Construction".


The properties associated with a Function are known as [[Function Value]]s
The properties associated with a Function are known as [[Function Value]]s


Each Construction in a Project has a Function defining what kind of Construction it is. Constructions with the same Function may have different locations, different heights, and different owners. But Constructions with the same Function will have the same set of [[Function Value|properties]] defining their economic, environmental, and spatial effect.
A Building in a Project is always based on one Function. Buildings with the same Function may have different locations, different heights, and different owners. But Buildings with the same Function will have the same set of [[Function Value|properties]] defining their economic, environmental, and spatial effect.


Additionally, Functions can also be used as definitions for [[action]]s. When a Function is used as an Action, the Action will be the creation of a new Construction, the Function of which is the Function which is used as Action. Some properties of the Function, such as the minimum, maximum, and default amount of floors, also affect how a [[Stakeholder]] can enact their action.
Additionally, Functions can also be used as definitions for [[action]]s. When a Function is used as an Action, the Action will be the creation of a new Building, the Function of which is the Function which is used as Action. Some properties of the Function, such as the minimum, maximum, and default amount of floors, also affect how a [[Stakeholder]] can enact their action.


The {{software}} contains several hundred Functions.
The {{software}} contains several hundred Functions.
Line 17: Line 12:
===Function values===
===Function values===
{{main|Function Value}}
{{main|Function Value}}
Functions are composed of a collection of properties called [[Function Value]]s. These form the actual numeric definitions which are applied on a Construction which is set to be of a certain Function. In principle, when such a value of a Construction is required for a calculation, the value set in the Function is used. However, a Construction can have a Function Value overridden for itself. If the Construction in consideration for a calculation has an overridden Function Value, that overridden value will be used instead.
[[File:Function_value_table.png|thumb|left|[[Function Values Table]] in the [[editor]].]]
Functions are composed of a collection of properties called [[Function Value]]s. These form the actual numeric definitions which are applied on a Building which is set to be of a certain Function. In principle, when such a value of a Building is required for a calculation, the value set in the Function is used.


A complete list of all available Function Values can be found on the [[Function Value]]s page.
A complete list of all available Function Values can be found on the [[Function Value]]s page.
{{clear}}


===Function Categories===
===Function Categories===
[[File:Function-selector.jpg|300px|thumb|left|The function selection window. This will appear whenever you need to a select a function.]]
[[File:Function-selector.jpg|300px|thumb|left|The function selection window. This will appear whenever you need to a select a function.]]
Functions are divided into Function Categories. Where a Function itself may be "Old Warehouses", such a Function may belong to a Function Category "Industry". This categorization helps when trying to select a specific Function among the full collection of Functions. It also makes it easier to [[TQL|query]] Constructions in a Project but filtering on the purposes of the Construction. Rather than creating individual queries for each Function which matches a broad usage for Constructions, a single query for a Function Category can be used.
Functions are divided into Function Categories. Where a Function itself may be "Old Warehouses", such a Function may belong to a Function Category "Industry". This categorization helps when trying to select a specific Function among the full collection of Functions. It also makes it easier to [[TQL|query]] Buildings in a Project but filtering on the purposes of the Building. Rather than creating individual queries for each Function which matches a broad usage for Buildings, a single query for a Function Category can be used.


Functions are always part of at least one Category, but can also be part of multiple functions. An example is a Function for a Construction with shops at a bottom floor, but residences on floors above it. Or flats which contain a mix of both social and luxury housing. In these cases, the Function's Categories each have a respective [[weight]]. The Construction will be considered wholly of the specified Function, but the Construction will be considered "divided up" between the Categories when querying, for example, their floor size.{{clear}}
Functions are always part of at least one Category, but can also be part of multiple functions. An example is a Function for a Building with shops at a bottom floor, but residences on floors above it. Or flats which contain a mix of both social and luxury housing. In these cases, the Function's Categories each have a respective weight. The Building will be considered wholly of the specified Function, but the Building will be considered "divided up" between the Categories when querying, for example, their floor size.{{clear}}


'''Categories: '''
'''Categories: '''
Line 39: Line 36:
| SOCIAL
| SOCIAL
| yes
| yes
|  
| Affordable housing contains actions related to affordable housing: Flats (various types), Old social housing (various types), Social housing (various types), etc.
|-
|-
| Agriculture
| Agriculture
| AGRICULTURE
| AGRICULTURE
|  
|  
|  
| Agriculture contains actions related to agriculture: Floating crops, Farms, Corn Fields etc.
|-
|-
| Bridge
| Bridge
Line 54: Line 51:
| EDUCATION
| EDUCATION
| yes
| yes
|  
| Education contains actions related to educational buildings: Basis educational buildings, emergency classrooms, labs, primary schools etc.
|-
|-
| Gardens
| Gardens
| GARDEN
| GARDEN
|  
|  
|  
| Gardens contains actions related to gardens: Simple Garden, Normal Garden, Fenced Garden, etc.
|-
|-
| Healthcare
| Healthcare
| HEALTHCARE
| HEALTHCARE
| yes
| yes
|  
| Healthcare contains actions related to healthcare: Healthcare farm, Healthcare hotel, Hospital, etc.
|-
|-
| Industry
| Industry
| INDUSTRY
| INDUSTRY
| yes
| yes
|  
| Industry contains actions related to industrial buildings: Biorefinery, Silo's, Warehouses, Chimney, etc.
|-
|-
| Intersection
| Intersection
Line 79: Line 76:
| LEISURE
| LEISURE
|  
|  
|  
| Leisure contains actions related to leisure buildings: Sports center, Swimming Pool, Theatre, Tennis Court, etc.
|-
|-
| Market housing
| Market housing
| NORMAL
| NORMAL
| yes
| yes
|  
| Market Housing contains actions related to market housing: different types of housing, apartments, shops with houses, etc.
|-
|-
| Nature
| Nature
| NATURE
| NATURE
|  
|  
|  
| Nature contains actions related to nature: Trees, Orchard, Reeds.
|-
|-
| Offices
| Offices
| OFFICES
| OFFICES
| yes
| yes
|  
| Offices contains actions related to Offices: Classic Offices, Luxurious Offices, Old Offices, Offices with shops, etc.
|-
|-
| Other
| Other
| OTHER
| OTHER
|  
|  
|  
| Other contains assorted actions: Cemetery,  Trash bins, Windmill and a few others.
|-
|-
| Parks
| Parks
| PARK
| PARK
|  
|  
|  
| Parks contains actions related to Parks: City Park, Fountain, Pocket Park, Vegetable garden, etc.
|-
|-
| Roads
| Roads
| ROAD
| ROAD
|  
|  
|  
| Roads contains actions related to infrastructure and roads: Asphalt roads (various types), Bicycle path, Cobblestone roads, Train tracks, etc.
|-
|-
| Senior housing
| Senior housing
| SENIOR
| SENIOR
| yes
| yes
|  
| Senior Housing contains actions related to senior housing: Senior Housing (Standard) and Senior Housing (Luxurious).
|-
|-
| Shops and restaurants
| Shops and restaurants
| SHOPPING
| SHOPPING
| yes
| yes
|  
| Shops and restaurants contains actions related to shops and restaurants: Chip shop, Convenience store, Office with shops, Houses with Shops, etc.
|-
|-
| Squares
| Squares
| PAVED_AREA
| PAVED_AREA
|
|
|  
| Squares contains actions related to public Squares: Parking Spaces, Playground, Watersquare, Skate park etc.
|-
|-
| Student housing
| Student housing
| STUDENT
| STUDENT
| yes
| yes
|  
| Student Housing contains actions related to student housing: Cheap student housing, Student Housing (various types), Student Containers, etc.
|-
|-
| Top market housing
| Top market housing
| LUXE
| LUXE
| yes
| yes
|  
| Top Market Housing contains actions related to luxurious housing: Luxury Apartments, Modern Villa, Old Villa, Monumental House, etc.
|-
|-
| Underground
| Underground
| UNDERGROUND
| UNDERGROUND
|  
|  
|  
| Underground contains an action related to underground: Drainage Culvert.
|}
|}


Line 150: Line 147:
'''Regions: '''
'''Regions: '''


Currently the {{software}} distinguishes the following Regions:
Currently the {{software}} distinguishes the following regions:
* Africa
* Africa
* Asia
* Asia
Line 157: Line 154:
* Other
* Other


==How-to's==
{{article end
|howtos=
* [[How to add Functions for editing]]
* [[How to add Functions for editing]]
* [[How to create Functions]]
* [[How to create Functions]]
* [[How to change Function Values]]
* [[How to change Function Values for a Function]]
* [[How to add an Attribute to a Function]]
* [[How to change Attributes for a Function]]
* [[How to add a Category to a Function]]
* [[How to add a Category to a Function]]
* [[How to remove a Category from a Function]]
* [[How to remove a Category from a Function]]
* [[How to change the Category of a Function]]
* [[How to change the Category of a Function]]
* [[How to adjust Building Costs]]
|seealso=
*[[Function Override]]
*[[Function Values Table]]
}}


<!--
{{Template:Editor_current_situation_nav}}
==Editing Functions==
{{Editor location|Function Values}}
All Functions in the {{software}} can be edited, and new Functions can be created based on pre-existing ones. By default, a small list of Functions is available for editing.
[[File:Function_values_screen.jpg|thumb|750px|left|The Function Values window.]]
{{clear}}
 
===Adding Functions for editing===
The default list of Functions does not include all Functions available in the {{software}}. It is possible to add additional functions to the overview of editable functions. When they are added, their properties can be altered as desired.
 
{{Editor steps|title=add a Function for editing|Click "Add".|Select the desired Function in the Function selection window, and "Apply".|Find the Function in the name column list in the "Function Values" panel.}}
 
===Creating new Functions===
It's possible to create new Functions based on existing Functions by duplicating an existing function. The properties of the new Function can then be changed independently of the old Function.
 
{{Editor steps|title=create a new Function through duplication|Select a function from the list to use as original.|Press "Duplicate".|Find the duplicate function at the bottom of the list.}}
 
===Changing Function Values===
{{main|Function Value}}
When a Function is added to the list of Functions, its name and [[Function Value]]s can be modified.
{{Editor steps|title=change Function Values |If the desired Function is not yet present in the list, {{inlink|Adding Functions for editing|add the Function}} to the list.|Find the column with the property you wish to change.|Change the value in the row of the function and the column of the property.}}
'''Note: When a Function has multiple Categories, some [[Category Value|Function Value]]s can also have different values per Category for the same Function.'''
[[File:Function_values_screen_edit_value.jpg|thumb|left|950px|Editing the construction cost for the function "Roads".]]{{clear}}
 
===Changing Categories of Functions===
Functions can be part of multiple Categories at once. By assigning a Function a second Category, and then removing the original Category, a Function's Category can be changed entirely.
 
{{Editor steps|title=add Categories to Functions|If the desired Function is not yet present in the list, {{inlink|Adding Functions for editing|add the Function}} to the list.|Select the Function to which you wish to add a Category.|Select the desired Category using the drop down box at the bottom.|Select "Add Category".}}
{{Editor steps|title=remove Categories from Functions|Ensure the Function, from which you wish to remove a Category, has at least two Categories.|Select the Category of the Function you wish to remove.|Press "Delete Category".}}
 
Remember that each Function should have at least one Category. It is not possible to remove the last Function Category from a Function.
 
 
 
 
 
===Function values===
{{Editor location|Function Values}}
[[File:Function_values_screen.jpg|thumb|750px|left|The function values window.]]<br clear=all>
 
Each function has a predefined set of properties. Those properties can be changed directly in the function values window by changing the value in the column (Generally to a different numeric value, unless otherwise specified):
 
; Name
: ''The name of the function. This is displayed in the legend in the [[interface]] to indicate what kind of [[constructions|construction]] something is, and as the name for [[actions]] which place constructions with this function in the world.'' This value does not need to be a numeric value. Instead, you can use letters, numbers and certain symbols.''
 
; Category
: ''The category of the function. Each function has a category. The category to which the function belongs is a group for all functions which belong to this category. One function can have multiple categories, for example buildings which are part house and part shop would have both "Housing" and "Shops and Restaurants" as a category. '' The available function categories are predefined, so only a select number is available.''
 
: ''For information on adding and removing categories see: [[Functions#Changing_categories_of_functions|Adding and removing Categories from functions]]
 
; Buyout Cost M2 (€ / $ per floor space)
: ''The costs to vacate a building with this function. This is the amount a stakeholder will have to pay per m² to remove a building with this function if the building is not vacant, in addition to the "Demolish costs".''
 
; Category Weight (0-1 (%))
: ''Each function has a category weight. The category weight is a percentage of the category function belongs. All functions have 1 category by default, meaning the Category Weight is 1 for all functions. Once multiple categories have been added, both categories can have their own weight, 0.2 for the Affordable Housing Category (meaning 20%) 0.8 for Shops and Restaurants (meaning 80%). ''
; Construction cost per floor space (€ / $ per floor space)
: ''The costs to create a building with this function. This is the amount a stakeholder will have to pay per m² to construct a building with this function.''
 
; Construction time in months
: ''The amount of time it takes to construct a building with this function. This is only used in [[Simulation Type|timeline]] projects.''
 
; Default floor height
: ''The default height for a single floor of this building. A higher value means each floor of the building will be taller.''
 
; Default  floors
: ''The default amount of floors when a participant wishes to build this building. A participant is free to set the amount of floors of the building to any value between "minimum amount of floors" and "maximum amount of floors", using a slider. When the option is presented, the slider starts at this value. This value should be higher than or equal to the "Minimum amount of floors", and lower than or equal to the "Maximum amount of floors".''
 
; Demolish costs per floor space (€ / $ per floor space)
: ''The costs to demolish a building with this function. This is the amount a stakeholder will have to pay per m² to remove a building with this function. Note that for not vacant buildings, a stakeholder will also have to pay the "Buyout costs".''
 
; Demolish time in months
: ''The amount of time it takes to demolish a building with this function. This is only used in [[Simulation Type|timeline]] projects.''
 
; Distance Zone (m)
: ''The required safety distance for this function in the event.''
 
; Drainage
: ''The effect on the ground water levels. A negative value means passive drainage. A positive value means active drainage. For more information, see [[Subsidence (Overlay)]].''
 
; Green per floor space
: ''The amount of m² of green per m² of a building with this function. A value of "1.0" means the function is entirely green. "0.4" means 40% of the area drawn is green.''
 
; Heat effect (Environment effect (Minimum -10 / Maximum +10 °C)
: ''The amount of ambient heat caused by this function. Lower is better.''
 
; Heat flow M² / year
: ''The amount of usable heat produced or required by this function. (Currently not used)''
 
; Livability (Minimum -10 / Maximum +10)
: ''The effect of a building with this function on the livability of the area. This is used in combination with the [[Livability (Indicator)|livability indicator]] and [[Quality_of_Life_(Overlay)|livability overlay]]. A higher value is better.''
 
; Max  floors
: ''The maximum amount of floors a building with this function can have, Some functions, such as roads or parks, are only 1 floor high. Buildings such as townhouses are usually not any taller than 3 or 4 floors. A participant can vary the amount of floors from this value downwards (including this value), down to the "Minimum amount of floors". This value cannot be lower than the "Minimum amount of floors".
 
; Min floors
: ''The minimum amount of floors a building with this function must have. Some functions, such as apartments or skyscrapers, could be built with just 1 floor, but that would not make sense logically given the type of building. A participant can vary the amount of floors from this value upwards (including this value), up to the "Maximum amount of floors". This value cannot be higher than the "Maximum amount of floors".''
 
; Noise sigma
: see [[Traffic_Model|Traffic Model]]
 
; Noise tau
: see [[Traffic_Model|Traffic Model]]
 
; Parking lots
: "the actual amount of parking space (m2) that is available for this building type."
 
; Parkinglots per floor space
: ''The amount of parking spaces this function provides by surface area. If a negative number is used, this function increases the demand for parking spaces.''
 
; Unit size
: ''How much floor space constitutes a single unit. Larger, more luxurious houses typically have more floor space. If the amount of floor space per house is 140m², a housing construction with 560m² of floor space will be 4 houses.''
 
; Units per hour
: see [[Traffic_model|Traffic Model]]
 
; Safety Distance
: ''The required safety distance for this function in the event of flooding. (Currently not used)''
 
; Sell price per floor space
: ''The amount of money received per m² when a building with this function is created. When a building is constructed, the stakeholder receives this money automatically.''
 
; Slanting roof height
: ''The height of the center of the roof for this function. A higher value means the roof will be steeper. This is only a visual adjustment and does not influence calculations. However, it is possible to take the slanting roof hight as a value into account in a calculation. This needs to be changed in the calculation manually.''
 
; Traffic Flow
: ''When [[units]] make use of this function as a road, a greater value for traffic flow means more vehicles will be on the road at the same time.''
 
; Traffic Lanes
: ''When [[units]] make use of this function as a road, this is the amount of lanes the vehicles will use.''


; Traffic Speed
[[Category:Items]]
: ''When [[units]] make use of this function as a road, a greater value for traffic speed means vehicles will travel across the road faster.''
; Water storage per floor space
: ''The amount of water a building with this function can store. This is used in combination with the [[Water Storage (Indicator)|water storage indicator]]. Water storage achieved this way is counted as "innovative" water storage.''
; Zoning permit required
: ''Whether constructing a building with this function needs to be approved by the municipality. If set to "1.0", the municipality can deny the construction of a building with this function. If set to "0.0", the building is automatically approved when the acting stakeholder [[ownership|owns]] the land and construct the building in the proper zone.''
-->

Latest revision as of 14:08, 29 February 2024

Function related to Buildings and Function Overrides

Functions are the blueprints for Buildings in your projects. They describe the purpose and basic properties of Buildings. A Function also references which model sets and colors are used in the 2D and 3D visualization. A Function is effectively a "type of Building".

The properties associated with a Function are known as Function Values

A Building in a Project is always based on one Function. Buildings with the same Function may have different locations, different heights, and different owners. But Buildings with the same Function will have the same set of properties defining their economic, environmental, and spatial effect.

Additionally, Functions can also be used as definitions for actions. When a Function is used as an Action, the Action will be the creation of a new Building, the Function of which is the Function which is used as Action. Some properties of the Function, such as the minimum, maximum, and default amount of floors, also affect how a Stakeholder can enact their action.

The Tygron Platform contains several hundred Functions.

Function values

Main article: Function Value
Function Values Table in the editor.

Functions are composed of a collection of properties called Function Values. These form the actual numeric definitions which are applied on a Building which is set to be of a certain Function. In principle, when such a value of a Building is required for a calculation, the value set in the Function is used.

A complete list of all available Function Values can be found on the Function Values page.

Function Categories

The function selection window. This will appear whenever you need to a select a function.

Functions are divided into Function Categories. Where a Function itself may be "Old Warehouses", such a Function may belong to a Function Category "Industry". This categorization helps when trying to select a specific Function among the full collection of Functions. It also makes it easier to query Buildings in a Project but filtering on the purposes of the Building. Rather than creating individual queries for each Function which matches a broad usage for Buildings, a single query for a Function Category can be used.

Functions are always part of at least one Category, but can also be part of multiple functions. An example is a Function for a Building with shops at a bottom floor, but residences on floors above it. Or flats which contain a mix of both social and luxury housing. In these cases, the Function's Categories each have a respective weight. The Building will be considered wholly of the specified Function, but the Building will be considered "divided up" between the Categories when querying, for example, their floor size.

Categories:

Currently the Tygron Platform distinguishes the following Function Categories:

Category TQL Term Combinable Description
Affordable housing SOCIAL yes Affordable housing contains actions related to affordable housing: Flats (various types), Old social housing (various types), Social housing (various types), etc.
Agriculture AGRICULTURE Agriculture contains actions related to agriculture: Floating crops, Farms, Corn Fields etc.
Bridge BRIDGE
Education EDUCATION yes Education contains actions related to educational buildings: Basis educational buildings, emergency classrooms, labs, primary schools etc.
Gardens GARDEN Gardens contains actions related to gardens: Simple Garden, Normal Garden, Fenced Garden, etc.
Healthcare HEALTHCARE yes Healthcare contains actions related to healthcare: Healthcare farm, Healthcare hotel, Hospital, etc.
Industry INDUSTRY yes Industry contains actions related to industrial buildings: Biorefinery, Silo's, Warehouses, Chimney, etc.
Intersection INTERSECTION
Leisure LEISURE Leisure contains actions related to leisure buildings: Sports center, Swimming Pool, Theatre, Tennis Court, etc.
Market housing NORMAL yes Market Housing contains actions related to market housing: different types of housing, apartments, shops with houses, etc.
Nature NATURE Nature contains actions related to nature: Trees, Orchard, Reeds.
Offices OFFICES yes Offices contains actions related to Offices: Classic Offices, Luxurious Offices, Old Offices, Offices with shops, etc.
Other OTHER Other contains assorted actions: Cemetery, Trash bins, Windmill and a few others.
Parks PARK Parks contains actions related to Parks: City Park, Fountain, Pocket Park, Vegetable garden, etc.
Roads ROAD Roads contains actions related to infrastructure and roads: Asphalt roads (various types), Bicycle path, Cobblestone roads, Train tracks, etc.
Senior housing SENIOR yes Senior Housing contains actions related to senior housing: Senior Housing (Standard) and Senior Housing (Luxurious).
Shops and restaurants SHOPPING yes Shops and restaurants contains actions related to shops and restaurants: Chip shop, Convenience store, Office with shops, Houses with Shops, etc.
Squares PAVED_AREA Squares contains actions related to public Squares: Parking Spaces, Playground, Watersquare, Skate park etc.
Student housing STUDENT yes Student Housing contains actions related to student housing: Cheap student housing, Student Housing (various types), Student Containers, etc.
Top market housing LUXE yes Top Market Housing contains actions related to luxurious housing: Luxury Apartments, Modern Villa, Old Villa, Monumental House, etc.
Underground UNDERGROUND Underground contains an action related to underground: Drainage Culvert.

Regions

The region selector, to filter the available functions.

To further help with finding the appropriate Function, they are also divided into regions. Based on the location of the Project, the region for the Project is set automatically. Some Functions are only available in certain regions. This is based on what region of the world the Function would be most appropriate for.

When selecting a Function, it is possible to change the region of the Project to gain access to the Functions of other regions. It is possible to Mix Functions of various regions freely.

Regions:

Currently the Tygron Platform distinguishes the following regions:

  • Africa
  • Asia
  • North America
  • Northwestern Europe
  • Other

How-to's

See also

Editor ribbon icon current.pngCurrent Situation
Current Situation
Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals •  Queries • Geo Import
Buildings
Function • Function Override • Traffic Units
Terrain
Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override
Administrative
Neighborhood • Zone • Permission Popup • Plot • Zip Code
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
Retrieved from "https://support.tygron.com/w/index.php?title=Function&oldid=59834"