RAGE Multiplayer Wiki - User contributions [en]

Player::isClimbing

2023-04-20T22:24:03Z

ImperiumXVII:

This property returns true or false of player climbing state.

'''Note: TypeScript types are wrong - this is not a boolean, but a method.'''
== Example ==
<source lang="javascript">
let playerIsClimbing = player.isClimbing()
if (playerIsClimbing)
player.outputChatBox('You are climbing right now!');
else
player.outputChatBox('You are not climbing right now!');
</source>

==See Also==
{{Player_block}}

Player::isClimbing

2023-04-20T22:23:25Z

ImperiumXVII: /* Example */

This property returns true or false of player climbing state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsClimbing = player.isClimbing()
if (playerIsClimbing)
player.outputChatBox('You are climbing right now!');
else
player.outputChatBox('You are not climbing right now!');
</source>

==See Also==
{{Player_block}}

Gameplay::setWeatherTypeOverTime

2020-11-15T20:29:34Z

ImperiumXVII:

This function transitions the weather from one weather type to another over the specified amount of time in seconds.

For example, it is now EXTRASUNNY. The weather is now transitioning to THUNDER over 60 minutes. Rain will slowly start and clouds will slowly form over the time of 1 hour, rather than it being instant like [[World::weather]]

You only have to specify the new weather.

==Syntax==
<syntaxhighlight lang="javascript">mp.game.gameplay.setWeatherTypeOverTime(weatherType, time);</syntaxhighlight>
=== Required Arguments ===
*'''weatherType:''' String
*'''time:''' float
===Return value===
*'''Undefined'''
==Example==
This example will call the client-side event 'transitionWeather' for the every player, to synchronise the weather. This gradually transitions the weather over x seconds, not milliseconds.

{{ClientsideCode|
<pre>
//newWeather - string, any of weather / timeTaken - time taken to transition from old weather to new weather in seconds

mp.events.add('transitionWeather', (newWeather, timeTaken) => {
mp.game.gameplay.setWeatherTypeOverTime(newWeather, timeTaken);
});
</pre>
}}

{{ServersideCode|
<pre>
//In a setweather command for example with params 'params.weather' and 'params.time'

mp.players.forEach((player) => {
player.call('transitionWeather', [params.weather, params.time])
});
</pre>
}}

==See also==
{{Gameplay_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Gameplay::setWeatherTypeOverTime

2020-11-15T20:26:48Z

ImperiumXVII: /* Example */

==Syntax==
<syntaxhighlight lang="javascript">mp.game.gameplay.setWeatherTypeOverTime(weatherType, time);</syntaxhighlight>
=== Required Arguments ===
*'''weatherType:''' String
*'''time:''' float
===Return value===
*'''Undefined'''
==Example==
This example will call the client-side event 'transitionWeather' for the every player, to synchronise the weather. This gradually transitions the weather over x seconds, not milliseconds.

{{ClientsideCode|
<pre>
//newWeather - string, any of weather / timeTaken - time taken to transition from old weather to new weather in seconds

mp.events.add('transitionWeather', (newWeather, timeTaken) => {
mp.game.gameplay.setWeatherTypeOverTime(newWeather, timeTaken);
});
</pre>
}}

{{ServersideCode|
<pre>
//In a setweather command for example with params 'params.weather' and 'params.time'

mp.players.forEach((player) => {
player.call('transitionWeather', [params.weather, params.time])
});
</pre>
}}

==See also==
{{Gameplay_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]