Indicator: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
 
(372 intermediate revisions by 18 users not shown)
Line 1: Line 1:
After reading this page
[[File:Api_current_situation_calculation.png|thumb|right|400px|[[Overlay]] in comparison to [[Measurement]]s, [[Indicator]]s and [[Global]]s]]
Indicators are named after Key Performance Indicators, which serve as a means to identify potential improvements and as a metric for the degree to which those improvements have been successful.


* You've learned what indicators are
Indicators are visible at the top of the [[interface]]. Each indicator is represented by a short name, and (with exception of the budget) is accompanied by a small progress bar to indicate how well you are performing on that indicator. Indicators can also be inspected by clicking on its element in the top bar, which opens the [[indicator panel]].
* You've learned what indicators exist in the Tygron Engine
* You've learned what other parts of a game can influence indicators
* You've learned how to alter existing indicators in your game
* You've learned how to add and remove complete indicators


==Indicators==
The progress made on an indicator depends on the ''absolute score'' setting of the indicator:
* When selected, the progress is based on the absolute score.
* When not selected, the progress is relative to the calculate score in the current situation. Such an indicator will measure the relative improvements.


Indicators are the themes for which targets exist in a game. They are named after Key Performance Indicators, a measure by which organizations evaluate their success. Key Performance Indicators serve as a means for identifying potential improvements, and as a metric for the degree to which those improvements have been successful.  
In the indicator panel, the indicator's full name is shown in the title, along with a description and indicator progress on the left. On the right part of this panel a calculated score and an ''explanation'' are shown. The score and ''explanation'' are produced by the indicator's [[Excel Sheet]]. Basically, this excel sheet should be able to calculate a score and an ''explanation'' and place this in designated excel sheet cells. The excel sheet is also able to obtain information from a project using [[TQL|Tygron Query Language (TQL)]] statements. For more in depth information on indicator excel sheets, see [[Excel]] and [[Excel indicator]].


==How indicators relate to the Tygron Engine==
[[File:Interface_game_indicator_panel.jpg|250px|left|thumb|The [[indicator panel]]. The left side displays the name, importance, and description of the indicator, as well as a graph showing its progress over time. The right side displays more information on the current situation and how to improve it.]]


Indicators are a primary part of your game, and serve as the guiding element by which [[Player|players]] can determine whether they are making progress. Just like Key Performance Indicators, indicators in the Tygron Engine serve as a means to identify how to improve the situation for your [[stakeholder]], and to what degree those improvements are effected by specific [[actions]].
[[File:Interface_indicator_panel_green.jpg|250px|thumb|center|The [[indicator panel]] of a green indicator from the [[GeoShare]]. For this indicator, the score graph is turned off. The indicator only calculates a score for [[Neighborhoods]] that are active.]]
{{clear}}
==Influencing Indicators==
During a session, users' actions can influence Indicators, directly by spatial adjustments and [[TQL|spatial TQL statements]] and indirectly through [[Grid Overlay]] results and subsequent [[TQL|Grid TQL statements]]. It is up to the users to adjust their actions to improve the score on their Indicators. Also note that an action can also have effects on personal indicators of other stakeholders. For example, if a project developer creates a large office park where there previously was a forest, the amount of green will go down, which will negatively affect the goals of a municipality.


==Indicators in the Tygron Engine==
[[File:Improving_green_indicator.jpg|thumb|left|250px|Improving the green indicator by planning a forest of deciduous trees. The improvement is shown in green in the [[Action log panel]].]]
[[File:Ui_-_topbar.jpg|framed|right|The top bar of the interface. The indicators are Budget, Building and Progress.]]
{{clear}}
Indicators are visible in-game at the top of the [[interface]]. Each indicator is represented by a short name, and (with exception of the budget) is accompanied by a small progress bar to indicate how well you are performing on that indicator.
The current situation (original) and maquette (planned) situation can be compared by switching between these situations using the buttons in the [[top bar]].
[[File:Current_situation_green_indicator.jpg|thumb|left|250px|Current situation of the green indicator when planning a forest of deciduous trees. Notice the selected ''original'' button in the [[top bar]].]]
[[File:Maquette_situation_green_indicator.jpg|thumb|center|250px|Maquette situation of the green indicator when planning a forest of deciduous trees. Notice the selected ''planned'' button in the [[top bar]].]]
{{clear}}


Each indicator has a name, a description, a color and a target. The target is the most important part of the indicator, because that is what drives a stakeholder to perform (or abstain from) an action. Each action a stakeholder takes is meant to advance their indicators.
==Indicators on the GeoShare==
You can also import indicators from the {{geoshare}}. There is a set of indicators made available in the {{Public Share}}. It is also possible to import indicators from {{geoshare}} of your [[domain]]. All indicators from the default public share have a page on the wiki with an additional explanation, which indicates if you need to add or edit something to your project when you import that indicator. For Example, some indicators make use of multiple [[Global]]s, an [[Overlay]] or [[Area]]s that needs to be implemented in order for the indicator to work.
<gallery heights=300px widths=300px>
File:Share_public_indicators_editor.png|The default indicators shown in the indicators tab in the editor.
File:Share_public_indicators.png|The indicators shown in the public {{geoshare}}.
</gallery>


===Types of indicator===
The available default indicators are listed below.
Some of these indicators already perform specific calculations and can be directly used in the project. They can also be [[Excel indicator|modified and extended with adjusted calculation]]s.


A number of indicator types already exist in the Tygron Engine. The available indicator types are dividable into 2 groups, namely indicators that are stakeholder-specific, and indicators that apply globally.
It is also possible to implement your own indicator, using an [[Excel|Excel file]]. This Excel file should be imported into your project and assigned to an indicator. Each added indicator is initially empty, and will require some work to set up, but it is highly customizable.


====Stakeholder-specific indicators====
==Relation to stakeholders==
By default, when adding an indicator, it is visible to and accessible by all stakeholders, through an icon in the [[top bar]]. Access to an indicator can be restricted when it is made personal; a link to a stakeholder can be configured for an indicator. This stakeholder is then considered the owner of the indicator.


;[[Budget (Indicator)|Budget]]
For more information on adding and removing indicators to stakeholders, see [[stakeholders]].
: The amount of money available to a stakeholder. Most actions in the Tygron Engine require money by default. Actions which require spending more money than the stakeholder has available is not allowed. Should the stakeholder end up with a negative budget, their final score will be 0 until their budget has restored.
;[[Building (Indicator)|Building]]
: The amount of constructions that a stakeholder must reach. The targets for this indicator are subdivided into different types of constructions, such as luxury housing, offices, green and leisure. This indicator is unique in that a player will be penalized for exceeding their goal.


====Global indicators====
This relationship between an indicator and its personal stakeholder can be queried using TQL with the [[Relation (TQL Param)|Relation parameter]]:
* Stakeholder name: <code>SELECT_NAME_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER</code>
* Stakeholder id: <code>SELECT_ID_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER</code>


;[[Green (Indicator)|Green]]
When using an excel for an Excel Indicator, you can also access the stakeholder directly using:
: Green is the amount of green in an area. More trees and open (grassland) areas increase the score for green. Buildings and concrete decrease the score for green.
* Stakeholder name: <code>SELECT_NAME_WHERE_STAKEHOLDER_IS_ID</code>
;[[Parking (Indicator)|Parking]]
* Stakeholder id: <code>SELECT_ID_WHERE_STAKEHOLDER_IS_ID</code>
: Parking is the amount of parking spaces in an area. Many buildings have an associated need for parking spaces in the area. By building parking facilities, the score on the parking indicator can be increased.
;[[Livability (Indicator)|Livability]]
: Livability is the extend to which an area is pleasant to live in. More open spaces, luxury buildings and green increase livability. Densification, poor quality buildings and lack of nature decrease livability.
;[[Water Storage (Indicator)|Water Storage]]
: The amount of water storage capacity in an area. A greater capacity for storing water means an area becomes more resilient when faced with rain. Areas of open water, water-permeable surfaces and other means of storage increase the score for water storage.


====Qualitative indicator====
[[File:Personal_heat_indicator.png|thumb|right| A personal heat indicator for the municipality. It is only visible in the top bar for this specific stakeholder.]]
The [[Qualitative (Indicator)|qualitative indicator]] is a unique indicator, in that it is the only indicator which does not have a special function or a pre-defined calculation model behind it. Instead, the qualitative indicator functions purely as a tally to which points can be assigned. When a game uses one or more qualitative indicators, the effects that actions have on the qualitative indicators must be explicitly defined. They are also the only global indicator of which multiple can be added to a game.


====Progress indicator====
{{article end
Lastly, each player also has a [[Progress (Indicator)|progress indicator]]. This indicator cannot be [[editor|altered]] directly. It sums up the scores achieved on the other indicators, based on their [[importance]].
|seealso=
* [[Excel Indicator]]
* [[TQL]]
|howtos=
* [[How to add, remove and duplicate an Indicator]]
* [[How to edit Indicator properties]]
* [[How to edit Indicator targets]]
* [[How to configure a Query for an Excel Indicator]]
* [[How to implement an Excel Indicator]]
* [[How to make the Green Garden Indicator]]
* [[How to manually adjust Indicators in Excel]]
* [[How to use the Query Tool to test queries from an Excel Indicator spreadsheet]]
* [[How to change Function Values for a Function]], to adjust the effects actions have on Indicators.
* [[How to make an Indicator visible to only one stakeholder]]
|videos=
{{video|youtube=Vv1XA3HCOyQ&t=734s}}
|external=
* [https://www.youtube.com/watch?v=Vv1XA3HCOyQ&t=734s TQL and Indicators Webinar]
}}


===Influencing Indicators===
{{Editor current situation nav}}
 
{{Indicator nav}}
During the game, players are able to influence indicators by taking actions. Almost every action has an effect on at least one indicator. It is up to the players to apply their actions appropriately to increase the score on their indicators.
[[Category:Items]][[Category:Indicator]]
 
==Editing Indicators==
 
There are two ways to change the indicators in your game. You can either edit existing indicators, or you can add or remove complete indicators from your game as required. To perform either task, you can open the "Indicators" panel from the "Indicators" menu in the editor.
 
[[Editor]]
&rarr; [[Editor Menu bar]]
&rarr; Indicators
&rarr; Indicators
 
[[File:Editor - indicators.jpg|framed|none|The indicator screen of the editor.]]
 
===Changing indicators===
 
In the indicators panel in the editor, you can select an existing indicator from the list on the left. The rest of the panel will automatically be filled with the information pertaining to that indicator. A number of properties pertaining to an indicator can be edited.
 
;Name
: The full name for indicator. This is the name that will appear as the title of the indicator in game.
;Short name
: The short name for indicator. This will appear in areas where multiple indicators are summed up.
;Color
: The color for the indicator. The color will be used to display the indicator in graphs and charts.
;Description
: The description for the indicator. Most indicator have a fitting default description, but by customizing this text it is possible to guide the players towards specific actions, provide hints or refer to other sources of information.
;Target
: The goal to reach for this indicator. This is the most important property, because by setting the target, you are directly instructing the stakeholder what they should strive for in the game. Depending on the selected indicator type, one or more values can be entered for targets. For example: for a budget indicator, you only need to set the amount of money the stakeholder should have remaining. For the building indicator, you can enter a separate target for each type of building.
 
===Adding/removing indicators===
 
By right-clicking in the list of indicators on the left side of the panel, you can open a menu where you can add and remove indicators. Hover over "Add indicator" to make a second menu appear. Here you can select an indicator to add to the game. If you select "Budget" or "Building", you will also have to select a stakeholder for which to add the indicator. With the exception of the qualitative indicator, you can add 1 indicator of each type (the stakeholder-specific indicators, of which you can add 1 per stakeholder).
 
By right-clicking on an indicator in the list on the left side of the panel, you can also choose to delete the indicator you have clicked on. This removes the indicator from the game, so that the players will no longer need to score on it.
 
===Changing the effect on indicators===
It is possible to adjust the effects actions have on indicators. For more information on this, please read about [[Function values|changing function values]].

Latest revision as of 09:19, 12 February 2024

Overlay in comparison to Measurements, Indicators and Globals

Indicators are named after Key Performance Indicators, which serve as a means to identify potential improvements and as a metric for the degree to which those improvements have been successful.

Indicators are visible at the top of the interface. Each indicator is represented by a short name, and (with exception of the budget) is accompanied by a small progress bar to indicate how well you are performing on that indicator. Indicators can also be inspected by clicking on its element in the top bar, which opens the indicator panel.

The progress made on an indicator depends on the absolute score setting of the indicator:

  • When selected, the progress is based on the absolute score.
  • When not selected, the progress is relative to the calculate score in the current situation. Such an indicator will measure the relative improvements.

In the indicator panel, the indicator's full name is shown in the title, along with a description and indicator progress on the left. On the right part of this panel a calculated score and an explanation are shown. The score and explanation are produced by the indicator's Excel Sheet. Basically, this excel sheet should be able to calculate a score and an explanation and place this in designated excel sheet cells. The excel sheet is also able to obtain information from a project using Tygron Query Language (TQL) statements. For more in depth information on indicator excel sheets, see Excel and Excel indicator.

The indicator panel. The left side displays the name, importance, and description of the indicator, as well as a graph showing its progress over time. The right side displays more information on the current situation and how to improve it.
The indicator panel of a green indicator from the GeoShare. For this indicator, the score graph is turned off. The indicator only calculates a score for Neighborhoods that are active.

Influencing Indicators

During a session, users' actions can influence Indicators, directly by spatial adjustments and spatial TQL statements and indirectly through Grid Overlay results and subsequent Grid TQL statements. It is up to the users to adjust their actions to improve the score on their Indicators. Also note that an action can also have effects on personal indicators of other stakeholders. For example, if a project developer creates a large office park where there previously was a forest, the amount of green will go down, which will negatively affect the goals of a municipality.

Improving the green indicator by planning a forest of deciduous trees. The improvement is shown in green in the Action log panel.

The current situation (original) and maquette (planned) situation can be compared by switching between these situations using the buttons in the top bar.

Current situation of the green indicator when planning a forest of deciduous trees. Notice the selected original button in the top bar.
Maquette situation of the green indicator when planning a forest of deciduous trees. Notice the selected planned button in the top bar.

Indicators on the GeoShare

You can also import indicators from the GeoShare. There is a set of indicators made available in the Public Share. It is also possible to import indicators from GeoShare of your domain. All indicators from the default public share have a page on the wiki with an additional explanation, which indicates if you need to add or edit something to your project when you import that indicator. For Example, some indicators make use of multiple Globals, an Overlay or Areas that needs to be implemented in order for the indicator to work.

The available default indicators are listed below. Some of these indicators already perform specific calculations and can be directly used in the project. They can also be modified and extended with adjusted calculations.

It is also possible to implement your own indicator, using an Excel file. This Excel file should be imported into your project and assigned to an indicator. Each added indicator is initially empty, and will require some work to set up, but it is highly customizable.

Relation to stakeholders

By default, when adding an indicator, it is visible to and accessible by all stakeholders, through an icon in the top bar. Access to an indicator can be restricted when it is made personal; a link to a stakeholder can be configured for an indicator. This stakeholder is then considered the owner of the indicator.

For more information on adding and removing indicators to stakeholders, see stakeholders.

This relationship between an indicator and its personal stakeholder can be queried using TQL with the Relation parameter:

  • Stakeholder name: SELECT_NAME_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER
  • Stakeholder id: SELECT_ID_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER

When using an excel for an Excel Indicator, you can also access the stakeholder directly using:

  • Stakeholder name: SELECT_NAME_WHERE_STAKEHOLDER_IS_ID
  • Stakeholder id: SELECT_ID_WHERE_STAKEHOLDER_IS_ID
A personal heat indicator for the municipality. It is only visible in the top bar for this specific stakeholder.