Api session event editor overlay set parent: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
27,393 edits
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
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.
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
{|class=wikitable
!Name
!Name
Line 16: Line 16:
|REQUIRED
|REQUIRED
|(Integer number)
|(Integer number)
|[[Overlay]] ID of parent ([[Overlay]]s without a parent should have their parent Overlay ID set to -1)
|[[Overlay]] ID of parent ([[Overlay]] without a parent should have their parent [[Overlay]] ID set to -1)
|
|
|}
|}
Line 31: Line 31:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_parent/?f=HTML&token=API_TOKEN
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_parent/?f=JSON&token=API_TOKEN


with content:  
with content:  
<pre>[ 53, 24 ]
<pre>[ 17, 47 ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor overlay]]}}
{{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 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 (Overlay 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=JSON&token=API_TOKEN

with content: 

[ 17, 47 ]

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_overlay_set_parent&oldid=70880"