Event: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
 
(49 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{stub}}
Events in the {{software}} are instructions to the software. An event has to be predefined. It will only have an effect when the event is fired. A number of occurrences in the {{software}} can cause events to be fired. Examples include the planning and canceling of a [[measures|measure]], or applying an event bundle as an action.
{{being updated}}
{{learned|what events are|how events relate to the Tygron Engine|where events can be used|how to create events|how to create event bundles}}


==Event==
An event has a type and parameters, which specify what the effect of the event is. There are many event types, with many different effects.
An event is an occurrence or happening.


==How events relate to the Tygron Engine==
Events are very basic instructions for the {{software}} to execute. For this reason, they can only be predefined by [[User#Editor|editing users]]. But by using events, it is possible to make a project more complex and help automate events that occur when activating scenarios.
Events in the Tygron Engine definitions of what must happen. An event by itself does nothing. It must be triggered something happening in the Tygron Engine, such as the planning of a [[measures|measure]], or the answering of a [[message]]. Events can have any number of effects. Because of this, they allow an [[user#editor|editor]] to create a more complex project, and as such a more effective experience for the users.


==Where events can be used==
==Where events can be used==
Events can be used in a number of instances, well-defined in the editor. This means that, in general, the cause for the trigger of the event can be well predicted by the creator of the project. Places where events can be triggered are the changes of state for a [[measures|measure]], the answers which can be given for a [[message]], and the activation of [[levels]].
Places where events can be triggered are:
* the change of state of [[measures]]
* the activation of [[scenarios]]
* the activation of [[Event Bundle|event bundles]]


===Event Bundles===
===Event Bundles===
It is also possible to create event bundles. 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.
It is also possible to create event bundles. 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 to let a [[Stakeholder]] re-watch a cinematic or to automatically activate multiple [[measure]]s.


==Server events and client events==
==Server events and client events==
There are two kinds of events: server events and client events. The difference between the two types is whether the event effects a change in the session. 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 do not have such an effect on the projects, and are usually a graphical effect for the triggering stakeholders. Examples of this include having an action menu or indicator flash to draw the user's attention, or the visualization of a weather effect.
There are two kinds of events: server events and client events.  


==Editing Events==
===Server Events===
Because events can be added and removed to a number of elements in a project, please see the respective articles on those elements for more information on where and how 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.
: '' Main article: [[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]] data and the indicator scores; changes which are also visible and possibly important to other stakeholders.


===Adding and removing event bundles===
===Client Events===
{{editor ribbon|header=Tools|bar=Event Bundles}}
: '' Main article: [[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.
 
==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.]]
[[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 can then be given events. An event bundle which does not contain events can be used as any other event bundle, but will have no effects.
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|Select "Tools" in the ribbon header.|Select "Event Bundles" in the ribbon bar.|Select "Add" in the left panel.}}
{{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|Select "Tools" in the ribbon header.|Select "Event Bundles" in the ribbon bar.|In the left panel, select the event bundle you wish to duplicate.|Select "Add" in the left panel.}}
{{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|Select "Tools" in the ribbon header.|Select "Event Bundles" in the ribbon bar.|In the left panel, select the event bundle you wish to remove.|Select "Add" in the left panel.}}<br clear=all>
{{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 and removing events===
{{editor ribbon|header=Tools|bar=Event Bundles|left panel=Event Bundle}}
{{:Event|create=true|item=event bundle|serveronly=false}}
<includeonly><onlyinclude>{{#if: {{{create|}}}|
[[File:{{#if: {{{panel|}}}|{{{panel|}}}|events-right.jpg}}|frame|left|The [[Right Panel]] allows you to add, remove, and select events.]]
{{#if: {{{description|}}}|{{{description}}}
 
<nowiki></nowiki>|}}{{#if: {{{selector-file|}}}|[[File:{{{selector-file|}}}|frame|right|{{#if: {{{selector-file-text|}}}|{{{selector-file-text|}}}}}]]
|}}{{#if: {{{selector-title|}}}|; {{{selector-title|}}}
|}}{{#if: {{{selector-description|}}}|: ''{{{selector-description|}}}''<br clear=right>
}}
; Selecting events
[[File:events-right-list.jpg|frame|right|The list of events.]]
: ''The "Events" list displays a list of events already connected{{#if: {{{item|}}}|<nowiki></nowiki> to the {{{item}}}|}}. Selecting an event allows you to edit the event in the [[Bottom Panel]].''<br clear=right>


; Adding and removing events
==Adding, removing and editing events==
[[File:events-right-button{{#if: {{{serveronly|}}}|s-1}}.jpg|frame|right|The buttons to add and remove 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.
: ''To add an event, select {{#if: {{{serveronly|}}}|"Add Event" to add a (server) event{{#if: {{{item|}}}|<nowiki></nowiki> to the {{{item}}}|}}|"Add Server Event" to add a server event{{#if: {{{item|}}}|<nowiki></nowiki> to the {{{item}}}|}}, or "Add Client Event" to add a client event{{#if: {{{item|}}}|<nowiki></nowiki> to the {{{item}}}|}}}}. When an event is added, it is a dummy event by default, until it's type is changed. To remove an event, select it in the list of events and select "Remove".''<br clear=right>|}}
</onlyinclude></includeonly>


===Changing events===
{{:Editing Events}}
{{editor ribbon|header=Tools|bar=Event Bundles|left panel=Event Bundle|right panel=Event}}
{{:Event|edit=true|nomain=true}}
<includeonly><onlyinclude>{{#if: {{{edit|}}}|
{{#if: {{{nomain|}}}||''Main article: [[Events]]''


<nowiki></nowiki>|}}
{{Template:Editor_future_design_nav}}
When an event is selected in the right panel, you can edit the properties of the event in the bottom panel.
[[File:measures-bottom-events.jpg|frame|left|The bottom panel when editing events.]]<br clear=all>
; Event type
[[File:events-bottom-type.jpg|frame|right|The selection list for the type of event.]]
: ''Each event must have an event type. By default, the event type is a dummy event, which does nothing. The event type has to be changed to give the event an effect. To change the type of event, select the desired event type from the list of event types.''<br clear=right>
; Event parameters
[[File:events-bottom-parameters.jpg|frame|right|The input fields for additional parameters.]]
: ''For some events, additional parameters are required. When this is the case, a list of input fields will appear in the bottom panel, with default values. These default values can be changed to specify on what an event's effect is enacted, and what the details of the event are.''<br clear=right>
; Storing the changes
[[File:events-bottom-buttons.jpg|frame|right|The input fields for additional parameters.]]
: ''When the event has been configured as desired, you can select "Commit" to confirm these changes. If you do not press "Commit" before closing the panel, your changes are not saved. You can also press "Cancel" to undo your changes.''<br clear=all>}}</onlyinclude></includeonly>

Latest revision as of 15:14, 23 February 2023

Events in the Tygron Platform are instructions to the software. An event has to be predefined. It will only have an effect when the event is fired. A number of occurrences in the Tygron Platform can cause events to be fired. Examples include the planning and canceling of a measure, or applying an event bundle as an action.

An event has a type and parameters, which specify what the effect of the event is. There are many event types, with many different effects.

Events are very basic instructions for the Tygron Platform to execute. For this reason, they can only be predefined by editing users. But by using events, it is possible to make a project more complex and help automate events that occur when activating scenarios.

Where events can be used

Places where events can be triggered are:

Event Bundles

It is also possible to create event bundles. 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 to let a Stakeholder re-watch a cinematic or to automatically activate multiple measures.

Server events and client events

There are two kinds of events: server events and client events.

Server Events

Main article: 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 data and the indicator scores; changes which are also visible and possibly important to other stakeholders.

Client Events

Main article: 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.

Adding and removing event bundles

Editor → Future Design (Ribbon tab) → Event Bundles (Ribbon bar)
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.

How to add an event bundle:
  1. In the ribbon header, select "Stakeholders".
  2. In the ribbon bar, select "Event Bundles".
  3. In the left panel, select "Add".
How to duplicate an event bundle:
  1. In the ribbon header, select "Stakeholders".
  2. In the ribbon bar, select "Event Bundles".
  3. In the left panel, select the event bundle you wish to duplicate.
  4. In the left panel, select "Duplicate".
How to remove an event bundle:
  1. In the ribbon header, select "Stakeholders".
  2. In the ribbon bar, select "Event Bundles".
  3. In the left panel, select the event bundle you wish to remove.
  4. In the left panel, select "Remove".


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.

For the exact steps for adding, removing, and changing events, please see Editing Events.

Editor ribbon icon future.pngFuture Design
Future Design
Test Run • Actions • Action Menus • Measures • Parametric • Attributes • Levee Types • Upgrade Types • Event Bundles • Active Stakeholders
Actions
Action Logs
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community


Retrieved from "https://support.tygron.com/w/index.php?title=Event&oldid=53399"