Api session event editor overlay set image: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 37: Line 37:
</pre>
</pre>
{{article end|seealso=*[[api session event editor overlay]]
{{article end|seealso=*[[api session event editor overlay]]
*[[api session event editor overlay]]
*[[api session items overlays]]
}}
}}


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

Revision as of 12:01, 1 April 2026

API Event to Change the icon displayed in the navigation window by the Overlay. Only existing Overlay Project Asset 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=JSON&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" ] ]