Vehicle::lowerConvertibleRoof: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
m (Replaced HTML with template)
 
Line 1: Line 1:
__TOC__
Lowers the roof of a convertable, can be done instantly or with the animation.


Lowers the roof of a convertable, can be done instantly or with the animation.
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">vehicle.lowerConvertibleRoof(instantlyLower);</syntaxhighlight>
<pre>vehicle.lowerConvertibleRoof(instantlyLower);</pre>
 
=== Required Arguments ===
=== Required Arguments ===
*'''instantlyLower:''' Boolean
*'''instantlyLower:''' Boolean
===Return value===
===Return value===
*'''Undefined'''
*'''Undefined'''
==Example==
==Example==
Pressing the F2 key will raise/lower your convertable roof
Pressing the F2 key will raise/lower your convertable roof
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
{{ClientsideCode|
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<pre>
<pre>
mp.keys.bind(0x71, true, function() {
mp.keys.bind(0x71, true, function() {
Line 24: Line 25:
});
});
</pre>
</pre>
</div>
}}
 
==See also==
==See also==
{{Vehicle_function_c}}
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]

Latest revision as of 13:27, 26 October 2018

Lowers the roof of a convertable, can be done instantly or with the animation.

Syntax

vehicle.lowerConvertibleRoof(instantlyLower);

Required Arguments

  • instantlyLower: Boolean

Return value

  • Undefined

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

Retrieved from "https://wiki.rage.mp/w/index.php?title=Vehicle::lowerConvertibleRoof&oldid=16016"