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 10: Line 10:
|-
|-
| [[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]]
Line 19: Line 19:
|-
|-
| [[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]]
Line 40: Line 40:
|-
|-
| [[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]]
Line 70: Line 70:
|-
|-
| [[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 Session Endpoints]]
{{article end|seealso=*[[Api Session Endpoints]]

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.