IsVehicleLocked: 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__
==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>


===Required Arguments===
===Required Arguments===
*'''vehicle''': The [[vehicle]] that you need to obtain the locked status of.
*'''theVehicle''': The [[vehicle]] that you need 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==
This example creates a vehicle then displays if it is locked or not in the chatbox (vehicles are created unlocked).
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
if isVehicleLocked ( newcar )
if isVehicleLocked ( newcar )

Revision as of 15:29, 15 August 2006

This will tell you if a vehicle is locked.

Syntax

bool isVehicleLocked ( vehicle theVehicle )

Required Arguments

  • theVehicle: The vehicle that you need 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

This example creates a vehicle then displays if it is locked or not in the chatbox (vehicles are created unlocked). 

newcar = createVehicle ( 520, 1024, 1024, 1024 )
if isVehicleLocked ( newcar )
  outputChatBox ( "Vehicle is locked." )
else
  outputChatBox ( "Vehicle is unlocked." )
end

See Also


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