Vehicle::getConvertibleRoofState: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
 
(Added example)
Line 1: Line 1:
0 -&gt; up<br>1 -&gt; lowering down<br>2 -&gt; down<br>3 -&gt; raising up
Gets the current state of the roof of the convertible.
 
'''States'''
*0 - Up
*1 - Lowering Down
*2 - Down
*3 - Raising Up
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getConvertibleRoofState();</syntaxhighlight>
<syntaxhighlight lang="javascript">vehicle.getConvertibleRoofState();</syntaxhighlight>
=== Required Arguments ===
===Return value===
===Return value===
*'''int'''
*'''int'''
==Example==
==Example==
<syntaxhighlight lang="javascript">
Pressing the F2 key will raise/lower your convertable roof
// todo
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
</syntaxhighlight>
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<pre>
mp.keys.bind(0x71, true, function() {
    let roofState =  mp.players.local.vehicle.getConvertibleRoofState();
    if(roofState === 0){
        mp.players.local.vehicle.lowerConvertibleRoof(false);
    } else if (roofState === 2){
        mp.players.local.vehicle.raiseConvertibleRoof(false);
    } else {
        mp.gui.chat.push("Please wait for the roof to stop changing.");
    }
});
</pre>
</div>
==See also==
==See also==
{{Vehicle_function_c}}
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]

Revision as of 10:16, 13 October 2018

Gets the current state of the roof of the convertible.

States

  • 0 - Up
  • 1 - Lowering Down
  • 2 - Down
  • 3 - Raising Up

Syntax

vehicle.getConvertibleRoofState();

Return value

  • int

Example

Pressing the F2 key will raise/lower your convertable roof

Client-Side
mp.keys.bind(0x71, true, function() {
    let roofState =  mp.players.local.vehicle.getConvertibleRoofState();
    if(roofState === 0){
        mp.players.local.vehicle.lowerConvertibleRoof(false);
    } else if (roofState === 2){
        mp.players.local.vehicle.raiseConvertibleRoof(false);
    } else {
        mp.gui.chat.push("Please wait for the roof to stop changing.");
    }
});

See also