Api session event editor overlay set image

From Tygron Support wiki
Revision as of 14:15, 30 March 2026 by Frank@tygron.nl (talk | contribs)
Jump to navigation Jump to search

API Event to Change the icon displayed in the navigation window by the Overlay. Only existing Overlay Project Assets are allowed.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple values in array [1, 2, 3]) Overlay ID
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Project asset name, omitting the directory

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_image/?f=HTML&token=API_TOKEN

with content:

[ [ 1, 2, 3 ], [ "Project asset name, omitting the directory 1", "Project asset name, omitting the directory 2", "Project asset name, omitting the directory 3" ] ]