Event Bundle: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
Event bundles are collections of events that can be triggered as one package. The advantage over loose events is that event bundles can be triggered by multiple sources. Event bundles can be used to trigger events at specific points during a [[cinematic]]. Additionally, event bundles can also be added to [[action]] menus of stakeholders. This means that it's possible to provide users with an option, solely to fire events. This can be useful when, for example, they must have the ability to set the [[Water Storage (Indicator)|allowed water level increase]] for an area, to rewatch a cinematic, or to trigger the sending of a predefined message.
[[File:Api_future_design.png|thumb|right|400px|[[Event Bundle]]s in relation to other [[Action]]s]]
Event bundles are collections of events that can be triggered as one package. The advantage over loose events is that event bundles can be triggered by multiple sources. Event bundles can be used to trigger events at specific points during a [[cinematic]]. Additionally, event bundles can be added to [[Action Menu]]s, such that stakeholders can trigger these events directly as an action. This can be useful to, for example, rewatch a cinematic.


==Server events and client events==
==Server events and client events==
There are two kinds of events: server events and client events.  
Events in event bundles can be split into two groups: server events and client events.  


===Server Events===
===Server Events===
: '' Main article: [[Server Events]].''
[[Server Event]]s are events which are communicated to the server, and may have effects for all stakeholders. An example of this is the activation of a measure. This may affect the [[project]] spatially, visually in the [[3D Visualization]], and the indicator scores; changes which are also visible and possibly important to other stakeholders.
Server events are events which are communicated to the server, and may have effects for all stakeholders. An example of this is the activation of a measure. This may affect the 3D world and the indicator scores; changes which are also visible and possibly important to other stakeholders.  


===Client Events===
===Client Events===
: '' Main article: [[Client Events]].''
[[Client Event]]s are not communicated to the server and and are usually a graphical effect for the stakeholder who triggered the event. Examples of this include flashing an [[Action Menu]] to draw the user's attention, or the visualization of a [[weather]] effect.
Client events are not communicated to the server and and are usually a graphical effect for the stakeholder who triggered the event. Examples of this include flashing an action menu to draw the user's attention, or the visualization of a [[weather]] effect.
 
==Adding and removing event bundles==
{{editor location|Event Bundles}}
[[File:bundles-left.jpg|framed|left|The [[Left Panel]] allows you to add, remove, and select event bundles.]]
You can create (empty) event bundles, which events can then be added to. An event bundle which does not contain events can be used as any other event bundle, but will have no effects.
{{Editor steps|title=add an event bundle|In the ribbon header, select "Stakeholders".|In the ribbon bar, select "Event Bundles".|In the left panel, select "Add".}}
{{Editor steps|title=duplicate an event bundle|In the ribbon header, select "Stakeholders".|In the ribbon bar, select "Event Bundles".|In the left panel, select the event bundle you wish to duplicate.|In the left panel, select "Duplicate".}}
{{Editor steps|title=remove an event bundle|In the ribbon header, select "Stakeholders".|In the ribbon bar, select "Event Bundles".|In the left panel, select the event bundle you wish to remove.|In the left panel, select "Remove".}}<br clear=all>
 
==Adding, removing and editing events==
Because events can be added to, and removed from several types of items in a project, please see the respective articles on those items for more information on where to add and remove events. For example, if you wish to add an event to a measure, please see the article on [[measures]]. Similarly, for information on how to connect event bundles to elements in a project, please see the respective articles on those elements for more information.
 
{{:Editing Events}}


{{article end
|howtos=
* [[How to add and remove Event Bundles]]
* [[How to edit Event Bundle events]]
|seealso=
* [[Client Event]]s
* [[Server Event]]s
}}
{{Template:Editor_future_design_nav}}
{{Template:Editor_future_design_nav}}


[[Category:Items]]
[[Category:Items]]

Latest revision as of 11:03, 21 February 2023

Event Bundles in relation to other Actions

Event bundles are collections of events that can be triggered as one package. The advantage over loose events is that event bundles can be triggered by multiple sources. Event bundles can be used to trigger events at specific points during a cinematic. Additionally, event bundles can be added to Action Menus, such that stakeholders can trigger these events directly as an action. This can be useful to, for example, rewatch a cinematic.

Server events and client events

Events in event bundles can be split into two groups: server events and client events.

Server Events

Server Events are events which are communicated to the server, and may have effects for all stakeholders. An example of this is the activation of a measure. This may affect the project spatially, visually in the 3D Visualization, and the indicator scores; changes which are also visible and possibly important to other stakeholders.

Client Events

Client Events are not communicated to the server and and are usually a graphical effect for the stakeholder who triggered the event. Examples of this include flashing an Action Menu to draw the user's attention, or the visualization of a weather effect.