Api session event editor scenario: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
!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]]
|}
|}
Line 39: Line 39:
!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]]

Latest revision as of 12:13, 1 April 2026

Api session event editor scenario Events.

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

Specific Events:

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.