GetVehicleUpgrades: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(18 intermediate revisions by 9 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}} | |||
=== | ===Required Arguments=== | ||
*''' | *'''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, | 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"> | ||
function scriptOnPlayerEnterVehicle ( theVehicle, seat, jacked ) | |||
function | local upgrades = getVehicleUpgrades ( theVehicle ) | ||
for _, upgrade in ipairs ( upgrades ) do | |||
outputChatBox ( getVehicleUpgradeSlotName ( upgrade ) .. ": " .. upgrade ) | |||
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 [-]
ServerThis 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
- addVehicleUpgrade
- attachTrailerToVehicle
- blowVehicle
- createVehicle
- detachTrailerFromVehicle
- fixVehicle
- getOriginalHandling
- getTrainDirection
- getTrainPosition
- getTrainSpeed
- getTrainTrack
- getVehicleColor
- getVehicleCompatibleUpgrades
- getVehicleController
- getVehicleDoorOpenRatio
- getVehicleDoorState
- getVehicleEngineState
- getVehicleHandling
- getVehicleHeadLightColor
- getVehicleLandingGearDown
- getVehicleLightState
- getVehicleMaxPassengers
- getVehicleModelFromName
- getVehicleName
- getVehicleNameFromModel
- getVehicleOccupant
- getVehicleOccupants
- getVehicleOverrideLights
- getVehiclePaintjob
- getVehiclePanelState
- getVehiclePlateText
- getVehicleSirenParams
- getVehicleSirens
- getVehicleSirensOn
- getVehicleTowedByVehicle
- getVehicleTowingVehicle
- getVehicleTurretPosition
- getVehicleType
- getVehicleUpgradeOnSlot
- getVehicleUpgradeSlotName
- getVehicleUpgrades
- getVehicleVariant
- getVehicleWheelStates
- isTrainDerailable
- isTrainDerailed
- isVehicleBlown
- isVehicleDamageProof
- isVehicleFuelTankExplodable
- isVehicleLocked
- isVehicleOnGround
- isVehicleTaxiLightOn
- removeVehicleUpgrade
- setTrainDerailable
- setTrainDerailed
- setTrainDirection
- setTrainPosition
- setTrainSpeed
- setTrainTrack
- setVehicleColor
- setVehicleDamageProof
- setVehicleDoorOpenRatio
- setVehicleDoorState
- setVehicleDoorsUndamageable
- setVehicleEngineState
- setVehicleFuelTankExplodable
- setVehicleHandling
- setVehicleHeadLightColor
- setVehicleLandingGearDown
- setVehicleLightState
- setVehicleLocked
- setVehicleOverrideLights
- setVehiclePaintjob
- setVehiclePanelState
- setVehiclePlateText
- setVehicleSirens
- setVehicleSirensOn
- setVehicleTaxiLightOn
- setVehicleTurretPosition
- setVehicleVariant
- setVehicleWheelStates