Api session event editor overlay set grid active

From Tygron Support wiki
Revision as of 10:18, 30 March 2026 by Frank@tygron.nl (talk | contribs) (Created page with "API Event to Activates or deactivates an Overlay. Only active Overlays are recalculated by the simulation. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID or multiple values in array [1, 2, 3]) |Overlay ID | |- |1 |REQUIRED |(Boolean or multiple values in array [true, false, true]) |Activated | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

API Event to Activates or deactivates an Overlay. Only active Overlays are recalculated by the simulation.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple values in array [1, 2, 3]) Overlay ID
1 REQUIRED (Boolean or multiple values in array [true, false, true]) Activated

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_grid_active/?f=HTML&token=API_TOKEN

with content:

[ [ 1, 2, 3 ], [ true, false, true ] ]