IsVehicleLocked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool isVehicleLocked ( vehicle theVehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isVehicleLocked ( vehicle theVehicle )</syntaxhighlight>
{{OOP||[[vehicle]]:isLocked|locked|setVehicleLocked}}


===Required Arguments===
===Required Arguments===
Line 13: Line 15:


==Example==
==Example==
This example creates a vehicle, then displays if it is locked or not in the chatbox (vehicles are created unlocked).
<section name="Server" class="server" show="true">
This example allows a player to lock his vehicle when he is inside it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
newcar = createVehicle ( 520, 1024, 1024, 1024 )
function lockcar ( thePlayer )
if isVehicleLocked ( newcar ) then
    playervehicle = getPlayerOccupiedVehicle ( thePlayer )   -- define 'playervehicle' as the vehicle the player is in
    outputChatBox ( "Vehicle is locked." )
    if ( playervehicle ) then                               -- if a player is in a vehicle
else
        if isVehicleLocked ( playervehicle ) then            -- and if the vehicle is already locked
     outputChatBox ( "Vehicle is unlocked." )
            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
end
addEventHandler ( "onPlayerSpawn", root, bindLockOnSpawn )    -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</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"