Weapon components in FiveM: suppressors, scopes, grips and magazines

#How components are named

Component names follow a loose pattern that tells you what they are and roughly what they fit:

#The natives

local ped = PlayerPedId()
local weapon = `WEAPON_PISTOL`
local supp = `COMPONENT_AT_PI_SUPP_02`

if DoesWeaponTakeWeaponComponent(weapon, supp) then
    GiveWeaponComponentToPed(ped, weapon, supp)
end

-- Is it attached?
print(HasPedGotWeaponComponent(ped, weapon, supp))

-- Remove it again
RemoveWeaponComponentFromPed(ped, weapon, supp)

• DoesWeaponTakeWeaponComponent(weaponHash, componentHash) — is the part compatible?
• GiveWeaponComponentToPed(ped, weaponHash, componentHash) — attach it.
• HasPedGotWeaponComponent(ped, weaponHash, componentHash) — is it attached?
• RemoveWeaponComponentFromPed(ped, weaponHash, componentHash) — detach it.

The ped must already have the weapon. Attaching a component to a weapon the ped does not hold does nothing.

#Components as items in ox_inventory

ox_inventory turns components into items. Its default data defines attachment items (such as flashlights, suppressors, grips, scopes and extended clips) and lists, for each, the component hashes it can apply. When a player uses the item on a compatible weapon, the inventory attaches the right component and stores it in the weapon’s metadata, so it survives relogging and dropping the weapon.

The item definitions live in ox_inventory/data/weapons.lua under Components; the full walkthrough, including adding your own attachment items, is in ox_inventory weapon attachments.

#Finishes, tints and camos

Colour is handled two ways. Tints are a simple index per weapon set with SetPedWeaponTintIndex — see weapon tints. Finishes such as the luxury variants are components (_VARMOD_), and Mk II weapons carry camo liveries as components too, covered in Mk II camos and liveries.

#Components on addon weapons

Addon weapons declare their own components in weaponcomponents.meta and list which ones they accept in their weapons.meta. If an attachment item does nothing on an addon gun, the addon simply does not list that component. Skinned copies of vanilla guns usually keep the vanilla component list, so vanilla attachments work on them.