Server Event: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
51,321 edits
 
(60 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{being updated}}
Server events are [[events]] which are communicated to the server, and may affect all [[stakeholder]]s. For example, a server event can automatically plan a [[measure]] or change attribute values of [[areas]] and [[neighborhoods]], resulting in new [[overlay]] and [[indicator]] results.  
{{learned|file=ServerSideLogo-Q3-2015.jpg|what a Server Side event is|how Server Side events relate to the Tygron engine|about the different Server Side events in the Tygron engine|how to add a Server Side event to your project|how to change a Server Side event in your project}}
==What is a Server Event==
:''Main article: [[Events]]''
Server events are events which are communicated to the server, and may affect all stakeholders. An example of this is the activation of a measure. These events may affect the 3D world and the indicator scores.


==How do Server Events relate to the Tygron Engine==
Server Events can be used in multiple locations in the {{software}}; as part of a [[Measure]], when a [[Scenario]] is activated, as part of a larger [[Events#Event Bundles|event bundle]] in the [[Actions|action]] menu, or during a [[Cinematics|cinematic sequence]]. Server Events allow for events to be triggered during a session, which will result in a reaction from the server.
Server Events can be used in multiple locations in the Tygron Engine; as part of a [[Measures|measure]], at the start of a [[Levels|level]], as part of a larger [[Events#Event Bundles|event bundle]] in the [[Actions|action]] menu, etc. Server Events allow for events to be triggered during a session, which will result in a reaction from the server.


==Different Server Event types==
==Different Server Event types==
There are two flavors of Server Events: '''Logic Events''' and '''Player Events'''. The difference between these Event Types is that for Player Events at least one dedicated stakeholder needs to be assigned to the Server Event itself as event property. A good example of this is the asking for or receiving of a money transfer (MONEY_TRANSFER_ASK & MONEY_TRANSFER_GIVE) as a Server Event.  
There are two flavors of Server Events: '''Logic Events''' and '''Participant Events'''. The difference between these Event Types is that for Participant Events at least one dedicated stakeholder needs to be assigned to the Server Event ''itself as event property''. A good example of this is the asking for or receiving of a money transfer (MONEY_TRANSFER_ASK & MONEY_TRANSFER_GIVE) as a Server Event.  


Logic Events do not require such a dedicated stakeholder and can be fired without one being assigned as property. A good example of this is the activation of a specific terrain type (TERRAIN_SET_ACTIVE) when creating a [[Terrains#Flood Terrain|flooding]] as part of a measure. The event CINEMATIC_STAKEHOLDER_START is also a Logic Event Type, because the stakeholder is not a property of the event, but of the linked cinematic.
Logic Events do not require such a dedicated stakeholder and can be fired without one being assigned as property. A good example of this is the activation of a specific [[areas|area]] (AREA_SET_ACTIVE) when creating a [[Areas#Flooding|flooding]] as part of a measure. Events like CINEMATIC_STAKEHOLDER_START are also Logic Event Types, because the stakeholder is not a property of the event, but of the linked cinematic.
===Logic Event Types===
===Logic Event Types===
Below is a list describing available Logic Server Event Types:
Below is a list describing the available Logic Event Types:
{| class="wikitable"
{{:Api session event logic}}
|-
|'''ACTION_MENU_SET_FUNCTION_AVAILABLE'''
|''Add or remove a function from a particular Action Menu''
|-
|'''ACTION_MENU_SET_MEASURE_AVAILABLE'''
|''Add or remove a measure from a particular Action Menu''
|-
|'''ACTION_MENU_SET_UPGRADE_AVAILABLE'''
|''Add or remove an upgrade from a particular Action Menu''
|-
|'''BEAMER_SET_LAYER'''
|''Set the beamer layer to a specific overlay type''
|-
|'''CINEMATIC_STAKEHOLDER_START'''
|''Start a cinematic for a specific stakeholder''
|-
|'''CINEMATIC_STAKEHOLDER_STOP'''
|''Stop any cinematic for a specific stakeholder''
|-
|'''LEVEL_SET_ACTIVE'''
|''Activate a game level''
|-
|'''MEASURE_UPDATE_CUSTOM'''
|''Update a custom made measure''
|-
|'''MESSAGE_ACTIVATE'''
|''Activate a specific message''
|-
|'''MESSAGE_REVOKE'''
|''Revoke a message. Effects are not revoked''
|-
|'''MESSAGE_RESET'''
|''Reset a message. Sets the message as inactive and clears the send date.''
|-
|'''SETTINGS_ALLOW_GAME_INTERACTION'''
|''Allow interaction with the project during a session, after a pause moment or level switch''
|-
|'''SETTINGS_SET_MESSAGE_AUTO_RESPOND'''
|''When activated, messages to non-human players and session facilitators are automatically replied to''
|-
|'''SPECIAL_EFFECT_SET_ACTIVE'''
|''Activate/deactivate a special effect''
|-
|'''TERRAIN_SET_ACTIVE'''
|''Activate/deactivate a terrain''
|-
|'''TERRAIN_SET_POLYGON'''
|''Activate/deactivate a polygon as terrain (Safe Zone, Flood Hazard Zone, etc)''
|-
|'''TIME_SET_SIM_MULTIPLIER'''
|''Set the game time multiplier. A value of 1 means that 1 sec in real life is also 1 sec in simulation time. 2 means 1 sec in real life is 2 sec in simulation time''
|-
|'''UNIT_SET_ACTIVE'''
|''Activate/deactivate a unit (vehicles etc)''
|-
|'''WEATHER_SET_DATA'''
|''Set rain data of the weather''
|-
|'''ZOOMLEVEL_SET_ACTIVE'''
|''Activate or deactivate a zoom level''
|}


===Player Event Types===
===Participant Event Types===
Below is a list describing the available Player Event Types:
Below is a list describing the available Participant Event Types:
{| class="wikitable"
{{:Api session event participant}}
|-
|'''ACTION_MENU_SET_ACTIVE'''
|''Set a category of actions available for a stakeholder''
|-
|'''MEASURE_CANCEL_CONSTRUCTION'''
|''Cancel a measure planned by a stakeholder while in pre-construction phase''
|-
|'''MEASURE_PLAN_CONSTRUCTION'''
|''Plan construction of a measure by a stakeholder that is not yet planned''
|-
|'''MESSAGE_NEW'''
|''Send a message between Stakeholders through the message panel''
|-
|'''MONEY_TRANSFER_ASK'''
|''Ask for money from one stakeholder to another''
|-
|'''MONEY_TRANSFER_GIVE'''
|''Give money from one stakeholder to another''
|-
|'''SETTINGS_SET_ALLOWED_WATER_LEVEL_INCREASE'''
|''Set the maximum allowed water rise amount in meters in 'polder water' (= open water)''
|}


==Adding Server Side Events to a project==
==Adding Server Side Events to a project==
As mentioned above, events can be added to a project on multiple occasions and locations. Please refer to the main article relating to these locations for more information about the specific steps to take.
Server events are added to Scenario's using [[Coded Event]]s:
*[[How to change Events fired by a Scenario]]


In general, adding Events to an element in the Tygron Engine happens on the [[Right Panel|right panel]] after selecting the element to have an event added to on the [[Left Panel|left panel]] first. Select on the right panel bottom the 'Add Event' button; a default blank event named ''NO_DEF'' is created in the list above the buttons. Selecting an Event on the list and using the 'Remove Event' button deletes the event from the list.
==Changing the properties of a Server Side Event in a project==
The properties of events can be edited on the bottom panel (see image above). On this panel a linked [[ID]] of an [[Action Menu]] and [[Function]] can be linked to an event for instance. Also can a dedicated stakeholder be selected here for Participant Type Events. Again, any changed made need to be confirmed first with the 'Commit' button, or cancelled with the 'Cancel' button.
[[File:Scenario_event_bottom_panel.png|thumb|600px|center|Editing a Scenario Event in [[Bottom Panel]] and confirming with 'Commit']]


{{Editor steps|title=add events to a project element|Select Project Element to have events added to|Select the Event option on the left panel|Select 'Add event' on the bottom of the right panel|Select the newly added event on the right panel|Select the desired server event from the bottom  panel|Confirm the selection with the 'Commit' button (or use the 'Cancel' button to clear the selection}}
{{article end
 
|seealso=
==Changing the properties of a Server Side Event in a project==
* [[Measure]]
* [[Scenario]]
* [[Event Bundle]]
* [[Cinematic]]
*[[Action Menu]]
|api=
*[[Api session event logic]]
*[[Api session event participant]]
*[[Api session event editor scenario add event]]
*[[Api session event editor scenario remove event]]
*[[Api session event editor scenario set event]]
*[[Api session event editor eventbundle add event]]
*[[Api session event editor eventbundle remove event]]
*[[Api session event editor eventbundle set event]]
*[[Api session event editor measure add event]]
*[[Api session event editor measure set event]]
*[[Api session event editor measure remove event]]
}}

Latest revision as of 10:59, 13 November 2026

Server events are events which are communicated to the server, and may affect all stakeholders. For example, a server event can automatically plan a measure or change attribute values of areas and neighborhoods, resulting in new overlay and indicator results.

Server Events can be used in multiple locations in the Tygron Platform; as part of a Measure, when a Scenario is activated, as part of a larger event bundle in the action menu, or during a cinematic sequence. Server Events allow for events to be triggered during a session, which will result in a reaction from the server.

Different Server Event types

There are two flavors of Server Events: Logic Events and Participant Events. The difference between these Event Types is that for Participant Events at least one dedicated stakeholder needs to be assigned to the Server Event itself as event property. A good example of this is the asking for or receiving of a money transfer (MONEY_TRANSFER_ASK & MONEY_TRANSFER_GIVE) as a Server Event.

Logic Events do not require such a dedicated stakeholder and can be fired without one being assigned as property. A good example of this is the activation of a specific area (AREA_SET_ACTIVE) when creating a flooding as part of a measure. Events like CINEMATIC_STAKEHOLDER_START are also Logic Event Types, because the stakeholder is not a property of the event, but of the linked cinematic.

Logic Event Types

Below is a list describing the available Logic Event Types:

Name Description
action_log_export Export history of Actions taken by Stakeholders
action_menu_set_function_available Add or remove a Function from an Action Menu
action_menu_set_measure_available Add or remove a Measure from an Action Menu
action_menu_set_upgrade_available Add or remove an Upgrade Type from an Action Menu
area_set_active Activate/deactivate an Area
area_set_attribute Set an Area Attribute to the provided values
areas_set_attributes Per entry in the array, set the value of the Attribute for the Area
building_set_attribute Set a Building Attribute to the specified value
building_set_attributes Per entry in the array, set the values of the Attribute for the Building
cinematic_reached_point Notify a Key Point is reached for a Cinematic
cinematic_stakeholder_start Start a Cinematic for a Stakeholder
cinematic_stakeholder_stop Stop a playing Cinematic for a Stakeholder
dismiss_error Dismiss an Error Log
global_set_value Set the Global to the specified value
global_set_values Set the Global to the specified values
map_direct_sell_land Directly sell land without requiring approval
measurement_item_add Add an Item Measurement for an Overlay
measurement_line_add Add a Line Measurement for an Overlay for a specific Timeframe
measurement_point_add Add a Point Measurement for an Overlay
measurement_remove Remove a Measurement
measurement_save Save a Measurement
measurement_set_overlays Set base Overlays for a Measurement
measurement_set_sum Set a Measurement to add its base Overlays to itself
money_transfer_add Create a Money Transfer between two Stakeholders
money_transfers_set_approved Approve a Money Transfer
neighborhood_set_attribute Set an Attribute for a Neighborhood
net_cluster_set_fraction_connected Set the fraction of connected loads with a Net Cluster
net_cluster_set_load_attribute For each Net Load of a Net Cluster, set the value of the Attribute
net_cluster_set_load_attributes For each Net Load of a Net Cluster, set the values of the provided Attributes
net_clusters_set_default_fraction_connected Set the default fraction of connected loads with a cluster
net_clusters_set_load_attributes Set the provided Attribute values for each Net Load within the specified Net Clusters
net_clusters_set_state Per Net Cluster, set all its Net Loads of the provided Net Type to the given Timestate
net_line_set_attribute Set the Attribute of a Net Line to a value
net_lines_set_attribute For each Net Line, set the value of the Attribute
net_lines_set_attributes Per entry in the array, set the value of the Attribute for the Net Line
scenario_set_active Activate a Scenario
scenario_set_attribute Set the Scenario Attribute to the specified numeric value
search Search for Neighborhood, Building or Address
session_release Release a client from a Session using its client token
set_net_setting_boolean Set a boolean value for the specified Net Setting
set_traffic_multiplier Multiply the visual traffic density by a factor
special_effect_set_active Activate/deactivate a Special Effect
stakeholder_release Release a Stakeholder from a Session
stakeholder_select Select the preferred Stakeholder or the next available option if unavailable
undo_last_building_action Undo the last Building Action of a Stakeholder
unit_type_set_active Activate/deactivate units of a specific type
zone_set_attribute Set an Attribute for a Zone
zones_set_attributes Set Attributes values for Zones

Participant Event Types

Below is a list describing the available Participant Event Types:

Name Description
action_menu_set_active Set an Action Menu active for a Stakeholder
attribute_action_plan Stakeholder applies an Attribute Action within a MultiPolygon
building_plan_construction Stakeholder plans a new Building of a Function with an amount of floors and a MultiPolygon
building_plan_demolish Stakeholder plan the demolition of an owned Building
building_plan_demolish_polygon Stakeholder plans the demolition of Building parts intersecting a MultiPolygon in a particular Layer
building_plan_upgrade Stakeholder plans the upgrade of Buildings within a MultiPolygon
building_revert_polygon Stakeholder reverts demolished, changed and planned Buildings within a MultiPolygon back to their original state
event_bundle_apply_server_events Stakeholder applies server side events of an Event Bundle
map_buy_land Stakeholder plans a land purchase with in the MultiPolygon for a given price
map_levee Stakeholder plans a Levee for a MultiPolygon, an absolute or relative height and an angle
map_lower_land Stakeholder lowers land and adds a waterway
map_raise_land Stakeholder raises land within the MultiPolygon by one meter and removes water
map_sell_land Stakeholder plans to sell owned land within the MultiPolygon to another Stakeholder for a given price
measure_cancel_construction Stakeholder cancels a planned Measure
measure_plan_construction Stakeholder plans a Measure
money_transfer_give Stakeholder transfers money to another Stakeholder
net_cluster_set_load_attribute Stakeholder sets an Attribute to a value, for each Net Load of a Net Cluster
net_cluster_set_load_attributes Stakeholder sets set the value of the Attributes for each Net Load of a Net Cluster
net_cluster_set_state Stakeholder sets the Net state for all Net Loads of a Net Cluster
net_cluster_set_state_for_net_type Stakeholder sets the Net state for Net Loads of a Net Cluster and Net Type
net_cluster_set_states Stakeholder sets the Net state for all Net Loads of a Net Cluster, per Net Type
panel_answer Stakeholder selects an Answer in a Panel
parametric_design_plan Stakeholder plans a generated Parametric Design
popup_answer Stakeholder answers a Popup
popup_answer_with_date Stakeholder answers a Popup with an additional date
restore_land Stakeholder creates a Measure that removes water Terrains and flatten its land using a MultiPolygon
stakeholder_set_location Stakeholder's view is moved to the location in the 3D Visualization
zone_add_function_category Stakeholder adds an allowed Function Category to a Zone
zone_remove_function_category Stakeholder removes an allowed Function Category from a Zone
zones_set_categories Stakeholder sets the allowed Function Categories per specified Zone

Adding Server Side Events to a project

Server events are added to Scenario's using Coded Events:

Changing the properties of a Server Side Event in a project

The properties of events can be edited on the bottom panel (see image above). On this panel a linked ID of an Action Menu and Function can be linked to an event for instance. Also can a dedicated stakeholder be selected here for Participant Type Events. Again, any changed made need to be confirmed first with the 'Commit' button, or cancelled with the 'Cancel' button.

Editing a Scenario Event in Bottom Panel and confirming with 'Commit'

See also

API Endpoints

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