GetPedHeadOverlayData
Docslocal retval, overlayValue, colourType, firstColour, secondColour, overlayOpacity = GetPedHeadOverlayData(ped, index)Description
A getter for SET_PED_HEAD_OVERLAY and \_SET_PED_HEAD_OVERLAY_COLOR natives.
Parameters
| Name | Type | Description |
|---|---|---|
ped | Ped | The target ped |
index | int | Overlay index |
overlayValue | int* | Overlay value pointer |
colourType | int* | Colour type pointer |
firstColour | int* | First colour pointer |
secondColour | int* | Second colour pointer |
overlayOpacity | float* | Opacity pointer |
Quick Snippet: Get Ped Handleped
pedUse this to get the player ped handle for this native.
-- Get the player's ped handle (client-side)
local ped = PlayerPedId()
print("Ped handle: " .. ped)
-- For a specific player's ped (server-side):
-- local targetPed = GetPlayerPed(source)Ped Models
mp_m_freemode_01
player_zero
ig_agatha
s_m_y_cop_01
s_m_m_gaffer_01
g_m_m_armboss_01
a_c_boar
a_m_m_bevhills_01Returns
BOOLReturns TRUE (1) or FALSE (0).
Examples
Official
-- getting beard overlay data
local success, overlayValue, colourType, firstColour, secondColour, overlayOpacity = GetPedHeadOverlayData(PlayerPedId(), 1)
if success then
-- incrementing value
SetPedHeadOverlay(PlayerPedId(), 1, overlayValue + 1, overlayOpacity)
end