GetVehicleOccupants - Revision history

Timur2915 at 08:24, 22 October 2019

2019-10-22T08:24:00Z

← Older revision		Revision as of 08:24, 22 October 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function gets all ~~players~~ sitting in the specified vehicle.		This function gets all peds sitting in the specified vehicle.

	==Syntax==		==Syntax==

Pirulax: /* Example */

2018-06-12T19:49:44Z

Example

← Older revision		Revision as of 19:49, 12 June 2018
Line 38:		Line 38:
	return false		return false
	end		end
	outputConsole("------------------------------------"~~, player~~) -- Print a separator for easier reading		outputConsole("------------------------------------") -- Print a separator for easier reading
	for seat, occupant in pairs(getVehicleOccupants(getPedOccupiedVehicle(~~player~~))) do -- Loop through the array		for seat, occupant in pairs(getVehicleOccupants(getPedOccupiedVehicle(localPlayer))) do -- Loop through the array
	outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant)~~, player~~) -- Print who's in the seat		outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant)) -- Print who's in the seat
	end		end
	outputConsole("------------------------------------"~~, player~~) -- Print another separator		outputConsole("------------------------------------") -- Print another separator
	end		end
	addCommandHandler("occupants", outputOccupants) -- Add a command "/occupants" which triggers outputOccupants		addCommandHandler("occupants", outputOccupants, false, false) -- Add a command "/occupants" which triggers outputOccupants
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Vehicle_functions}}		{{Vehicle_functions}}

Pirulax: /* Example */

2018-06-12T19:49:11Z

Example

← Older revision		Revision as of 19:49, 12 June 2018
Line 32:		Line 32:
	This example prints all vehicle occupants into the F8 console if "/occupants" is typed:		This example prints all vehicle occupants into the F8 console if "/occupants" is typed:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function outputOccupants(~~player~~)		function outputOccupants()
	-- Make sure they're in a vehicle		-- Make sure they're in a vehicle
	if (not isPedInVehicle(~~player~~)) then		if (not isPedInVehicle(localPlayer)) then
	outputConsole("You're not in a vehicle."~~, player~~)		outputConsole("You're not in a vehicle.")
	return false		return false
	end		end
	outputConsole("------------------------------------", player) -- Print a separator for easier reading		outputConsole("------------------------------------", player) -- Print a separator for easier reading
	~~local vehicle = getPedOccupiedVehicle(player)~~		for seat, occupant in pairs(getVehicleOccupants(getPedOccupiedVehicle(player))) do -- Loop through the array
	~~local occupants = getVehicleOccupants(vehicle) or {} -- In case it returned false, loop an empty table.~~		outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat
	for seat, occupant in pairs(~~occupants~~) do -- Loop through the array
	~~if (occupant and getElementType(occupant) == "player") then -- Make sure the occupant is a player~~
	outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat
	~~end~~
	end		end
	outputConsole("------------------------------------", player) -- Print another separator		outputConsole("------------------------------------", player) -- Print another separator

Pirulax at 19:47, 12 June 2018

2018-06-12T19:47:41Z

← Older revision		Revision as of 19:47, 12 June 2018
Line 17:		Line 17:

	<div style='font-weight: bold;background:blue;color:white;padding:2px; padding-left:8px;'>COUNTING PLAYERS IN A VEHICLE</div>		<div style='font-weight: bold;background:blue;color:white;padding:2px; padding-left:8px;'>COUNTING PLAYERS IN A VEHICLE</div>
	<div style='border: 2px solid blue;padding: 5px;'>Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead~~. You can simply use #table to get occupants count~~.		<div style='border: 2px solid blue;padding: 5px;'>Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local counter = 0		local counter = 0

MrDadosz at 01:02, 25 April 2018

2018-04-25T01:02:14Z

← Older revision		Revision as of 01:02, 25 April 2018
Line 17:		Line 17:

	<div style='font-weight: bold;background:blue;color:white;padding:2px; padding-left:8px;'>COUNTING PLAYERS IN A VEHICLE</div>		<div style='font-weight: bold;background:blue;color:white;padding:2px; padding-left:8px;'>COUNTING PLAYERS IN A VEHICLE</div>
	<div style='border: 2px solid blue;padding: 5px;'>Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.		<div style='border: 2px solid blue;padding: 5px;'>Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead. You can simply use #table to get occupants count.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local counter = 0		local counter = 0

Necktrox: Extended warning about counting players in a vehicle

2016-05-07T20:12:29Z

Extended warning about counting players in a vehicle

← Older revision		Revision as of 20:12, 7 May 2016
Line 16:		Line 16:
	Returns ''false'' if an invalid vehicle was passed or if the vehicle has no seats (like a trailer)		Returns ''false'' if an invalid vehicle was passed or if the vehicle has no seats (like a trailer)

	'''~~Note~~:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.		<div style='font-weight: bold;background:blue;color:white;padding:2px; padding-left:8px;'>COUNTING PLAYERS IN A VEHICLE</div>
			<div style='border: 2px solid blue;padding: 5px;'>Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.
			<syntaxhighlight lang="lua">
			local counter = 0

			for seat, player in pairs(getVehicleOccupants(pseudoVehicle)) do
			counter = counter + 1
			end

			outputDebugString("Players in your vehicle: ".. counter)
			</syntaxhighlight>
			</div>

	==Example==		==Example==

Strix: OOP

2014-10-13T16:09:05Z

OOP

← Older revision		Revision as of 16:09, 13 October 2014
Line 1:		Line 1:
			__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~__NOTOC__~~
	This function gets all players sitting in the specified vehicle.		This function gets all players sitting in the specified vehicle.

Line 7:		Line 7:
	table getVehicleOccupants ( vehicle theVehicle )		table getVehicleOccupants ( vehicle theVehicle )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:getOccupants\|occupants}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' ~~The~~ vehicle of which you wish to retrieve the occupants.		*'''theVehicle:''' the [[vehicle]] of which you wish to retrieve the occupants.

	===Returns===		===Returns===

Arran Fortuna at 15:28, 31 July 2014

2014-07-31T15:28:39Z

← Older revision		Revision as of 15:28, 31 July 2014
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns a [[table]] with ~~contents...~~		Returns a [[table]] with seat ID as an index and the occupant as an element like this: table[seat] = occupant

	~~table[seat] = occupant~~		Returns ''false'' if an invalid vehicle was passed or if the vehicle has no seats (like a trailer)

	~~... if successful.~~ Returns ''false'' in the ~~case of failure.~~

	'''Note:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.		'''Note:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.
Line 24:		Line 22:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function outputOccupants(player)		function outputOccupants(player)
	if isPedInVehicle(player) then ~~-- If he is actually~~ in a vehicle...		-- Make sure they're in a vehicle
	outputConsole("------------------------------------", player) -- Print a ~~seprerator~~ for easier reading		if (not isPedInVehicle(player)) then
	for seat, occupant in pairs(~~getVehicleOccupants(getPedOccupiedVehicle(player))~~) do -- Loop through the array		outputConsole("You're not in a vehicle.", player)
	if getElementType(occupant) == "player" then		return false
	outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat		end
	~~end~~		outputConsole("------------------------------------", player) -- Print a separator for easier reading
			local vehicle = getPedOccupiedVehicle(player)
			local occupants = getVehicleOccupants(vehicle) or {} -- In case it returned false, loop an empty table.
			for seat, occupant in pairs(occupants) do -- Loop through the array
			if (occupant and getElementType(occupant) == "player") then -- Make sure the occupant is a player
			outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat
	end		end
	~~outputConsole("------------------------------------",player) -- Print another seprerator~~
	end		end
			outputConsole("------------------------------------", player) -- Print another separator
	end		end
	addCommandHandler("occupants",outputOccupants) -- Add a command "/occupants" which triggers outputOccupants		addCommandHandler("occupants", outputOccupants) -- Add a command "/occupants" which triggers outputOccupants
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Vehicle_functions}}		{{Vehicle_functions}}

Funstein: Made example prettier

2013-08-06T20:23:00Z

Made example prettier

← Older revision		Revision as of 20:23, 6 August 2013
Line 22:		Line 22:
	==Example==		==Example==
	This example prints all vehicle occupants into the F8 console if "/occupants" is typed:		This example prints all vehicle occupants into the F8 console if "/occupants" is typed:
	<syntaxhighlight lang="lua">function outputOccupants(player)		<syntaxhighlight lang="lua">
			function outputOccupants(player)
	if isPedInVehicle(player) then -- If he is actually in a vehicle...		if isPedInVehicle(player) then -- If he is actually in a vehicle...
	~~local veh = getPedOccupiedVehicle(player) -- Get the vehicle the player is in~~		outputConsole("------------------------------------", player) -- Print a seprerator for easier reading
	~~local occupants = getVehicleOccupants(veh) -- Get all vehicle occupants~~		for seat, occupant in pairs(getVehicleOccupants(getPedOccupiedVehicle(player))) do -- Loop through the array
			if getElementType(occupant) == "player" then
	outputConsole("------------------------------------",player) -- Print a seprerator for easier reading		outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat

	for seat, occupant in pairs(~~occupants~~) do -- Loop through the array
	if getElementType(occupant)=="player" then ~~-- If the seat is occupied by a player...~~
	~~occupant = getPlayerName~~(~~occupant) --~~ ... ~~get his/her name~~
	~~elseif getElementType(occupant)==~~"~~ped~~" ~~then -- If the seat is occupied by a ped~~...
	occupant ~~= "<ped>"~~ -- ~~... clear up there~~'s ~~a ped~~ in the seat
	end		end

	~~outputConsole("Seat "..seat..": "..occupant,player) -- Print who's in the seat~~
	end		end

	outputConsole("------------------------------------",player) -- Print another seprerator		outputConsole("------------------------------------",player) -- Print another seprerator
	end		end

Funstein at 13:40, 30 December 2012

2012-12-30T13:40:11Z

← Older revision		Revision as of 13:40, 30 December 2012
Line 18:		Line 18:
	... if successful. Returns ''false'' in the case of failure.		... if successful. Returns ''false'' in the case of failure.

	'''Note:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. ~~Refer to the example for~~ a ~~way to get around this~~.		'''Note:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.

	==Example==		==Example==
Line 24:		Line 24:
	<syntaxhighlight lang="lua">function outputOccupants(player)		<syntaxhighlight lang="lua">function outputOccupants(player)
	if isPedInVehicle(player) then -- If he is actually in a vehicle...		if isPedInVehicle(player) then -- If he is actually in a vehicle...
	local veh = getPedOccupiedVehicle(player) -- Get the vehicle the player is in		local veh = getPedOccupiedVehicle(player) -- Get the vehicle the player is in
	local occupants = getVehicleOccupants(veh) -- Get all vehicle occupants		local occupants = getVehicleOccupants(veh) -- Get all vehicle occupants
	~~local seats = getVehicleMaxPassengers(veh) -- Get the amount of passenger seats~~

	outputConsole("------------------------------------",player) -- Print a seprerator for easier reading		outputConsole("------------------------------------",player) -- Print a seprerator for easier reading

	for seat ~~= 0~~, ~~seats do -- Repeat with seat = 0, incrementing until it reaches the amount of passenger seats the vehicle has~~		for seat, occupant in pairs(occupants) do -- Loop through the array
	~~local~~ occupant = occupants~~[seat]~~ -- ~~Get~~ the ~~occupant~~		if getElementType(occupant)=="player" then -- If the seat is occupied by a player...

	if ~~occupant and~~ getElementType(occupant)=="player" then -- If the seat is occupied by a player...
	occupant = getPlayerName(occupant) -- ... get his/her name		occupant = getPlayerName(occupant) -- ... get his/her name
	elseif ~~occupant and~~ getElementType(occupant)=="ped" then -- If the seat is occupied by a ped...		elseif getElementType(occupant)=="ped" then -- If the seat is occupied by a ped...
	occupant = "<ped>" -- ... clear up there's a ped in the seat		occupant = "<ped>" -- ... clear up there's a ped in the seat
	~~else -- If the seat is unoccupied...~~
	~~occupant = "<empty>" -- ... clear up that the seat is empty~~
	end		end