GetVehicleCompatibleUpgrades: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Example: Added example description)
Line 17: Line 17:


==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 )

Revision as of 14:20, 30 July 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 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 ( upgradeKey - 1 ) .. ": " .. upgradeValue )
  end
end
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), scriptOnPlayerEnterVehicle )

See Also