Api session event editor weather: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 6: | Line 6: | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor weather add|add]] | | [[Api session event editor weather add|add]] | ||
|Add a new [[Weather]] of a specified type. | | Add a new [[Weather]] of a specified type. | ||
|- | |- | ||
|[[Api session event editor weather append attribute|append_attribute]] | | [[Api session event editor weather append attribute|append_attribute]] | ||
|Appended to existing [[Weather]] [[Attribute]] value | | Appended to existing [[Weather]] numeric [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor weather duplicate|duplicate]] | | [[Api session event editor weather duplicate|duplicate]] | ||
|Create a copy of each specified [[Weather]]. The copies will have the same [[Setting]]s and [[Attribute]]s, but can be edited independently of the originals. | | Create a copy of each specified [[Weather]]. The copies will have the same [[Setting]]s and [[Attribute]]s, but can be edited independently of the originals. | ||
|- | |- | ||
|[[Api session event editor weather remove|remove]] | | [[Api session event editor weather remove|remove]] | ||
|Remove the specified [[Weather]]s. | | Remove the specified [[Weather]]s. | ||
|- | |- | ||
|[[Api session event editor weather remove attribute|remove_attribute]] | | [[Api session event editor weather remove attribute|remove_attribute]] | ||
|Remove the specified [[Attribute]]s of the specified [[Weather]]. The [[Attribute]]s, including [[Attribute]]s which are added to a [[Weather]] by default, are removed entirely. | | Remove the specified [[Attribute]]s of the specified [[Weather]]. The [[Attribute]]s, including [[Attribute]]s which are added to a [[Weather]] by default, are removed entirely. | ||
|- | |- | ||
|[[Api session event editor weather set attribute|set_attribute]] | | [[Api session event editor weather set attribute|set_attribute]] | ||
|Set [[Weather]] [[Attribute]] value | | Set [[Weather]] numeric [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor weather set attributes|set_attributes]] | | [[Api session event editor weather set attributes|set_attributes]] | ||
|Set multiple [[Weather]] [[Attribute]] values | | Set multiple [[Weather]] numeric [[Attribute]] values | ||
|- | |- | ||
|[[Api session event editor weather set name|set_name]] | | [[Api session event editor weather set name|set_name]] | ||
|Set the name for a specified [[Weather]]. | | Set the name for a specified [[Weather]]. | ||
|} | |} | ||
| Line 36: | Line 36: | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor weather remove flood overlay|remove_flood_overlay]] | | [[Api session event editor weather remove flood overlay|remove_flood_overlay]] | ||
|Remove the specified visualization [[Overlay]] from specified [[Weather]]. | | Remove the specified visualization [[Overlay]] from specified [[Weather]]. | ||
|- | |- | ||
|[[Api session event editor weather set duration|set_duration]] | | [[Api session event editor weather set duration|set_duration]] | ||
|Set how long the specified [[Weather]]'s visualization lasts when it is [[Trigger]]ed. | | Set how long the specified [[Weather]]'s visualization lasts when it is [[Trigger]]ed. | ||
|- | |- | ||
|[[Api session event editor weather set effect|set_effect]] | | [[Api session event editor weather set effect|set_effect]] | ||
|Set what kind of [[Weather]] the specified [[Weather]] is. | | Set what kind of [[Weather]] the specified [[Weather]] is. | ||
|- | |- | ||
|[[Api session event editor weather set flood overlay|set_flood_overlay]] | | [[Api session event editor weather set flood overlay|set_flood_overlay]] | ||
|Set a specific visualization [[Overlay]] for a specified [[Weather]]. | | Set a specific visualization [[Overlay]] for a specified [[Weather]]. | ||
|- | |- | ||
|[[Api session event editor weather set trigger sec|set_trigger_sec]] | | [[Api session event editor weather set trigger sec|set_trigger_sec]] | ||
|Set whether the specified [[Weather]]'s visualization [[Trigger]]s automatically. | | Set whether the specified [[Weather]]'s visualization [[Trigger]]s automatically. | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Latest revision as of 12:24, 17 June 2026
API Endpoint: api/session/event/editorweather/
API endpoints for Weather editing.
| Name | Description |
|---|---|
| add | Add a new Weather of a specified type. |
| append_attribute | Appended to existing Weather numeric Attribute value |
| duplicate | Create a copy of each specified Weather. The copies will have the same Settings and Attributes, but can be edited independently of the originals. |
| remove | Remove the specified Weathers. |
| remove_attribute | Remove the specified Attributes of the specified Weather. The Attributes, including Attributes which are added to a Weather by default, are removed entirely. |
| set_attribute | Set Weather numeric Attribute value |
| set_attributes | Set multiple Weather numeric Attribute values |
| set_name | Set the name for a specified Weather. |
Additional API endpoints:
| Name | Description |
|---|---|
| remove_flood_overlay | Remove the specified visualization Overlay from specified Weather. |
| set_duration | Set how long the specified Weather's visualization lasts when it is Triggered. |
| set_effect | Set what kind of Weather the specified Weather is. |
| set_flood_overlay | Set a specific visualization Overlay for a specified Weather. |
| set_trigger_sec | Set whether the specified Weather's visualization Triggers automatically. |