Api session event editor building set decals: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editorbuilding/set_decals/
API Endpoint: api/session/event/editorbuilding/set_decals/


Description: Set Decals
Description: Set the decal values (door, window etc) for a Face Type of a [[Building]]


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (BUILDING Integer ID)
| (BUILDING Integer ID)
| [[Building]]s
| [[Building]]
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (Enumeration)
| (Enumeration)
| FaceType
| Face Type
| BASEMENT, EXTRA, GROUND, ROOF  or  TOP
| BASEMENT, EXTRA, GROUND, ROOF  or  TOP
|-
|-
Line 25: Line 25:
| OPTIONAL
| OPTIONAL
| (Floating point number or multiple values in array [1.0, 2.0, 3.0])
| (Floating point number or multiple values in array [1.0, 2.0, 3.0])
| float[]
| Decal values
|  
|  
|}
|}

Latest revision as of 14:51, 11 November 2026

API Endpoint: api/session/event/editorbuilding/set_decals/

Description: Set the decal values (door, window etc) for a Face Type of a Building

Index Importance Type Description Values
0 REQUIRED (BUILDING Integer ID) Building
1 REQUIRED (Enumeration) Face Type BASEMENT, EXTRA, GROUND, ROOF or TOP
2 OPTIONAL (Floating point number or multiple values in array [1.0, 2.0, 3.0]) Decal values

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/editorbuilding/set_decals/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "BASEMENT" ]'

JavaScript example POST

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