GetVehicleMaxPassengers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Server client function}}
__NOTOC__
__NOTOC__
==Description==
This function returns the maximum number of passengers that a specified vehicle can hold. Only passenger seats are counted, the driver seat is excluded.
This function returns the maximum number of passengers that a specified vehicle can hold.
 
{{Important Note | Only passenger seats are counted, the driver seat is excluded.}}


==Syntax==
==Syntax==
int [[getVehicleMaxPassengers]] ([[vehicle]] vehicle)
<syntaxhighlight lang="lua">int getVehicleMaxPassengers ( vehicle theVehicle / int modelID )</syntaxhighlight>
{{OOP||[[vehicle]]:getMaxPassengers|maxPassengers}}
===Required Arguments===
*'''theVehicle:''' the [[vehicle]] that you wish to know the maximum capacity of.
OR
*'''modelID:''' the model id that you wish to know the maximum capacity of.


==Required Arguments==
===Returns===
*vehicle: A handle to the [[vehicle]] that you wish to know the maximum capacity of.
Returns an [[int]] indicating the maximum number of passengers that can enter a vehicle.


==Example==
==Example==
newcar = [[createVehicle]] ( 520, 1024, 1024, 1024 )
This example creates a vehicle then gets the number of passenger seats and outputs it in the chat box.
maxseats = [[getVehicleMaxPassengers]] ( newcar )
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a vehicle
[[serverChat]] ( "This vehicle supports ", maxseats, " passengers." )
numseats = getVehicleMaxPassengers ( newcar ) -- get the passenger seat count
outputChatBox ( "This vehicle supports " .. numseats .. " passengers." ) -- show it in the chat</syntaxhighlight>
 
==See Also==
{{Vehicle functions}}

Revision as of 11:42, 13 June 2018

This function returns the maximum number of passengers that a specified vehicle can hold. Only passenger seats are counted, the driver seat is excluded.


[[{{{image}}}|link=|]] Important Note: Only passenger seats are counted, the driver seat is excluded.

Syntax

int getVehicleMaxPassengers ( vehicle theVehicle / int modelID )

OOP Syntax Help! I don't understand this!

Method: vehicle:getMaxPassengers(...)
Variable: .maxPassengers


Required Arguments

  • theVehicle: the vehicle that you wish to know the maximum capacity of.

OR

  • modelID: the model id that you wish to know the maximum capacity of.

Returns

Returns an int indicating the maximum number of passengers that can enter a vehicle.

Example

This example creates a vehicle then gets the number of passenger seats and outputs it in the chat box.

newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a vehicle
numseats = getVehicleMaxPassengers ( newcar ) -- get the passenger seat count
outputChatBox ( "This vehicle supports " .. numseats .. " passengers." ) -- show it in the chat

See Also