Api session event editor overlay set prequel: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 31: Line 31:
|OPTIONAL
|OPTIONAL
|(Integer number)
|(Integer number)
|Prequel [[Time]]frame ID (optional)
|Prequel [[Timeframe]] ID (optional)
|
|
|-
|-
Line 37: Line 37:
|OPTIONAL
|OPTIONAL
|(true, false)
|(true, false)
|Previous Iteration (optional)
|Previous [[Simulation Core|Iteration]] (optional)
|
|
|}
|}
Line 54: Line 54:
Curl example POST:
Curl example POST:


<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "Prequel Type Name", "", "" ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "Prequel Type Name" ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST:
Line 61: Line 61:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, "Prequel Type Name", "", "" ]'
 body: '[ 1, 1, "Prequel Type Name" ]'
};
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/", options)
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/", options)

Latest revision as of 14:47, 2 June 2026

API Endpoint: api/session/event/editoroverlay/set_prequel/

Description: Set prequel Overlay.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay ID
1 REQUIRED (OVERLAY Integer ID) Prequel Overlay ID
2 REQUIRED (String) Prequel Type Name
3 OPTIONAL (Integer number) Prequel Timeframe ID (optional)
4 OPTIONAL (true, false) Previous Iteration (optional)

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "Prequel Type Name" ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, "Prequel Type Name" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));