Skip to content
On this page

Athena.player.appearance

Type Aliases

BaseStyle

Ƭ BaseStyle: Object

Type declaration

NameType
colornumber
opacitynumber
stylenumber

Defined in

server/player/appearance.ts:7


Decorator

Ƭ Decorator: Object

Type declaration

NameType
collectionstring
overlaystring

Defined in

server/player/appearance.ts:5


HairStyle

Ƭ HairStyle: Object

Type declaration

NameType
color1number
color2number
decoratorDecorator
dlc?string | number
hairnumber

Defined in

server/player/appearance.ts:6

Functions

clearSkin

Usage

Athena.player.appearance.clearSkin(player): Promise<void>

Clear player custom model.

Export

Parameters

NameType
playerPlayer

Returns

Promise<void>

Defined in

server/player/appearance.ts:142


override

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"setHairStyle"
callback(player: Player, style: HairStyle) => any

Returns

any

Defined in

server/player/appearance.ts:254

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"setFacialHair"
callback(player: Player, choice: BaseStyle) => any

Returns

any

Defined in

server/player/appearance.ts:255

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"setHeadBlendData"
callback(player: Player, faceData: { faceFather: number ; faceMix: number ; faceMother: number ; skinFather: number ; skinMix: number ; skinMother: number }) => any

Returns

any

Defined in

server/player/appearance.ts:256

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"setEyebrows"
callback(player: Player, choice: BaseStyle) => any

Returns

any

Defined in

server/player/appearance.ts:257

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"setModel"
callback(player: Player, isFeminine: boolean) => any

Returns

any

Defined in

server/player/appearance.ts:258

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"setEyeColor"
callback(player: Player, color: number) => any

Returns

any

Defined in

server/player/appearance.ts:259

Usage

Athena.player.appearance.override(functionName, callback): any

Used to override any appearance setter functions.

Parameters

NameType
functionName"updateTattoos"
callback(player: Player, decorators?: Decorator[]) => any

Returns

any

Defined in

server/player/appearance.ts:260


setEyeColor

Usage

Athena.player.appearance.setEyeColor(player, color): any

Set an eye color on a player.

Automatically saves to database.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity
colornumber

Returns

any

Defined in

server/player/appearance.ts:156


setEyebrows

Usage

Athena.player.appearance.setEyebrows(player, choice): any

Update eyebrow style for a player.

Automatically saves to the database.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity
choiceBaseStyle

Returns

any

Defined in

server/player/appearance.ts:84


setFacialHair

Usage

Athena.player.appearance.setFacialHair(player, choice): any

Apply facial hair style to a player.

Automatically saves to database.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity
choiceBaseStyle-

Returns

any

Defined in

server/player/appearance.ts:57


setHairStyle

Usage

Athena.player.appearance.setHairStyle(player, style): any

Set a player's hairstyle.

Automatically saves it to Database.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity
styleHairStyle

Returns

any

Defined in

server/player/appearance.ts:19


setHeadBlendData

Usage

Athena.player.appearance.setHeadBlendData(player, faceData): any

Change the player's face

Export

Parameters

NameType
playerPlayer
faceDataObject
faceData.faceFathernumber
faceData.faceMixnumber
faceData.faceMothernumber
faceData.skinFathernumber
faceData.skinMixnumber
faceData.skinMothernumber

Returns

any

Defined in

server/player/appearance.ts:185


setModel

Usage

Athena.player.appearance.setModel(player, isFeminine): any

Change the base model of the player to either a masculine base, or feminine base.

Automatically saves to database.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity
isFeminineboolean

Returns

any

Defined in

server/player/appearance.ts:111


setSkin

Usage

Athena.player.appearance.setSkin(player, model): Promise<void>

Set player appearance to a skin / model / ped.

Export

Parameters

NameType
playerPlayer
modelstring | number

Returns

Promise<void>

Defined in

server/player/appearance.ts:132


updateTattoos

Usage

Athena.player.appearance.updateTattoos(player, decorators?): any

Used to update tattoos, and a hair overlay if present. Add the 'decorators' paramater to override player appearance.

Parameters

NameTypeDefault valueDescription
playerPlayerundefinedAn alt:V Player Entity
decorators?Decorator[]undefined

Returns

any

Defined in

server/player/appearance.ts:217

Created by Stuyk | Est. 2020