Server Events: Difference between revisions
| Line 11: | Line 11: | ||
There are two flavors of Server Events: Logic Events and Player Events. The difference between these is that for Player Events at least one dedicated stakeholder needs to be assigned to the Server Event. 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. | There are two flavors of Server Events: Logic Events and Player Events. The difference between these is that for Player Events at least one dedicated stakeholder needs to be assigned to the Server Event. 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. | ||
===Logic Event Types=== | ===Logic Event Types=== | ||
Below is a list describing available Logic Server Event Types: | |||
====ACTION_MENU_SET_FUNCTION_AVAILABLE==== | ====ACTION_MENU_SET_FUNCTION_AVAILABLE==== | ||
:''Add or remove a function from a particular Action Menu'' | |||
====ACTION_MENU_SET_MEASURE_AVAILABLE==== | ====ACTION_MENU_SET_MEASURE_AVAILABLE==== | ||
:''Add or remove a measure from a particular Action Menu'' | |||
====ACTION_MENU_SET_UPGRADE_AVAILABLE==== | ====ACTION_MENU_SET_UPGRADE_AVAILABLE==== | ||
:''Add or remove an upgrade from a particular Action Menu'' | |||
====BEAMER_SET_LAYER==== | ====BEAMER_SET_LAYER==== | ||
====CINEMATIC_STAKEHOLDER_START==== | ====CINEMATIC_STAKEHOLDER_START==== | ||
| Line 31: | Line 35: | ||
====WEATHER_SET_DATA==== | ====WEATHER_SET_DATA==== | ||
====ZOOMLEVEL_SET_ACTIVE==== | ====ZOOMLEVEL_SET_ACTIVE==== | ||
===Player Event Types=== | ===Player Event Types=== | ||
====ACTION_MENU_SET_ACTIVE==== | ====ACTION_MENU_SET_ACTIVE==== | ||
Revision as of 12:03, 25 August 2015
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 Tygron Engine; as part of a measure, at the start of a level, as part of a larger event bundle in the 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
There are two flavors of Server Events: Logic Events and Player Events. The difference between these is that for Player Events at least one dedicated stakeholder needs to be assigned to the Server Event. 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 flooding as part of a measure.
Logic Event Types
Below is a list describing available Logic Server Event Types:
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