Api session event editor scenario: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
Api session event editor scenario Events.
Api session event editor scenario Events.


[[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]] 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 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]], when testrun is active the Scenerio 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]] 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]] 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 empty dummy 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]]
|-
|-
|[[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.
|When true test run is restarted on [[Scenario]] activation. This option will be deprecated in the future and replaced by multiple maps.
|}
|}
{{article end|seealso=*[[Api Events]]
{{article end|seealso=*[[Api Events]]
*[[Api session items scenarios]]
}}
}}


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

Revision as of 11:30, 10 April 2026

Api session event editor scenario Events.

API Endpoints for Scenario editing.

Name Description
add Add new Scenario.
append_attribute Appended to existing Scenario attribute value
duplicate Duplicate existing Scenario
remove Remove existing Scenario
remove_attribute Remove attribute from Scenario
set_active Activate Scenario, when testrun is active the Scenerio can restart it.
set_attribute Set Scenario attribute value
set_attributes Set multiple Scenario attribute values
set_name Set new name of existing Scenario

Additional API Endpoints:

Name Description
add_event Add empty dummy 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 Neighborhood
set_limit_type Set Limit Type
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.

See also