Action: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
mNo edit summary
 
(80 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{learned|file=ActionsLogo.jpg|what actions are|what menus are|how actions can influence indicators|how to add and remove actions to a stakeholder}}
[[File:Api_future_design.png|thumb|right|400px|All available types of [[Action]]s]]


==Actions==


An action is an activity a stakeholder can perform to achieve their [[objective]]. A typical example of an action would be a housing corporation constructing social housing, or a water board realizing open water.
An action is an activity a [[stakeholder]] can perform to potentially achieve their objectives. A typical example of an action would be a housing corporation constructing social housing, or a water board realizing open water.


==How actions relate to the Tygron Engine==
Actions can be grouped together using [[Action Menu]]s. In the [[viewer ]]interface, Action menu that are available to a [[stakeholder]] are shown in the [[Action menu panel]] found the left part of the viewer interface. Selecting an Action Menu from the Action menu panel opens the Action panel, which provides options to plan an Action.
When a user plans an action, it will influence the 3D World and have a certain effect on [[indicators]]. The effect of the planned action simulates the effect the action would have in the real world. When a stakeholder plants new trees, this action would have an effect on the [[Livability (Indicator)|Livability indicator]]. Actions are tied to specific stakeholders, referring to the capability each stakeholder has to influence the [[3D World]]. The waterboard has the capability to create water, but not social housing or roads. Since a user can have a lot of different actions available to reach their [[objective]], actions are organized into [[#Menus|menus]].  


===Predefined Actions===
When a user plans an action, it changes the future situation and will often have an effect on [[overlays]] and [[indicators]]. For example, when a stakeholder plants new trees, this action will have an effect on the [[Livability (Overlay)|Livability overlay]] and consequently on the [[Livability (Indicator)|Livability indicator]].


A lot of predefined actions are available in Tygron Engine. Not all those actions have to be available to the users in all projects. Project created in the Tygron Engine have a primary focus on urban planning. Most of the available actions are construction options, which constitute the placement of constructions based on available [[functions]].
Actions taken are tied to specific stakeholders, allowing the recording of costs and incomes. As an example, the waterboard can be configured to have the capability to create waterways, but not social housing or roads. Since a stakeholder can be configured to have access to many different actions available, actions are organized using [[#Action Menus|Action menus]].  


For more information about all the actions available in the Tygron Engine, see the [[list of actions]]
[[Planned situation|Planned actions]] are generally not final. They can be canceled by the stakeholder that performed the action and sometimes be reverted by stakeholders that own the property. For reverting actions, see [[#Special Actions]]


===Effects of Actions===
Each action is logged in the [[Action Log]], which can be used to trace back which actions have been taken during a [[session]] or [[test run]].
Because there are various types of actions that could be made available, there is also a variety of effects that actions could have.


====Construction Actions====
{{clear}}
Most actions, when planned by the stakeholder, will place a construction in the 3D World and will have an effect on at least one or more indicators. Each construction with a [[Financial System#Costs|cost]] will negatively affect the acting stakeholder's [[Budget (Indicator)|budget]]. Constructions such as parks and green roofs will positively affect the [[Green (Indicator)|green indicator]]. The effect on the indicator is determined by that construction's [[function]].
===Types of Actions===
A lot of predefined actions are available in {{software}}. Each project can have its own set of available actions. Furthermore, not every action has to be available for each [[stakeholder]]. Since Projects created in the {{software}} have their focus primarily on urban planning, most of the available actions are construction options. These options allow stakeholders to plan constructions based on available [[functions]].


For changing the effects of the constructions on the indicators, see [[functions]].
This section describes the types of actions that can be taken and what effect they will have when planned in your project.


====Special Actions====
Actions that require a drawn selection:
Examples of actions that do not place or remove an element in the 3D world, and thus do not have an associated construction action, include money transfer, buy and sell land, [[demolish]], and the [[inbox]]. These actions are grouped together as [[list of option groups#Special Actions|Special actions]].
* [[Function]]s.
: ''The most common type of action, the [[function]], can be applied to your project by drawing a selection. When applied, a [[building]] with that function will be planned in your project.''
* [[Upgrade Type|Upgrade]]s
: ''[[Buildings]] can be upgraded using [[Upgrade Types]], provided an upgrade definition exists within that Upgrade Type which applies to that building's [[function]]. Upgrades can be used to improve the building to a related function, or to change the building to a completely different function [[category]].''
* [[Levee]]s
* [[Attribute action]]s
: ''Similar to upgrades, although these actions do not change the function of a building. Instead, they set particular attribute values. These values can be set (at locked) by the creator of the action, or be configured by stakeholders applying these actions.''
* [[Special Option]]s:
: ''These are actions that have a functionality that cannot be further configured.
** [[Demolish]] and [[demolish underground]]
** [[Revert]]
** [[Raise land]] and [[Lower land]]
** [[Buy land]] and [[Sell land]]


====Upgrades and Dikes====
Actions that open an additional panel:
Besides placing constructions, a user may also opt to [[Upgrades|upgrade]] buildings or place [[Dike Types|levees]] in the 3D world. These need to be defined before they can be added to a stakeholder's action menu. Upgrades always have a function associated with it, and dikes can have functions associated with them. The effects of these actions depend on the functions, in a similar fashion as constructions.
* [[Finance view]]
* [[Transfer money]]


====Measures and Events====
Actions that will be applied directly:
[[Measures]] and [[event]]s also need to be defined before they can be added to a stakeholder's action menu. Events simply cause other things to happen during the session when they are activated. Measures may have a variety of effects.
* [[Measure]]s
* [[Event bundle]]s


===Menus===
====Impact of Actions====
For each stakeholder, their actions are organized into menus. Similar actions, such as creation of infrastructure (roads, traintracks, etc) or housing (villas, apartments, etc), can be grouped together into the same menu. By roughly matching the actions in a menu to the indicators relevant to the stakeholder, it is possible for users to weigh choices of actions against each other easily.
Most actions have effects on buildings; planning new or demolishing or upgrading them. This will often have an effect on one or more indicators. Each action on a building has a [[Financial System#Costs|cost]] that will negatively affect the acting stakeholder's [[Budget (Indicator)|budget]].


Action menus can also be shared between stakeholders. This means that two or more stakeholders can have access to the same menu, and to the same actions within that menu. An example of a menu that could be shared among stakeholders would be a menu with financial actions, such as the ability to transfer money. Having a menu shared with another stakeholder has no effect on the usability of a menu or the actions therein.
For changing the effects of the buildings on the indicators, see [[functions]].


==Changing actions and menus==
====Measures and Events====
{{Editor ribbon|header=Stakeholders|bar=Actions}}
[[Measures]] and [[event]]s also need to be defined before they can be added to a stakeholder's action menu. Events simply cause other things to happen during the session when they are activated. Measures may have a variety of effects.
 
In the editor, you can add, remove and reorganize actions and action menus in the project as desired. The panel required to make changes to the actions and menus is the "Actions" panel from the "Stakeholder" menu in the editor.
 
===Adding and removing action menu's===
{{Editor ribbon|header=Stakeholders|bar=Actions}}
[[File:actions-left.jpg|framed|left|The left panel in the editor, when editing the actions.]]
To add an action to a stakeholder, the stakeholder first needs to have at least one menu to place the action in. It is not possible to add an action to a stakeholder without organizing it into a menu. A menu without actions will appear to a user as empty, and does not directly serve any purpose.
 
{{Editor steps|title=add an action menu|Select "Stakeholders" in the ribbon header.|Select "Actions" in the ribbon bar.|Select "Add" in the [[Editor#Left_Panel|left panel]].}}
{{Editor steps|title=remove an action menu|Select "Stakeholders" in the ribbon header.|Select "Actions" in the ribbon bar.|Select the menu you wish to remove.|Select "Add" in the [[Editor#Left_Panel|left panel]].}}
<br clear=all>
 
===Editing action menus===
{{Editor ribbon|header=Stakeholders|bar=Actions}}
[[File:Actions-right.jpg|framed|left|The right panel in the editor, when editing the action menu's.]]
When you select a menu, the right panel will automatically be filled with the information pertaining to that menu. A number of properties pertaining to a menu can be edited.
 
====Menu Name====
[[File:Actions-right-name.jpg|frame|right|The field for the "name".]]
: ''This Menu name field is the name of the menu. The menu name is displayed when a user hovers the mouse over a menu. You can change the name of the menu by editing the textfield.''<br clear=right>
 
====Menu Icon====
[[File:Actions-right-image.jpg|frame|right|The menu's "image".]]
: ''The Menu image is a visual representation of a menu. The menu image is used to group several actions into. You can change the image by clicking the Menu image and choosing an image from the list of images that appears.''<br clear=right>
 
====Menu Active====
[[File:Actions-right-active.jpg|frame|right|The "active" checkbox.]]
: ''The "Active" property dictates whether the action menu is activated at the start of the project. You can change this by checking or unchecking the checkbox''<br clear=right>
 
====Menu Order====
[[File:Actions-right-move.jpg|frame|right|The buttons with which to alter the "order" of the menus.]]
: ''The menu order defines the order in which the menus are being presented to the user. You can change the order by selecting a menu and pressing "Move up" and "Move Down".''<br clear=right>
 
====Menu Stakeholders====
[[File:Actions-right-stakeholders.jpg|frame|right|The checkboxes for giving stakeholders access to the action menu.]]
: ''The stakeholders with whom the action menu is shared, have access to the actions in the menu. In addition, this sharing can be defined by level, meaning that the availability of an action menu can change by stakeholder and by level. To give a stakeholder access to this action menu in a given level, find the level in the list, find the entry for the stakeholder listed under the entry for the level, and check the checkbox next to the stakeholder's entry.''<br clear=all>


===Adding and removing actions===
{{article end
{{Editor ribbon|header=Stakeholders|bar=Actions|left=Assigned Actions}}
|howtos=
<!--[[File:Actions-left-actions.jpg|frame|left|Selecting the "Assigned Actions" option in the left panel.]]-->
* [[How to add and remove an action menu]]
[[File:Actions-right-actions.jpg|frame|left|The right panel allows you to select actions for the menu.]]
* [[How to edit an action menu]]
To change which actions are included in an action menu, find the entry for the menu you wish to change, and select the sub-item "Assigned Actions". In the right panel, a list will be visible with several types of actions. Each action type can be opened to reveal either a sub-list of action types, or a list of actual actions. By checking or unchecking the checkbox next to an action, the action is either added or removed.
* [[How to add and remove actions]]
*[[How to add a Panel which can be opened from an Action Menu]]
*[[How to add an Attribute Action to your project]]
*[[How to add Financial Actions to your project]]
|seealso=
*[[Action Menu]]
*[[Action Log]]
*[[Action panel]]
*[[Planned situation]]
}}


{{Editor steps|title=set the actions of an action menu|In the left panel, select the action menu for which you'd like to edit the actions.|In the right panel, select the appropriate action type.|If neccesary, select the appropriate subtype.|For a given action, check the checkbox next to the action to add it to the menu.}}


There is a quick way to reach the checkbox for an action that is already included in an action menu. In the left menu, Under the assigned actions of an action menu, a sub-list is available of the actions included in that menu. By selecting an action in the left panel, the same entry is also automatically selected in the right panel.


A few action types may be empty: [[Measures]], [[Dike Types|Dikes]] and [[Event Bundle]]s. These are all user-defined. If these have not yet been defined in the project, they cannot be added to the action menu's.
{{Editor future design nav}}
<br clear=all>
[[Category:Action]]

Latest revision as of 09:07, 18 December 2023

All available types of Actions


An action is an activity a stakeholder can perform to potentially achieve their objectives. A typical example of an action would be a housing corporation constructing social housing, or a water board realizing open water.

Actions can be grouped together using Action Menus. In the viewer interface, Action menu that are available to a stakeholder are shown in the Action menu panel found the left part of the viewer interface. Selecting an Action Menu from the Action menu panel opens the Action panel, which provides options to plan an Action.

When a user plans an action, it changes the future situation and will often have an effect on overlays and indicators. For example, when a stakeholder plants new trees, this action will have an effect on the Livability overlay and consequently on the Livability indicator.

Actions taken are tied to specific stakeholders, allowing the recording of costs and incomes. As an example, the waterboard can be configured to have the capability to create waterways, but not social housing or roads. Since a stakeholder can be configured to have access to many different actions available, actions are organized using Action menus.

Planned actions are generally not final. They can be canceled by the stakeholder that performed the action and sometimes be reverted by stakeholders that own the property. For reverting actions, see #Special Actions

Each action is logged in the Action Log, which can be used to trace back which actions have been taken during a session or test run.

Types of Actions

A lot of predefined actions are available in Tygron Platform. Each project can have its own set of available actions. Furthermore, not every action has to be available for each stakeholder. Since Projects created in the Tygron Platform have their focus primarily on urban planning, most of the available actions are construction options. These options allow stakeholders to plan constructions based on available functions.

This section describes the types of actions that can be taken and what effect they will have when planned in your project.

Actions that require a drawn selection:

The most common type of action, the function, can be applied to your project by drawing a selection. When applied, a building with that function will be planned in your project.
Buildings can be upgraded using Upgrade Types, provided an upgrade definition exists within that Upgrade Type which applies to that building's function. Upgrades can be used to improve the building to a related function, or to change the building to a completely different function category.
Similar to upgrades, although these actions do not change the function of a building. Instead, they set particular attribute values. These values can be set (at locked) by the creator of the action, or be configured by stakeholders applying these actions.
These are actions that have a functionality that cannot be further configured.

Actions that open an additional panel:

Actions that will be applied directly:

Impact of Actions

Most actions have effects on buildings; planning new or demolishing or upgrading them. This will often have an effect on one or more indicators. Each action on a building has a cost that will negatively affect the acting stakeholder's budget.

For changing the effects of the buildings on the indicators, see functions.

Measures and Events

Measures and events also need to be defined before they can be added to a stakeholder's action menu. Events simply cause other things to happen during the session when they are activated. Measures may have a variety of effects.