Api session event editor overlay set image: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Event to Change the icon displayed in the navigation window by the Overlay. Only existing overlay project assets are allowed. {|class=wikitable !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=== {|class=wikitable !Response Code: !Descripti..." |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Event to Change the icon displayed in the navigation window by the [[Overlay]]. Only existing | API Event to Change the icon displayed in the navigation window by the [[Overlay]]. Only existing [[Overlay]] [[Project Asset]] are allowed. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 31: | Line 31: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_image/?f= | Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_image/?f=JSON&token=API_TOKEN | ||
with content: | with content: | ||
<pre>[ [ 1, 2, 3 ], [ "Project asset name, omitting the directory 1", "Project asset name, omitting the directory 2", "Project asset name, omitting the directory 3" ] ] | <pre>[ [ 1, 2, 3 ], [ "Project asset name, omitting the directory 1", "Project asset name, omitting the directory 2", "Project asset name, omitting the directory 3" ] ] | ||
</pre> | </pre> | ||
{{article end|seealso=*[[ | {{article end|seealso=*[[Api session event editor overlay]] | ||
*[[Api session items overlays]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 12:12, 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" ] ]