GetVehicleUpgradeSlotName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(13 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function returns the name of an upgrade slot name (eg: roof, spoiler).
{{Server client function}}
This function returns the name of an upgrade slot name (e.g. roof, spoiler).


==Syntax==
==Syntax==
There are two ways of using this function, the parameter can either be the slot id (0->16) or the upgrade id (1000->1193)
There are two ways of using this function, the parameter can either be the slot ID (0 to 16) or an upgrade ID (1000 to 1193)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehicleUpgradeSlotName ( slot )           
string getVehicleUpgradeSlotName ( int slot/upgrade )
</syntaxhighlight>
</syntaxhighlight>
 
<syntaxhighlight lang="lua">
string getVehicleUpgradeSlotName ( upgrade )            
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''vehicle:''' description
*'''slot/upgrade:''' the slot ID or corresponding upgrade ID of which you want the name.
*'''slot/vehicle:''' the slot or corresponding upgrade of which you want the name of.
{{Vehicle Upgrades}}


===Returns===
===Returns===
Returns the slot name if a valid slot or upgrade id was given, ''false'' otherwise.
Returns a ''string'' with the slot name if a valid slot or upgrade ID was given, ''false'' otherwise.


==Example==  
==Example==  
This example prints, the name and upgrades on each slot of an entered vehicle, to the chat.
<section name="Server" class="server" show="true">
addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
This example prints the name and upgrades on each slot of an entered vehicle to the chat.
function onPlayerEnterVehicle ( vehicle, seat, jacked )
<syntaxhighlight lang="lua">
  upgrades = getVehicleUpgrades ( vehicle )
function scriptOnPlayerEnterVehicle ( theVehicle, seat, jacked )
  for upgradeKey, upgradeValue in upgrades do
    local upgrades = getVehicleUpgrades ( theVehicle )
    outputChatBox ( getVehicleUpgradeSlotName ( upgradeKey - 1 ) .. ": " .. upgradeValue )
    for _, upgrade in ipairs ( upgrades ) do
  end
        outputChatBox ( getVehicleUpgradeSlotName ( upgrade ) .. ": " .. upgrade )
    end
end
end
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle_Functions}}
{{Vehicle_functions}}

Latest revision as of 08:34, 4 November 2020

This function returns the name of an upgrade slot name (e.g. roof, spoiler).

Syntax

There are two ways of using this function, the parameter can either be the slot ID (0 to 16) or an upgrade ID (1000 to 1193)

string getVehicleUpgradeSlotName ( int slot/upgrade )

Required Arguments

  • slot/upgrade: the slot ID or corresponding upgrade ID of which you want the name.
    • 0: Hood
    • 1: Vent
    • 2: Spoiler
    • 3: Sideskirt
    • 4: Front Bullbars
    • 5: Rear Bullbars
    • 6: Headlights
    • 7: Roof
    • 8: Nitro
    • 9: Hydraulics
    • 10: Stereo
    • 11: Unknown
    • 12: Wheels
    • 13: Exhaust
    • 14: Front Bumper
    • 15: Rear Bumper
    • 16: Misc

Returns

Returns a string with the slot name if a valid slot or upgrade ID was given, false otherwise.

Example

Click to collapse [-]
Server

This 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