Api session event editor weather: 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 10: Line 10:
|-
|-
| [[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.
| Duplicate the specified [[Weather]]s as independent copies.
|-
|-
| [[Api session event editor weather remove|remove]]
| [[Api session event editor weather remove|remove]]
Line 19: Line 19:
|-
|-
| [[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 specified [[Attribute]]s from the specified [[Weather]], including default [[Attribute]]s.
|-
|-
| [[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]]
Line 37: Line 37:
|-
|-
| [[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 the 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 the duration of the specified [[Weather]]'s visualization.
|-
|-
| [[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 the type of the specified [[Weather]].
|-
|-
| [[Api session event editor weather set flood overlay|set_flood_overlay]]
| [[Api session event editor weather set flood overlay|set_flood_overlay]]
Line 49: Line 49:
|-
|-
| [[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 the [[Trigger]] [[Time]] for the specified [[Weather]]'s visualization.
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
{{article end|seealso=*[[Api Session Endpoints]]

Latest revision as of 10:00, 13 July 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 Duplicate the specified Weathers as independent copies.
remove Remove the specified Weathers.
remove_attribute Remove specified Attributes from the specified Weather, including default Attributes.
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 the specified Weather.
set_duration Set the duration of the specified Weather's visualization.
set_effect Set the type of the specified Weather.
set_flood_overlay Set a specific visualization Overlay for a specified Weather.
set_trigger_sec Set the Trigger Time for the specified Weather's visualization.