GetVehicleUpgradeOnSlot: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (normalize page to match others)
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function returns the current upgrade id on the specified vehicle's 'upgrade slot'
This function returns the current upgrade id on the specified vehicle's 'upgrade slot'
An upgrade slot is a certain type of upgrade (eg: exhaust, spoiler), there are 17 slots (0->16).
An upgrade slot is a certain type of upgrade (eg: exhaust, spoiler), there are 17 slots (0 to 16).


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">getVehicleUpgradeOnSlot ( vehicle, slot )</syntaxhighlight>
<syntaxhighlight lang="lua">int getVehicleUpgradeOnSlot ( vehicle theVehicle, int slot )</syntaxhighlight>
{{OOP||[[vehicle]]:getUpgradeOnSlot}}
===Returns===
Returns an ''integer'' with the upgrade on the slot if correct arguments were passed, ''false'' otherwise.


===Required Arguments===
===Required Arguments===
*'''vehicle''': The [[vehicle]] whose upgrade you want to retrieve.
*'''theVehicle''': The [[vehicle]] whose upgrade you want to retrieve.
*'''slot''': The slot id of the upgrade.
*'''slot''': The slot id of the upgrade. ''([[Upgrade list]] ordered by slot number)''


==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">
newcar = createVehicle ( 520, 1024, 1024, 1024 )
function scriptOnPlayerEnterVehicle ( theVehicle, seat, jacked )
  outputChatBox ( "Upgrade on slot 0: " .. getVehicleUpgradeOnSlot ( newcar, 0 ) )
    for i=0, 16 do
end</syntaxhighlight>
        local upgrade = getVehicleUpgradeOnSlot ( theVehicle, i )
        if ( upgrade ) then
            outputChatBox ( getVehicleUpgradeSlotName ( i ) .. ": " .. upgrade)
        end
    end
end
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Latest revision as of 08:04, 5 August 2021

This function returns the current upgrade id on the specified vehicle's 'upgrade slot' An upgrade slot is a certain type of upgrade (eg: exhaust, spoiler), there are 17 slots (0 to 16).

Syntax

int getVehicleUpgradeOnSlot ( vehicle theVehicle, int slot )

OOP Syntax Help! I don't understand this!

Method: vehicle:getUpgradeOnSlot(...)


Returns

Returns an integer with the upgrade on the slot if correct arguments were passed, false otherwise.

Required Arguments

  • theVehicle: The vehicle whose upgrade you want to retrieve.
  • slot: The slot id of the upgrade. (Upgrade list ordered by slot number)

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 )
    for i=0, 16 do
        local upgrade = getVehicleUpgradeOnSlot ( theVehicle, i )
        if ( upgrade ) then
            outputChatBox ( getVehicleUpgradeSlotName ( i ) .. ": " .. upgrade)
        end
    end
end
addEventHandler ( "onPlayerVehicleEnter", root, scriptOnPlayerEnterVehicle )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleUpgradeOnSlot?oldid=71540"