GetVehicleCompatibleUpgrades: Difference between revisions

Revision as of 00:09, 24 March 2007

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

Syntax

table getVehicleCompatibleUpgrades ( vehicle theVehicle, [int slot] )

Required Arguments

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

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

addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
function onPlayerEnterVehicle ( vehicle, seat, jacked )
  upgrades = getVehicleCompatibleUpgrades ( vehicle )
  for upgradeKey, upgradeValue in upgrades do
    outputChatBox ( getVehicleUpgradeSlotName ( upgradeKey - 1 ) .. ": " .. upgradeValue )
  end
end

@@ Line 1: / Line 1: @@
+__NOTOC__
+This function returns a table of all the compatible upgrades (or all for a specified slot, optionally) for a specifed vehicle.
 ==Syntax==
-<syntaxhighlight lang="lua">table getVehicleCompatibleUpgrades ( [int slot] )</syntaxhighlight>
+<syntaxhighlight lang="lua">
+table getVehicleCompatibleUpgrades ( vehicle theVehicle, [int slot] )
+</syntaxhighlight>
+===Required Arguments===
+*'''theVehicle:''' The vehicle you wish to retrieve the list of compatible upgrades.
+===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==
+<syntaxhighlight lang="lua">
+addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
+function onPlayerEnterVehicle ( vehicle, seat, jacked )
+  upgrades = getVehicleCompatibleUpgrades ( vehicle )
+  for upgradeKey, upgradeValue in upgrades do
+    outputChatBox ( getVehicleUpgradeSlotName ( upgradeKey - 1 ) .. ": " .. upgradeValue )
+  end
+end
+</syntaxhighlight>
+==See Also==
+{{Vehicle_functions}}