NATIVE ATLASA field guide for builders
RED DEAD REDEMPTION II
Connect your AI
From the reference libraryRedM

autodoc_g_shared_functions

jo_libs/modules/component/autodoc/autodoc_g_shared_functions.md

autodoc_g_shared_functions

JO Functions > jo.component.formatComponentData()

<br> <br> <br> <br> A function to format component data <br>

JO Functions > jo.component.formatComponentData() > Syntax

jo.component.formatComponentData(_data, hashData)

JO Functions > jo.component.formatComponentData() > Parameters

_data : string|number|table

The component data

hashData : boolean

Hash the value is true

JO Functions > jo.component.formatComponentData() > Return Value

Type : any

JO Functions > jo.component.formatComponentData() > Example

local hash = "CLOTHING_ITEM_F_HAT_241_PANTHER_VAR_001"
local formattedData = jo.component.formatComponentData(hash)
log(formattedData)
--expected output: {hash = "CLOTHING_ITEM_F_HAT_241_PANTHER_VAR_001"}

JO Functions > jo.component.getBodiesLowerFromSkinTone()

A function to get the lower body component hash from bodies index and skin tone <br>

JO Functions > jo.component.getBodiesLowerFromSkinTone() > Syntax

jo.component.getBodiesLowerFromSkinTone(ped, bodiesIndex, skinTone)

JO Functions > jo.component.getBodiesLowerFromSkinTone() > Parameters

ped : integer|string

The entity ID or model name

bodiesIndex : integer <BadgeOptional />

The bodies index, defaults to 1

skinTone : integer <BadgeOptional />

The skin tone, defaults to 1

JO Functions > jo.component.getBodiesLowerFromSkinTone() > Return Value

Type : string

The lower body component hash string

JO Functions > jo.component.getBodiesUpperFromSkinTone()

A function to get the upper body component hash from bodies index and skin tone <br>

JO Functions > jo.component.getBodiesUpperFromSkinTone() > Syntax

jo.component.getBodiesUpperFromSkinTone(ped, bodiesIndex, skinTone)

JO Functions > jo.component.getBodiesUpperFromSkinTone() > Parameters

ped : integer|string

The entity ID or model name

bodiesIndex : integer <BadgeOptional />

The bodies index, defaults to 1

skinTone : integer <BadgeOptional />

The skin tone, defaults to 1

JO Functions > jo.component.getBodiesUpperFromSkinTone() > Return Value

Type : string

The upper body component hash string

JO Functions > jo.component.getCategoryHash()

A fonction to get the category hash from its string <br>

JO Functions > jo.component.getCategoryHash() > Syntax

jo.component.getCategoryHash(category)

JO Functions > jo.component.getCategoryHash() > Parameters

category : string|integer

The category string

JO Functions > jo.component.getCategoryHash() > Return Value

Type : integer

The category hash

JO Functions > jo.component.getCategoryHash() > Example

local category = "hats"
local hash = jo.component.getCategoryHash(category)
print(hash)
-- Expected output: -1725579161

JO Functions > jo.component.getEyesFromIndex()

A function to get the eyes component hash from an index <br>

JO Functions > jo.component.getEyesFromIndex() > Syntax

jo.component.getEyesFromIndex(ped, index)

JO Functions > jo.component.getEyesFromIndex() > Parameters

ped : integer|string

The entity ID or model name

index : integer <BadgeOptional />

The eyes index, defaults to 1

JO Functions > jo.component.getEyesFromIndex() > Return Value

Type : string

The eyes component hash string

JO Functions > jo.component.getFullHorseComponentList()

A function to get the list of horse's components sorted by category <br>

JO Functions > jo.component.getFullHorseComponentList() > Syntax

jo.component.getFullHorseComponentList()

JO Functions > jo.component.getFullHorseComponentList() > Return Value

Type : table

JO Functions > jo.component.getFullHorseComponentList() > Example

local horseComponents = jo.component.getFullHorseComponentList()
for category,datas in pairs (horseComponents) do
  print(category, table.count(datas))
end

JO Functions > jo.component.getFullPedComponentList()

<br> <br> <br> <br> <br> <br> A function to get the list of clothes sorted by sex and category <br>

JO Functions > jo.component.getFullPedComponentList() > Syntax

jo.component.getFullPedComponentList()

JO Functions > jo.component.getFullPedComponentList() > Return Value

Type : table

JO Functions > jo.component.getFullPedComponentList() > Example

local pedComponents = jo.component.getFullPedComponentList()
for category,datas in pairs (pedComponents) do
  print(category, table.count(datas))
end

JO Functions > jo.component.getFullShopItemTintsList()

A function to get the list of tints <br>

JO Functions > jo.component.getFullShopItemTintsList() > Syntax

jo.component.getFullShopItemTintsList()

JO Functions > jo.component.getFullShopItemTintsList() > Return Value

Type : table

JO Functions > jo.component.getHeadFromSkinTone()

A function to get the head component hash from head index and skin tone <br>

JO Functions > jo.component.getHeadFromSkinTone() > Syntax

jo.component.getHeadFromSkinTone(ped, headIndex, skinTone)

JO Functions > jo.component.getHeadFromSkinTone() > Parameters

ped : integer

The entity ID

headIndex : integer <BadgeOptional />

The head index, defaults to 1

skinTone : integer <BadgeOptional />

The skin tone, defaults to 1

JO Functions > jo.component.getHeadFromSkinTone() > Return Value

Type : string

The head component hash string

JO Functions > jo.component.getShopItemTint()

A function to get the tint of a shop itemSet <br>

JO Functions > jo.component.getShopItemTint() > Syntax

jo.component.getShopItemTint(shopItem)

JO Functions > jo.component.getShopItemTint() > Parameters

shopItem : integer|string <BadgeOptional />

The shop item name

JO Functions > jo.component.getShopItemTint() > Return Value

Type : table

JO Functions > jo.component.getTeethFromIndex()

A function to get the teeth component hash from an index <br>

JO Functions > jo.component.getTeethFromIndex() > Syntax

jo.component.getTeethFromIndex(ped, index)

JO Functions > jo.component.getTeethFromIndex() > Parameters

ped : integer|string

The entity ID or model name

index : integer <BadgeOptional />

The teeth index, defaults to 1

JO Functions > jo.component.getTeethFromIndex() > Return Value

Type : string

The teeth component hash string

JO Functions > jo.component.isCategoryAClothes() > Syntax

jo.component.isCategoryAClothes(category)

JO Functions > jo.component.formatComponentData()

A function to format component data <br>

JO Functions > jo.component.getFullPedComponentList()

A function to get the list of clothes sorted by sex and category <br>

Back to documentation