GetVehicleNumberOfSeats: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetVehicleNumberOfSeats(vehicle)}} {{FuncParameters}} {{FuncParam|vehicle|__EDIT_ME__}} {{FuncRet...")
 
(Add client support for v1.1.0)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Returns the amount of seats a given vehicle has.}}


{{FuncSyntax|GetVehicleNumberOfSeats(vehicle)}}
{{FuncSyntax|GetVehicleNumberOfSeats(vehicle)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
{{FuncParam|vehicle|The vehicle identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Number of valid seats the given vehicle has. Returns '''false''' on error.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function cmd_vehicleseats(player, vehicle)
if (vehicle == nil) then
return AddPlayerChat(player, "Usage: /vehicleseats <vehicle>")
end
 
if (not IsValidVehicle(vehicle)) then
return AddPlayerChat(player, "Vehicle (ID: "..vehicle..") does not exist")
end
 
local seats = GetVehicleNumberOfSeats(vehicle)
 
AddPlayerChat(player, "Vehicle "..vehicle.." has "..seats)
end
AddCommand("passengers", cmd_passengers)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{VehicleFunctions}}

Latest revision as of 20:47, 7 March 2020

GetVehicleNumberOfSeats

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Returns the amount of seats a given vehicle has.

Syntax

GetVehicleNumberOfSeats(vehicle)

Parameters

  • vehicle
    The vehicle identifier.

Return Value

  • Number of valid seats the given vehicle has. Returns false on error.

Example

function cmd_vehicleseats(player, vehicle)
	if (vehicle == nil) then
		return AddPlayerChat(player, "Usage: /vehicleseats <vehicle>")
	end

	if (not IsValidVehicle(vehicle)) then
		return AddPlayerChat(player, "Vehicle (ID: "..vehicle..") does not exist")
	end

	local seats = GetVehicleNumberOfSeats(vehicle)

	AddPlayerChat(player, "Vehicle "..vehicle.." has "..seats)
end
AddCommand("passengers", cmd_passengers)

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetVehicleNumberOfSeats&oldid=3831"