SetVehicleLocked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function can be used to set a vehicle to be locked or unlocked
This function can be used to set a vehicle to be locked or unlocked.  Locking a vehicle restricts access to all doors of a vehicle.


==Syntax==  
==Syntax==  
Line 29: Line 29:
end
end


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


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

Revision as of 15:17, 29 August 2007

This function can be used to set a vehicle to be locked or unlocked. Locking a vehicle restricts access to all doors of a vehicle.

Syntax

bool setVehicleLocked ( vehicle theVehicle, bool locked )

Required Arguments

  • theVehicle: The vehicle which you wish to change the lock status of
  • locked: Boolean for the status you wish to set. Set true to lock, false to unlock

Returns

Returns true if the operation was successful, false otherwise.

Example

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", getRootElement(), bindLockOnSpawn )     -- add an event handler for onPlayerSpawn

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleLocked?oldid=11556"