IsVehicleLocked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Server client function}}
__NOTOC__
__NOTOC__
==Description==
This will tell you if a vehicle is locked.
This function returns a boolean value (true / false) depending on whether the specified vehicle is locked.  


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">isVehicleLocked ( vehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isVehicleLocked ( vehicle theVehicle )</syntaxhighlight>
 
{{OOP||[[vehicle]]:isLocked|locked|setVehicleLocked}}


===Required Arguments===
===Required Arguments===
*'''vehicle''': The [[vehicle]] that you need to obtain the locked status of.
*'''theVehicle:''' The [[vehicle]] that you want to obtain the locked status of.
 
===Returns===
Returns ''true'' if the vehicle specified is locked, ''false'' if is unlocked or the vehicle specified is invalid.


==Example==
==Example==
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
<section name="Server" class="server" show="true">
if isVehicleLocked ( newcar )
This example allows a player to lock his vehicle when he is inside it.
  outputChatBox ( "Vehicle is locked." )
<syntaxhighlight lang="lua">
else
function lockcar ( thePlayer )
  outputChatBox ( "Vehicle is unlocked." )
    playervehicle = getPlayerOccupiedVehicle ( thePlayer )   -- define 'playervehicle' as the vehicle the player is in
end</syntaxhighlight>
    if ( playervehicle ) then                                -- if a player is in a vehicle
        if isVehicleLocked ( playervehicle ) then            -- and if the vehicle is already locked
            setVehicleLocked ( playervehicle, false )       -- unlock it
        else                                                 -- otherwise (if it isn't locked)
            setVehicleLocked ( playervehicle, true )        -- lock it
        end
    end
end
 
function bindLockOnSpawn ( theSpawnpoint )                    -- when a player spawns
    bindKey ( source, "l", "down", "Lock car", lockcar )     -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", root, bindLockOnSpawn )    -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Latest revision as of 07:51, 4 November 2020

This will tell you if a vehicle is locked.

Syntax

bool isVehicleLocked ( vehicle theVehicle )


OOP Syntax Help! I don't understand this!

Method: vehicle:isLocked(...)
Variable: .locked
Counterpart: setVehicleLocked


Required Arguments

  • theVehicle: The vehicle that you want to obtain the locked status of.

Returns

Returns true if the vehicle specified is locked, false if is unlocked or the vehicle specified is invalid.

Example

Click to collapse [-]
Server

This example allows a player to lock his vehicle when he is inside it. 

function lockcar ( thePlayer )
    playervehicle = getPlayerOccupiedVehicle ( thePlayer )   -- define 'playervehicle' as the vehicle the player is in
    if ( playervehicle ) then                                -- if a player is in a vehicle
        if isVehicleLocked ( playervehicle ) then            -- and if the vehicle is already locked
            setVehicleLocked ( playervehicle, false )        -- unlock it
        else                                                 -- otherwise (if it isn't locked) 
            setVehicleLocked ( playervehicle, true )         -- lock it
        end
    end
end

function bindLockOnSpawn ( theSpawnpoint )                     -- when a player spawns
    bindKey ( source, "l", "down", "Lock car", lockcar )     -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", root, bindLockOnSpawn )     -- add an event handler for onPlayerSpawn

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsVehicleLocked?oldid=67669"