--  LUA  GetPedHeadOverlayData

0xC46EE605

-- GET_PED_HEAD_OVERLAY_DATA
local retval --[[ boolean ]], overlayValue --[[ integer ]], colourType --[[ integer ]], firstColour --[[ integer ]], secondColour --[[ integer ]], overlayOpacity --[[ number ]] =
	GetPedHeadOverlayData(
		ped --[[ Ped ]], 
		index --[[ integer ]]
	)

Parameters:

    ped:

    The target ped
    index:

    Overlay index
    overlayValue:

    Overlay value pointer
    colourType:

    Colour type pointer
    firstColour:

    First colour pointer
    secondColour:

    Second colour pointer
    overlayOpacity:

    Opacity pointer

Returns:

Returns ped's head overlay data.

A getter for SET_PED_HEAD_OVERLAY and _SET_PED_HEAD_OVERLAY_COLOR natives.

Examples:

    Lua

-- 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
 
 

Parameters:

header:

sentence.

header:

sentence.

header:

sentence.

Returns:

sentence.

Summary

sentence.

Example

---  
    


Additional natives used in this example, or natives commonly used with this native.

NATIVE, NATIVE

Common Errors or Problems

Problem: sentence.

Problem: sentence.

Problem: sentence.

Credits and Disclaimers

The base of this data was taken from the redm/cfx fivem/rdr docs, and vespura. We have been saving and making notes for two years now, and are now adding them to our site for everyone to use. We will be modifying the notes as needed, and building tutorials around the data so these pages will change as we work on it. This is a manual process, not an automated one, so updates will occur as we have time, the priority is releasing resources. Thanks for your patience.

Was the documentation useful?

Related Examples and Posts