Api session event editor weather set effect: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(WEATHER Integer ID) | | (WEATHER Integer ID) | ||
|[[Weather]] ID | | [[Weather]] ID | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(Enumeration) | | (Enumeration) | ||
|[[Weather]] Type Effect | | [[Weather]] Type Effect | ||
|DROUGHT, FLOODING, NO_EFFECT, RAIN, SNOW or WIND | | DROUGHT, FLOODING, NO_EFFECT, RAIN, SNOW or WIND | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 27: | Line 27: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Revision as of 11:43, 8 June 2026
API Endpoint: api/session/event/editorweather/set_effect/
Description: Set what kind of Weather the specified Weather is.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (WEATHER Integer ID) | Weather ID | |
| 1 | REQUIRED | (Enumeration) | Weather Type Effect | DROUGHT, FLOODING, NO_EFFECT, RAIN, SNOW or WIND |
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/editorweather/set_effect/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "NO_EFFECT" ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "NO_EFFECT" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorweather/set_effect/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));