Function: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Line 12: Line 12:


==Function usage==
==Function usage==
There are two ways functions can be used. Primarily, a function is used
Primarily, a function is used to define the properties of a construction when the [[3D World]] is being created.


Functions are also used as definitions for [[actions]]. When defining actions, each function can be found under their related category (or categories). For more information on adding functions as actions to stakeholders, see the [[actions#Editing categories and actions|editing section of actions]].


==Changing functions==
==Changing functions==

Revision as of 09:18, 24 August 2014

Template:Learned

Functions

A function is a purpose or destination for something. In the context of spatial planning, a function specifically indicates the purpose of a building or other type of construction. A corporate skyscraper has an "office" function. A house has a residential function. A park has a leisure function.

How functions are implemented in the Tygron Engine

In the Tygron Engine, functions are used to refer to specific types of building. Every construction has assigned to it what type of construction it is, in the form of a function. Functions can also exist separately from constructions, as a definition of a type of building. Although many functions may exist in a game, not all functions need to be used.

Each function also has at least one category. The category of a function most closely relates to the usual definition of a building's function. To illustrate: in the Tygron Engine, you can create housing of the function "Luxury villa". The category of that function would be "Top-market housing". Similarly, the function of "Deciduous Trees" would be of the category "Nature".

Functions can also have multiple categories. The pre-existing functions in the Tygron Engine are all of exactly one category. However, it is possible to add different categories to a function. In this manner, it is possible to create types of buildings which are, for example, part shop and part housing.

Function usage

Primarily, a function is used to define the properties of a construction when the 3D World is being created.

Functions are also used as definitions for actions. When defining actions, each function can be found under their related category (or categories). For more information on adding functions as actions to stakeholders, see the editing section of actions.

Changing functions

This section deals with changing the values of the function itself. For changing the function of a construction, see changing constructions.


The function values editing screen.

Adding functions for editing

By default, functions are not yet available for editing. To edit them, they must first be added to the "Function Values" panel. When they are added, their properties can be altered as desired. Adding functions can be done by following these steps:

How to add a function for editing:
  1. Click "Add".
  2. Select the desired function in the function selection window.
  3. Find the function in the list in the "Function Values" panel.

Adding new functions

It is possible to create new functions by duplicating existing functions. The properties of these duplicated functions can be changed separately from the original function. A function can be duplicated as often as desired. Adding new functions can be done by following these steps:

How to add a new function:
  1. Select a function from the list to use as template.
  2. Press "Duplicate".
  3. Find the duplicated function at the bottom of the list.

Changing functions

There are multiple ways existing functions can be changed.

Changing categories of functions

It is possible to supplement the category of a function with one or more additional categories. This means it's possible to create buildings which, for example, are part house and part shop. This can be done by following these steps:

How to add categories to functions:
  1. If the desired function is not yet present in the list, add the function to the list.
  2. Select the function of which you wish to change or add a category.
  3. Select the desired category using the drop down box at the bottom.
  4. Press "Add category".
How to remove categories from functions:
  1. Ensure the function, from which you wish to remove a category, has at least two categories.
  2. Select the category of the function you wish to remove.
  3. Press "Delete category".

If you wish to change the category of a function from one category to another, first add the category you wish to have assigned to the function, and then remove the category you do not wish to have assigned to the function. You can not remove the last category of a function. Each function must have at least one category.

Changing properties

Each function has a number of properties which can be changed.

How to change the properties of functions:
  1. If the desired function is not yet present in the list, add the function to the list.
  2. Find the column with the property you wish to change.
  3. Change the value in the row of the function and the column of the property.

Note: When a function has multiple categories, some properties can also have different values per category for the same function.

Editing the floor area of Social Housing.


The following properties can be changed directly, 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 building 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.
Floor area per unit
How much floor space constitutes a single unit. This is used to calculate the "amount" of a building by floor space. For example, if the amount of floor space per house is 150m², a social housing construction with 680m² of floor space will be 4 houses.
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.
Construction cost
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.
Demolish costs
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".
Buyout costs
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".
Sell price
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.
Livability effect
The effect of a building with this function on the livability of the area. This is used in combination with the livability indicator and livability overlay. A higher value is better.
Water storage
The amount of water a building with this function can store. This is used in combination with the water storage indicator. Water storage achieved this way is counted as "innovative" water storage.
Green
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.
Minimum amount of 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 player 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".
Default amount of floors
The default amount of floors when a player wishes to build this building. A player 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".
Maximum amount of 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 player 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".
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 owns the land and construct the building in the proper zone.

Changing effects on custom indicators

How to change the effect of functions on custom indicators:
  1. If the desired function is not yet present in the list, add the function to the list of function values.
  2. Find the column with the indicator for which you wish to change the effects.
  3. Change the value in the row of the function and the column of the property value.


Changing the effect of offices on the economy indicator.


For each custom indicator in the game, two properties exist. Each property has its own column in this panel.

Indicator
The effect on the custom indicator. For each 100m² of a function that exists in the game area, this value is added to the indicator. You can change this value by changing the numerical value in this field.
Indicator (cumulative to max)
The maximum effect of this function on the custom indicator. No more then this value can be achieved with this function alone. If the total effect would exceed this value, the effect is capped at this value, and constructing more of the same function does not have any more effect. You can change this value by changing the numerical value in this field.