GetVehicleCompatibleUpgrades: Difference between revisions

Revision as of 23:56, 14 January 2008

	This article needs checking.
	Reason(s): Are all vehicle updates listed? I didn't see wheel updates in the list for instance.

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 ( upgradeValue ) .. ": " .. upgradeValue )
  end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), scriptOnPlayerEnterVehicle )

@@ Line 27: / Line 27: @@
    end
 end
-addEventHandler ( "onPlayerEnterVehicle", getRootElement(), scriptOnPlayerEnterVehicle )
+addEventHandler ( "onPlayerVehicleEnter", getRootElement(), scriptOnPlayerEnterVehicle )
 </syntaxhighlight>
 ==See Also==
 {{Vehicle functions}}