GetVehicleCompatibleUpgrades: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function returns a table of all the compatible upgrades (or all for a specified slot, optionally) for a specifed vehicle.
{{Server client function}}
This function returns a table of all the compatible upgrades (or all for a specified slot, optionally) for a specified vehicle.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getVehicleCompatibleUpgrades ( vehicle theVehicle, [int slot] )
table getVehicleCompatibleUpgrades ( vehicle theVehicle [, int slot ] )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[vehicle]]:getCompatibleUpgrades|compatibleUpgrades}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] you wish to retrieve the list of compatible upgrades of.
*'''theVehicle:''' the [[vehicle]] you wish to retrieve the list of compatible upgrades of.


===Optional Arguments===  
===Optional Arguments===  
*'''slot:''' The upgrade slot number for which you're getting the list (from 0 to 16). Compatible upgrades for all slots are listed if this is not specified.
*'''slot:''' the upgrade slot number for which you're getting the list (from 0 to 16). Compatible upgrades for all slots are listed if this is not specified.


===Returns===
===Returns===
Line 17: Line 18:


==Example==
==Example==
This example displays a list of all the compatible upgrades for a vehicle when you enter it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function scriptOnPlayerEnterVehicle ( invehicle, seat, jacked )
function scriptOnPlayerEnterVehicle ( invehicle, seat, jacked )
   local upgrades = getVehicleCompatibleUpgrades ( invehicle )
   local upgrades = getVehicleCompatibleUpgrades ( invehicle )
   for upgradeKey, upgradeValue in ipairs ( upgrades ) do
   for upgradeKey, upgradeValue in ipairs ( upgrades ) do
     outputChatBox ( getVehicleUpgradeSlotName ( upgradeKey - 1 ) .. ": " .. upgradeValue )
     outputChatBox ( getVehicleUpgradeSlotName ( upgradeValue ) .. ": " .. upgradeValue )
   end
   end
end
end
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), scriptOnPlayerEnterVehicle )
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 09:10, 4 November 2020

This function returns a table of all the compatible upgrades (or all for a specified slot, optionally) for a specified vehicle.

Syntax

table getVehicleCompatibleUpgrades ( vehicle theVehicle [, int slot ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:getCompatibleUpgrades(...)
Variable: .compatibleUpgrades


Required Arguments

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

Optional Arguments

  • slot: the upgrade slot number for which you're getting the list (from 0 to 16). Compatible upgrades for all slots are listed if this is not specified.

Returns

Returns a table with all the compatible upgrades, or false if invalid arguments are passed.

Example

This example displays a list of all the compatible upgrades for a vehicle when you enter it. 

function scriptOnPlayerEnterVehicle ( invehicle, seat, jacked )
  local upgrades = getVehicleCompatibleUpgrades ( invehicle )
  for upgradeKey, upgradeValue in ipairs ( upgrades ) do
    outputChatBox ( getVehicleUpgradeSlotName ( upgradeValue ) .. ": " .. upgradeValue )
  end
end
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleCompatibleUpgrades?oldid=67715"