Api session event editor weather: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editorweather/
<noinclude lang="text" copy>API Endpoint: api/session/event/editorweather/
 
</noinclude><noinclude lang="text" copy>
API endpoints for [[Weather]] editing.
API Endpoints for [[Weather]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!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]] with a [[Weather]] Type Effect
|-
|-
| [[Api session event editor weather append attribute|append_attribute]]
| [[Api session event editor weather append attribute|append_attribute]]
Line 13: Line 13:
|-
|-
| [[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 [[Weather]]s
|-
|-
| [[Api session event editor weather remove|remove]]
| [[Api session event editor weather remove|remove]]
| Remove the specified [[Weather]]s.
| Remove [[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 specified [[Attribute]]s a [[Weather]], including default [[Attribute]]s
|-
|-
| [[Api session event editor weather set attribute|set_attribute]]
| [[Api session event editor weather set attribute|set_attribute]]
Line 28: Line 28:
|-
|-
| [[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 of a [[Weather]]
|}
|}
 
<noinclude lang="text" copy>
Additional API endpoints:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!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 visualization [[Overlay]] from a [[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 [[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 [[Weather]] Type Effect of a [[Weather]]
|-
|-
| [[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 [[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 the [[Trigger]] [[Time]] for the specified [[Weather]]'s visualization
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items weathers]]
*[[Api session items weathers]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:27, 13 November 2026

API Endpoint: api/session/event/editorweather/

API Endpoints for Weather editing.

Name Description
add Add a new Weather with a Weather Type Effect
append_attribute Appended to existing Weather numeric Attribute value
duplicate Duplicate Weathers
remove Remove Weathers
remove_attribute Remove specified Attributes a Weather, including default Attributes
set_attribute Set Weather numeric Attribute value
set_attributes Set multiple Weather numeric Attribute values
set_name Set the name of a Weather

Additional API Endpoints:

Name Description
remove_flood_overlay Remove the visualization Overlay from a Weather
set_duration Set the duration of the Weather's visualization
set_effect Set the Weather Type Effect of a Weather
set_flood_overlay Set a specific visualization Overlay for a Weather
set_trigger_sec Set the Trigger Time for the specified Weather's visualization