|
|
| (97 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| {{old style}}
| | [[File:Api_future_design.png|thumb|right|400px|All available types of [[Action]]s]] |
| {{learned|file=ActionsLogo.jpg|what actions are|what menus are|how actions can influence indicators|how to add and remove actions to a stakeholder}}
| |
|
| |
|
| ==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 player 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 player plants new trees, this action would have an effect on the indicator Quality of Life. 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 player can have a lot of different actions available to reach their [[objective]], actions are organized into [[#Menus|menus]]. | | 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]]. |
|
| |
|
| ===Predefined Actions===
| | 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]]. |
|
| |
|
| A lot of predefined actions are available in Tygron Engine. Not all those actions have to be available to the players in all games. Since the game is about urban planning, most of the available actions have an available construction associated with its [[functions|function]].
| | [[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]] |
|
| |
|
| For more information about all the actions available in the Tygron Engine, see the [[list 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]]. |
|
| |
|
| ===Effects of Actions=== | | {{clear}} |
| | ===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]]. |
|
| |
|
| ====Construction Actions====
| | This section describes the types of actions that can be taken and what effect they will have when planned in your project. |
| Most actions, when planned by the player, will place a construction in the 3D World and will have an effect on at least one or more indicators. Each action with a [[Financial System#Costs|cost]] will negatively affect the acting stakeholder's [[Budget (Indicator)|budget]]. Actions such as parks and green roofs will positively affect the [[Green (Indicator)|green indicator]]. The effect on the indicator is determined by that element's [[function]] (type).
| |
|
| |
|
| For changing the effects of the constructions on the indicators, see [[functions]].
| | Actions that require a drawn selection: |
| | * [[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]] |
|
| |
|
| ====Special Actions====
| | Actions that open an additional panel: |
| 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]].
| | * [[Finance view]] |
| | * [[Transfer money]] |
|
| |
|
| ===Menus===
| | Actions that will be applied directly: |
| | * [[Measure]]s |
| | * [[Event bundle]]s |
|
| |
|
| 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 players to weigh choices of actions against each other easily.
| | ====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 [[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 players 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. |
| [[File:actions-left.jpg|framed|none|The left panel in the editor, when editing the actions.]] | |
|
| |
|
| In the editor, you can add, remove and reorganize actions and menus in the game as desired. The panel required to make changes to the actions and menus is the "Actions" panel from the "Stakeholder" menu in the editor.
| | {{article end |
| | |howtos= |
| | * [[How to add and remove an action menu]] |
| | * [[How to edit an action menu]] |
| | * [[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]] |
| | }} |
|
| |
|
| ===Adding and removing menu's===
| |
| {{Editor ribbon|header=Stakeholders|bar=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 player as empty, but does not directly serve any purpose.
| |
|
| |
|
| {{Editor steps|title=add a 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 a 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]].}}
| |
|
| |
|
| ===Editing action menus===
| | {{Editor future design nav}} |
| {{Editor ribbon|header=Stakeholders|bar=Actions}} | | [[Category:Action]] |
| [[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 of the 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 player 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 "icon".]]
| |
| : ''The Menu icon is a visual representation of a menu. The menu icon is used to group several actions into. You can change the icon by clicking the Menu icon 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=right>
| |
| | |
| ===Adding and removing menus and actions===
| |
| | |
| {{Editor ribbon|header=Stakeholders|bar=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 player as empty, but does not directly serve any purpose.
| |
| | |
| It is also possible to share menus between multiple stakeholders. The menu must first be created for a single stakeholder, and can then be added to other stakeholders as well. Actions added to such a menu can be used by all stakeholders with that menu.
| |
| ====Adding a menu====
| |
| :''To add a new menu to the current stakeholder, right-click in the middle pane, and select "Add new Menu".''
| |
| :''To add an already existing menu to the stakeholder, right-click in the middle pane, and choose "Add existing Menu". Then pick a menu from the menus list.''
| |
| | |
| {{Editor steps|title=add a menu|Select the stakeholder to which you wish to add the menu.|Right-click in the middle pane.|Choose "Add new Menu" or "Add Existing Menu".|If you chose "Add Existing Menu", select a menu from the menus list.}}
| |
| | |
| ====Removing a menu====
| |
| :''To remove a menu from the current stakeholder only, right-click on the menu you want to remove, and select "Remove from stakeholder".''
| |
| :''To permanently delete a menu completely, right-click on the the menu you want to remove, and select "Delete Menu". This also removes it from other stakeholders.''
| |
| {{Editor steps|title=remove a menu|Select the stakeholder from which you wish to remove a menu.|Right-click on a menu in the middle pane.|If you wish to keep the menu, but disconnect it from this menu, select "Remove from stakeholder".|If you wish to completely delete the menu, select "Delete Menu".}}
| |
| | |
| ====Adding and removing actions====
| |
| :''To add an action to a menu, drag an action from the left pane (for example, "Construction actions -> Agriculture -> Corn Fields") to an available menu. When no menu is available, you need to to add a menu first.''
| |
| {{Editor steps|title=add an action|Select the stakeholder to which you wish to add the action.|Make sure the stakeholder has [[#Adding a menu|at least one menu]].|Select an action from the pane on the left of the panel.|Drag the action ''on to'' the menu in which you wish the action to be placed.}}
| |
| :''To remove an action from a menu, right-click the action you want to remove from the menu you want to remove, and select "Delete Action"''
| |
| {{Editor steps|title=remove an action|Select the stakeholder from which you wish to remove an action.|Open the menu containing the action.|Right-click the action and select "Delete Action".}}
| |
| | |
| ===Changing menus===
| |
| {{Editor ribbon|header=Stakeholders|bar=Actions}}
| |
| In the middle of the panel, you will see the existing menus. When you select a menu, the right of the panel will automatically be filled with the information pertaining to that menu. A number of properties pertaining to a menu can be edited.
| |
| | |
| {{Editor steps|title=change a menu|Select a menu in the middle pane.|Change the name by changing the contents of the "Menu Name" field.|Change the icon by clicking on the icon, and selecting a new one in the icon panel.|Change the order by moving this menu up or down, by using the "Move Up" and "Move Down" buttons.}}
| |
| | |
| ====Menu Name====
| |
| [[File:Categories_overview_-_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 player hovers the mouse over a menu. You can change the name of the menu by editing the textfield.''<br clear=all>
| |
| | |
| ====Menu Icon====
| |
| [[File:Categories_overview_-_icon.jpg|frame|right|The menu's "icon".]]
| |
| : ''The Menu icon is a visual representation of a menu. The menu icon is used to group several actions into. You can change the icon by clicking the Menu icon and choosing an image from the list of images that appears.''<br clear=all>
| |
| | |
| ====Menu Order====
| |
| [[File:Categories_overview_-_sort_index.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=all>
| |
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.
Future Design
Future Design