World::setWeatherTransition: Difference between revisions
(Added example) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | |||
{{ServersideJsFunction}} | |||
This function start a weather transition to the weather specified and sync it to all clients. | This function start a weather transition to the weather specified and sync it to all clients. | ||
{{JSContainer| | |||
== Syntax == | |||
<pre>mp.world.setWeatherTransition(weather, easeTime)</pre> | |||
== Required Arguments == | |||
*{{Required}}'''weather''': {{RageType|String}} ([[Weather]]) | |||
*'''easeTime''': {{RageType|Int}} (Weather transitioning time) | |||
'''Note''': the second use with easeTime field seems to be buggy, it has graphical issues with transition from SMOG to FOGGY weather (and probably with some other weather), so right now the best choice would be to do weather transition on client side and sync it manually. | |||
==Example== | ==Example== | ||
< | {{ServersideCode| | ||
<pre> | |||
mp.world.setWeatherTransition("CLEARING"); // Set's the server's weather to 'CLEARING' immediately | mp.world.setWeatherTransition("CLEARING"); // Set's the server's weather to 'CLEARING' immediately | ||
</ | </pre> | ||
< | <pre> | ||
mp.world.setWeatherTransition("CLEARING", 600000); // Set's the server's weather to 'CLEARING' with 10 minutes transition | mp.world.setWeatherTransition("CLEARING", 600000); // Set's the server's weather to 'CLEARING' with 10 minutes transition | ||
</ | </pre> | ||
}} | |||
}} | |||
==See Also== | ==See Also== | ||
{{World_definition}} | {{World_definition}} | ||
Latest revision as of 08:55, 7 December 2019
Server-Side Function
 JavaScript
|
|---|
This function start a weather transition to the weather specified and sync it to all clients.
JavaScript Syntax
Syntax
mp.world.setWeatherTransition(weather, easeTime)
Required Arguments
- *weather: String (Weather)
- easeTime: Int (Weather transitioning time)
Note: the second use with easeTime field seems to be buggy, it has graphical issues with transition from SMOG to FOGGY weather (and probably with some other weather), so right now the best choice would be to do weather transition on client side and sync it manually.
Example
Server-Side
mp.world.setWeatherTransition("CLEARING"); // Set's the server's weather to 'CLEARING' immediately
mp.world.setWeatherTransition("CLEARING", 600000); // Set's the server's weather to 'CLEARING' with 10 minutes transition