GetVehicleOccupant: Difference between revisions

Latest revision as of 21:58, 27 June 2020

This function gets the player sitting/trying to enter the specified vehicle.

Syntax

player getVehicleOccupant ( vehicle theVehicle, [ int seat=0 ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:getOccupant(...)

Required Arguments

theVehicle: the vehicle of which you wish to retrieve the driver or a passenger.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

seat: the seat where the player is sitting (0 for driver, 1+ for passengers).

Returns

Returns the player sitting in the vehicle, or false if the seat is unoccupied or doesn't exist.

Example

This example announces the driver of a certain vehicle whenever it is damaged:

function onStolenVehicleDamage ( loss )
    local driver = getVehicleOccupant ( source ) -- get the player sitting in seat 0
    if ( driver ) then -- if the driver exists, display a message
        outputChatBox ( getPlayerName ( driver ) .. " is wrecking the vehicle he stole!" )
    end
end
addEventHandler ( "onVehicleDamage", stolenVehicle, onStolenVehicleDamage )

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
+__NOTOC__
+{{Server client function}}
-__NOTOC__
+This function gets the player sitting/trying to enter the specified vehicle.
-This fake function is for use with blah & blah and does blahblahblabhalbhl
 ==Syntax==
 <syntaxhighlight lang="lua">
-player getVehicleOccupant ( vehicle vehicle, [ int seat=0 ] )
+player getVehicleOccupant ( vehicle theVehicle, [ int seat=0 ] )
 </syntaxhighlight>
+{{OOP||[[vehicle]]:getOccupant}}
 ===Required Arguments===
-*'''argumentName:''' description
+*'''theVehicle:''' the [[vehicle]] of which you wish to retrieve the driver or a passenger.
 ===Optional Arguments===
 {{OptionalArg}}
-*'''argumentName2:''' descriptiona
+*'''seat:''' the seat where the player is sitting (0 for driver, 1+ for passengers).
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns the [[player]] sitting in the vehicle, or ''false'' if the seat is unoccupied or doesn't exist.
 ==Example==
-This example does...
+This example announces the driver of a certain vehicle whenever it is damaged:
 <syntaxhighlight lang="lua">
---This line does...
+function onStolenVehicleDamage ( loss )
-blabhalbalhb --abababa
+    local driver = getVehicleOccupant ( source ) -- get the player sitting in seat 0
---This line does this...
+    if ( driver ) then -- if the driver exists, display a message
-mooo
+        outputChatBox ( getPlayerName ( driver ) .. " is wrecking the vehicle he stole!" )
+    end
+end
+addEventHandler ( "onVehicleDamage", stolenVehicle, onStolenVehicleDamage )
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{Vehicle_functions}}