Api session event editor scenario: 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
46,429 edits
No edit summary
No edit summary
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
API api session event editor scenario Events.
API Endpoint: api/session/event/editorscenario/


Scenario editing.
API endpoints for [[Scenario]] editing.
{|class=wikitable
{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[api session event editor scenario add|ADD]]
| [[Api session event editor scenario add|add]]
|Add new [[Scenario]].
| Add new [[Scenario]].
|-
|-
|[[api session event editor scenario append attribute|APPEND_ATTRIBUTE]]
| [[Api session event editor scenario append attribute|append_attribute]]
|Appended to existing [[Scenario]] attribute value
| Appended to existing [[Scenario]] numeric [[Attribute]] value
|-
|-
|[[api session event editor scenario duplicate|DUPLICATE]]
| [[Api session event editor scenario duplicate|duplicate]]
|Duplicate existing [[Scenario]]
| Duplicate existing [[Scenario]]
|-
|-
|[[api session event editor scenario remove|REMOVE]]
| [[Api session event editor scenario remove|remove]]
|Remove existing [[Scenario]]
| Remove existing [[Scenario]]
|-
|-
|[[api session event editor scenario remove attribute|REMOVE_ATTRIBUTE]]
| [[Api session event editor scenario remove attribute|remove_attribute]]
|Remove attribute from [[Scenario]]
| Remove numeric [[Attribute]] from [[Scenario]]
|-
|-
|[[api session event editor scenario set active|SET_ACTIVE]]
| [[Api session event editor scenario set active|set_active]]
|Activate [[Scenario]], when testrun is active the Scenerio can restart it.
| Activate [[Scenario]]. If a test run is active, the [[Scenario]] can restart it.
|-
|-
|[[api session event editor scenario set attribute|SET_ATTRIBUTE]]
| [[Api session event editor scenario set attribute|set_attribute]]
|Set [[Scenario]] attribute value
| Set [[Scenario]] numeric [[Attribute]] value
|-
|-
|[[api session event editor scenario set attributes|SET_ATTRIBUTES]]
| [[Api session event editor scenario set attributes|set_attributes]]
|Set multiple [[Scenario]] attribute values
| Set multiple [[Scenario]] numeric [[Attribute]] values
|-
|-
|[[api session event editor scenario set name|SET_NAME]]
| [[Api session event editor scenario set name|set_name]]
|Set new name of existing [[Scenario]]
| Set new name of existing [[Scenario]]
|}
|}


Specific Events:
Additional API endpoints:
{|class=wikitable
{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[api session event editor scenario add event|ADD_EVENT]]
| [[Api session event editor scenario add event|add_event]]
|Add empty dummy event that is [[Trigger]]ed on [[Scenario]] activation.
| Add a placeholder event that is [[Trigger]]ed on [[Scenario]] activation.
|-
|-
|[[api session event editor scenario add measure|ADD_MEASURE]]
| [[Api session event editor scenario add measure|add_measure]]
|Add a [[Measure]] that is [[Trigger]]ed on [[Scenario]] activation.
| Add a [[Measure]] that is [[Trigger]]ed on [[Scenario]] activation.
|-
|-
|[[api session event editor scenario remove cinematic|REMOVE_CINEMATIC]]
| [[Api session event editor scenario remove cinematic|remove_cinematic]]
|Remove Cinematic
| Remove [[Cinematic]]
|-
|-
|[[api session event editor scenario remove event|REMOVE_EVENT]]
| [[Api session event editor scenario remove event|remove_event]]
|Remove Event
| Remove Event
|-
|-
|[[api session event editor scenario remove measure|REMOVE_MEASURE]]
| [[Api session event editor scenario remove measure|remove_measure]]
|Remove [[Measure]]
| Remove [[Measure]]
|-
|-
|[[api session event editor scenario set cinematic|SET_CINEMATIC]]
| [[Api session event editor scenario set cinematic|set_cinematic]]
|Set Cinematic
| Set [[Cinematic]]
|-
|-
|[[api session event editor scenario set description|SET_DESCRIPTION]]
| [[Api session event editor scenario set description|set_description]]
|Set Description
| Set Description
|-
|-
|[[api session event editor scenario set event|SET_EVENT]]
| [[Api session event editor scenario set event|set_event]]
|Set Event
| Set Event
|-
|-
|[[api session event editor scenario set limit neighborhoods|SET_LIMIT_NEIGHBORHOODS]]
| [[Api session event editor scenario set limit neighborhoods|set_limit_neighborhoods]]
|Set Limit [[Neighborhood]]
| Set Limit [[Neighborhood]]s
|-
|-
|[[api session event editor scenario set limit type|SET_LIMIT_TYPE]]
| [[Api session event editor scenario set limit type|set_limit_type]]
|Set Limit Type
| Set Limit Type
|-
|-
|[[api session event editor scenario set restart testrun|SET_RESTART_TESTRUN]]
| [[Api session event editor scenario set restart testrun|set_restart_testrun]]
|When true test run is restarted on [[Scenario]] activation. This option will be deprecated in the future and replaced by multiple maps.
| If true, the test run is restarted on [[Scenario]] activation. Deprecated in favor of multiple maps.
|}
|}
{{article end|seealso=*[[Api Events]]}}
{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items scenarios]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 09:59, 13 July 2026

API Endpoint: api/session/event/editorscenario/

API endpoints for Scenario editing.

Name Description
add Add new Scenario.
append_attribute Appended to existing Scenario numeric Attribute value
duplicate Duplicate existing Scenario
remove Remove existing Scenario
remove_attribute Remove numeric Attribute from Scenario
set_active Activate Scenario. If a test run is active, the Scenario can restart it.
set_attribute Set Scenario numeric Attribute value
set_attributes Set multiple Scenario numeric Attribute values
set_name Set new name of existing Scenario

Additional API endpoints:

Name Description
add_event Add a placeholder event that is Triggered on Scenario activation.
add_measure Add a Measure that is Triggered on Scenario activation.
remove_cinematic Remove Cinematic
remove_event Remove Event
remove_measure Remove Measure
set_cinematic Set Cinematic
set_description Set Description
set_event Set Event
set_limit_neighborhoods Set Limit Neighborhoods
set_limit_type Set Limit Type
set_restart_testrun If true, the test run is restarted on Scenario activation. Deprecated in favor of multiple maps.

See also

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