Api session event editor overlay set parent: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Set a parent Overlay for a specified Overlay. This will cause the specified Overlay to be a subselectable Overlay of the parent. It is not possible to set an Overlay which has a parent itself as a parent of another Overlay. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID) |Overlay ID | |- |1 |REQUIRED |(Integer number) |Overlay ID of parent (overlays without a parent should have their parent Ove..."
 
No edit summary
Line 16: Line 16:
|REQUIRED
|REQUIRED
|(Integer number)
|(Integer number)
|[[Overlay]] ID of parent (overlays without a parent should have their parent Overlay ID set to -1)
|[[Overlay]] ID of parent ([[Overlay]]s without a parent should have their parent Overlay ID set to -1)
|
|
|}
|}
Line 34: Line 34:


with content:  
with content:  
<pre>[ 8, 29 ]
<pre>[ 53, 24 ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor overlay]]}}
{{article end|seealso=*[[api session event editor overlay]]}}


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

Revision as of 14:15, 30 March 2026

API Event to Set a parent Overlay for a specified Overlay. This will cause the specified Overlay to be a subselectable Overlay of the parent. It is not possible to set an Overlay which has a parent itself as a parent of another Overlay.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay ID
1 REQUIRED (Integer number) Overlay ID of parent (Overlays without a parent should have their parent Overlay ID set to -1)

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

with content:

[ 53, 24 ]