GetVehicleUpgrades: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(19 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
This function returns a table of all the upgrades on a specifed vehicle.
This function returns a table of all the upgrades on a specifed vehicle.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getVehicleUpgrades ( vehicle )
table getVehicleUpgrades ( vehicle theVehicle )
</syntaxhighlight>  
</syntaxhighlight>
 
{{OOP||[[vehicle]]:getUpgrades|upgrades}}
===Optional Arguments===  
===Required Arguments===  
*'''vehicle:''' The vehicle you wish to retrieve the upgrades of.
*'''theVehicle:''' The [[vehicle]] you wish to retrieve the upgrades of.


===Returns===
===Returns===
Returns a table of all the upgrades on each slot of a vehicle, 0 if un-used.
Returns a ''table'' of all the upgrades on each slot of a vehicle, which may be empty, or ''false'' if a valid vehicle is not passed.


==Example==
==Example==
<section name="Server" class="server" show="true">
This example prints the name and upgrades on each slot of an entered vehicle to the chat.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
function scriptOnPlayerEnterVehicle ( theVehicle, seat, jacked )
function onPlayerEnterVehicle ( vehicle, seat, jacked )
    local upgrades = getVehicleUpgrades ( theVehicle )
  upgrades = getVehicleUpgrades ( vehicle )
    for _, upgrade in ipairs ( upgrades ) do
  for upgradeKey, upgradeValue in upgrades do
        outputChatBox ( getVehicleUpgradeSlotName ( upgrade ) .. ": " .. upgrade )
    outputChatBox ( getVehicleUpgradeSlotName ( upgradeKey - 1 ) .. ": " .. upgradeValue )
    end
  end
end
end
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle_functions}}

Latest revision as of 08:40, 4 November 2020

This function returns a table of all the upgrades on a specifed vehicle.

Syntax

table getVehicleUpgrades ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getUpgrades(...)
Variable: .upgrades


Required Arguments

  • theVehicle: The vehicle you wish to retrieve the upgrades of.

Returns

Returns a table of all the upgrades on each slot of a vehicle, which may be empty, or false if a valid vehicle is not passed.

Example

Click to collapse [-]
Server

This example prints the name and upgrades on each slot of an entered vehicle to the chat.

function scriptOnPlayerEnterVehicle ( theVehicle, seat, jacked )
    local upgrades = getVehicleUpgrades ( theVehicle )
    for _, upgrade in ipairs ( upgrades ) do
        outputChatBox ( getVehicleUpgradeSlotName ( upgrade ) .. ": " .. upgrade )
    end
end
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )

See Also