GetWeatherTransitionDuration: Difference between revisions

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search
Complete Lua function catalog
Complete upcoming 0.1.9 documentation: weather, crafting UI, world removal, doors and ladders; preserve release status
Line 31: Line 31:
[[Category:Server Functions]]
[[Category:Server Functions]]
[[Category:World Functions]]
[[Category:World Functions]]
<!-- weather019:start -->
== Extended weather from 0.1.9 ==
'''Available from 0.1.9 (upcoming; not yet publicly released). Not included in public 0.1.8. Use matching updated clients and server.'''
This existing API retains its call shape; the catalog is extended, not restricted to five names. See [[Weather]] and [[Weather catalog]]. Server target/revision and client acknowledgement are not proof of the final rendered image. The new presets still require in-game visual qualification; use compatible clients and test late join, indoor areas and returning to ordinary weather.
<!-- weather019:end -->

Revision as of 20:56, 19 October 2026

getWeatherTransitionDuration

Returns the transition duration associated with the current authoritative weather state.

Syntax

int transitionMs = getWeatherTransitionDuration()

Parameters

This function does not accept parameters.

Returns

Returns the transition duration in milliseconds.

Examples

Display the current weather and transition duration:

local message = string.format(
    "Weather: %s (%d ms)",
    getWeather(),
    getWeatherTransitionDuration())
outputDebugString(message)

Notes

  • Available only in server-side resource scripts.
  • A value of 0 indicates an immediate weather transition.

Extended weather from 0.1.9

Available from 0.1.9 (upcoming; not yet publicly released). Not included in public 0.1.8. Use matching updated clients and server.

This existing API retains its call shape; the catalog is extended, not restricted to five names. See Weather and Weather catalog. Server target/revision and client acknowledgement are not proof of the final rendered image. The new presets still require in-game visual qualification; use compatible clients and test late join, indoor areas and returning to ordinary weather.