Class Player

Base class for all entities in the framework. Still wondering if this should be an abstract class. May change in the future.

Hierarchy (view full)

Constructors

constructor

Properties

entityId modelHash modelName

Methods

asJSON asString clone compare delete equals freeze getAccuracy getAlpha getClosestEntityOfType getConfigFlag getCurrentDrawableVariation getCurrentPropDrawableVariation getCurrentPropTextureVariation getCurrentTextureVariation getData getDimensions getEntity getEntityType getExists getGang getGangIndex getGangs getHairColor getHairHightlightColor getHash getHeading getInventory getIsInCdImage getIsLoaded getIsMissionEntity getIsModelValid getJob getJobIndex getJobs getMaxComponents getMaxFaceFeatures getMaxHealth getMaxOverlays getMaxProps getMaxValues getModel getName getNetworkId getPed getPedComponents getPedFaceFeature getPedFaceFeatures getPedGender getPedHeadBlendData getPedHeadBlendHeads getPedHeadBlendsHeadsByGender getPedHeadOverlay getPedHeadOverlayColorType getPedHeadOverlays getPedProps getPosition getRotation getSize getSource getUuid getVelocity getVisible hasGang hash hasJob isFrozen load refreshPedHeadBlendData resurrect setAccuracy setAlpha setConfigFlag setCurrentDrawableVariation setEntity setHairColor setHeading setIsMissionEntity setModel setPedData setPedFaceFeature setPedHeadBlendData setPedHeadOverlay setPedHeadOverlayColor setPlayerModel setPosition setPropDrawableVariation setRotation setSource setVelocity setVisible toNet toObject unload create fromNet getInstance onPlayerReady onPlayerReadySync playerPed setInstance

Constructors

constructor

Properties

ProtectedentityId

entityId: number

ProtectedmodelHash

modelHash: number

ProtectedmodelName

modelName: Optional<string>

Methods

asJSON

  • asJSON(): string

  • Returns string

    A JSON string representation of the object.

asString

clone

  • clone(): this

  • Clones the object.

    Returns this

compare

  • compare(other): -1 | 0 | 1

  • Parameters

    • other: this

    Returns -1 | 0 | 1

    -1 if this is less than other, 0 if they are equal, 1 if this is greater than other.

delete

equals

  • equals(other): boolean

  • Checks if the object is equal to another object.

    Parameters

    • other: CEntity

      The object to compare to.

    Returns boolean

    true if the objects are equal, false otherwise.

freeze

getAccuracy

getAlpha

getClosestEntityOfType

getConfigFlag

getCurrentDrawableVariation

getCurrentPropDrawableVariation

getCurrentPropTextureVariation

getCurrentTextureVariation

getData

getDimensions

getEntity

getEntityType

getExists

getGang

getGangIndex

getGangs

getHairColor

getHairHightlightColor

getHash

getHeading

getInventory

getIsInCdImage

getIsLoaded

getIsMissionEntity

getIsModelValid

getJob

getJobIndex

getJobs

getMaxComponents

  • getMaxComponents(): Record<
        | "COMP_HEAD"
        | "COMP_BERD"
        | "COMP_HAIR"
        | "COMP_UPPR"
        | "COMP_LOWR"
        | "COMP_HAND"
        | "COMP_FEET"
        | "COMP_TEEF"
        | "COMP_ACCS"
        | "COMP_TASK"
        | "COMP_DECL"
        | "COMP_JBIB", Record<number, number>>

  • Returns Record<
        | "COMP_HEAD"
        | "COMP_BERD"
        | "COMP_HAIR"
        | "COMP_UPPR"
        | "COMP_LOWR"
        | "COMP_HAND"
        | "COMP_FEET"
        | "COMP_TEEF"
        | "COMP_ACCS"
        | "COMP_TASK"
        | "COMP_DECL"
        | "COMP_JBIB", Record<number, number>>

getMaxFaceFeatures

  • getMaxFaceFeatures(): Record<
        | "NOSE_WIDTH"
        | "NOSE_PEAK"
        | "NOSE_LENGTH"
        | "NOSE_BONE_CURVE"
        | "NOSE_TIP"
        | "NOSE_BONE_TWIST"
        | "EYEBROW_HEIGHT"
        | "EYEBROW_DEPTH"
        | "CHEEK_HEIGHT"
        | "CHEEK_DEPTH"
        | "CHEEK_WIDTH"
        | "EYE_OPENING"
        | "LIP_THICKNESS"
        | "JAW_WIDTH"
        | "JAW_ROUNDNESS"
        | "CHIN_HEIGHT"
        | "CHIN_LENGTH"
        | "CHIN_ROUNDNESS"
        | "CHIN_HOLE"
        | "NECK_THICKNESS", {
        max: number;
        min: number;
    }>

  • Returns Record<
        | "NOSE_WIDTH"
        | "NOSE_PEAK"
        | "NOSE_LENGTH"
        | "NOSE_BONE_CURVE"
        | "NOSE_TIP"
        | "NOSE_BONE_TWIST"
        | "EYEBROW_HEIGHT"
        | "EYEBROW_DEPTH"
        | "CHEEK_HEIGHT"
        | "CHEEK_DEPTH"
        | "CHEEK_WIDTH"
        | "EYE_OPENING"
        | "LIP_THICKNESS"
        | "JAW_WIDTH"
        | "JAW_ROUNDNESS"
        | "CHIN_HEIGHT"
        | "CHIN_LENGTH"
        | "CHIN_ROUNDNESS"
        | "CHIN_HOLE"
        | "NECK_THICKNESS", {
        max: number;
        min: number;
    }>

getMaxHealth

getMaxOverlays

  • getMaxOverlays(): Record<
        | "BLEMISHES"
        | "FACIAL_HAIR"
        | "EYEBROWS"
        | "AGEING"
        | "MAKEUP"
        | "BLUSH"
        | "COMPLEXION"
        | "SUN_DAMAGE"
        | "LIPSTICK"
        | "MOLES"
        | "CHEST_HAIR"
        | "BODY_BLEMISHES"
        | "ADD_BODY_BLEMISHES", number>

  • Returns Record<
        | "BLEMISHES"
        | "FACIAL_HAIR"
        | "EYEBROWS"
        | "AGEING"
        | "MAKEUP"
        | "BLUSH"
        | "COMPLEXION"
        | "SUN_DAMAGE"
        | "LIPSTICK"
        | "MOLES"
        | "CHEST_HAIR"
        | "BODY_BLEMISHES"
        | "ADD_BODY_BLEMISHES", number>

getMaxProps

  • getMaxProps(): Record<
        | "ANCHOR_HEAD"
        | "ANCHOR_EYES"
        | "ANCHOR_EARS"
        | "ANCHOR_MOUTH"
        | "ANCHOR_LEFT_HAND"
        | "ANCHOR_RIGHT_HAND"
        | "ANCHOR_LEFT_WRIST"
        | "ANCHOR_RIGHT_WRIST"
        | "ANCHOR_HIP"
        | "ANCHOR_LEFT_FOOT"
        | "ANCHOR_RIGHT_FOOT"
        | "ANCHOR_PH_L_HAND"
        | "ANCHOR_PH_R_HAND", Record<number, number>>

  • Returns Record<
        | "ANCHOR_HEAD"
        | "ANCHOR_EYES"
        | "ANCHOR_EARS"
        | "ANCHOR_MOUTH"
        | "ANCHOR_LEFT_HAND"
        | "ANCHOR_RIGHT_HAND"
        | "ANCHOR_LEFT_WRIST"
        | "ANCHOR_RIGHT_WRIST"
        | "ANCHOR_HIP"
        | "ANCHOR_LEFT_FOOT"
        | "ANCHOR_RIGHT_FOOT"
        | "ANCHOR_PH_L_HAND"
        | "ANCHOR_PH_R_HAND", Record<number, number>>

getMaxValues

getModel

getName

getNetworkId

getPed

getPedComponents

  • getPedComponents(): Record<
        | "COMP_HEAD"
        | "COMP_BERD"
        | "COMP_HAIR"
        | "COMP_UPPR"
        | "COMP_LOWR"
        | "COMP_HAND"
        | "COMP_FEET"
        | "COMP_TEEF"
        | "COMP_ACCS"
        | "COMP_TASK"
        | "COMP_DECL"
        | "COMP_JBIB", {
        drawable: number;
        texture: number;
    }>

  • Returns Record<
        | "COMP_HEAD"
        | "COMP_BERD"
        | "COMP_HAIR"
        | "COMP_UPPR"
        | "COMP_LOWR"
        | "COMP_HAND"
        | "COMP_FEET"
        | "COMP_TEEF"
        | "COMP_ACCS"
        | "COMP_TASK"
        | "COMP_DECL"
        | "COMP_JBIB", {
        drawable: number;
        texture: number;
    }>

getPedFaceFeature

getPedFaceFeatures

  • getPedFaceFeatures(): Record<
        | "NOSE_WIDTH"
        | "NOSE_PEAK"
        | "NOSE_LENGTH"
        | "NOSE_BONE_CURVE"
        | "NOSE_TIP"
        | "NOSE_BONE_TWIST"
        | "EYEBROW_HEIGHT"
        | "EYEBROW_DEPTH"
        | "CHEEK_HEIGHT"
        | "CHEEK_DEPTH"
        | "CHEEK_WIDTH"
        | "EYE_OPENING"
        | "LIP_THICKNESS"
        | "JAW_WIDTH"
        | "JAW_ROUNDNESS"
        | "CHIN_HEIGHT"
        | "CHIN_LENGTH"
        | "CHIN_ROUNDNESS"
        | "CHIN_HOLE"
        | "NECK_THICKNESS", number>

  • Returns Record<
        | "NOSE_WIDTH"
        | "NOSE_PEAK"
        | "NOSE_LENGTH"
        | "NOSE_BONE_CURVE"
        | "NOSE_TIP"
        | "NOSE_BONE_TWIST"
        | "EYEBROW_HEIGHT"
        | "EYEBROW_DEPTH"
        | "CHEEK_HEIGHT"
        | "CHEEK_DEPTH"
        | "CHEEK_WIDTH"
        | "EYE_OPENING"
        | "LIP_THICKNESS"
        | "JAW_WIDTH"
        | "JAW_ROUNDNESS"
        | "CHIN_HEIGHT"
        | "CHIN_LENGTH"
        | "CHIN_ROUNDNESS"
        | "CHIN_HOLE"
        | "NECK_THICKNESS", number>

getPedGender

getPedHeadBlendData

getPedHeadBlendHeads

getPedHeadBlendsHeadsByGender

getPedHeadOverlay

getPedHeadOverlayColorType

getPedHeadOverlays

  • getPedHeadOverlays(): Record<
        | "BLEMISHES"
        | "FACIAL_HAIR"
        | "EYEBROWS"
        | "AGEING"
        | "MAKEUP"
        | "BLUSH"
        | "COMPLEXION"
        | "SUN_DAMAGE"
        | "LIPSTICK"
        | "MOLES"
        | "CHEST_HAIR"
        | "BODY_BLEMISHES"
        | "ADD_BODY_BLEMISHES", PedHeadOverlayData>

  • Returns Record<
        | "BLEMISHES"
        | "FACIAL_HAIR"
        | "EYEBROWS"
        | "AGEING"
        | "MAKEUP"
        | "BLUSH"
        | "COMPLEXION"
        | "SUN_DAMAGE"
        | "LIPSTICK"
        | "MOLES"
        | "CHEST_HAIR"
        | "BODY_BLEMISHES"
        | "ADD_BODY_BLEMISHES", PedHeadOverlayData>

getPedProps

  • getPedProps(): Record<
        | "ANCHOR_HEAD"
        | "ANCHOR_EYES"
        | "ANCHOR_EARS"
        | "ANCHOR_MOUTH"
        | "ANCHOR_LEFT_HAND"
        | "ANCHOR_RIGHT_HAND"
        | "ANCHOR_LEFT_WRIST"
        | "ANCHOR_RIGHT_WRIST"
        | "ANCHOR_HIP"
        | "ANCHOR_LEFT_FOOT"
        | "ANCHOR_RIGHT_FOOT"
        | "ANCHOR_PH_L_HAND"
        | "ANCHOR_PH_R_HAND", {
        drawable: number;
        texture: number;
    }>

  • Returns Record<
        | "ANCHOR_HEAD"
        | "ANCHOR_EYES"
        | "ANCHOR_EARS"
        | "ANCHOR_MOUTH"
        | "ANCHOR_LEFT_HAND"
        | "ANCHOR_RIGHT_HAND"
        | "ANCHOR_LEFT_WRIST"
        | "ANCHOR_RIGHT_WRIST"
        | "ANCHOR_HIP"
        | "ANCHOR_LEFT_FOOT"
        | "ANCHOR_RIGHT_FOOT"
        | "ANCHOR_PH_L_HAND"
        | "ANCHOR_PH_R_HAND", {
        drawable: number;
        texture: number;
    }>

getPosition

getRotation

getSize

  • getSize(): Vector3

  • Gets the size of the model

    Returns Vector3

    A vector3 representing the size of the model in the x, y, and z dimensions

getSource

getUuid

getVelocity

getVisible

hasGang

hash

hasJob

isFrozen

load

refreshPedHeadBlendData

resurrect

setAccuracy

setAlpha

setConfigFlag

setCurrentDrawableVariation

ProtectedsetEntity

setHairColor

setHeading

setIsMissionEntity

ProtectedsetModel

setPedData

  • setPedData(data): void

  • Sets the ped data from a PedData object. Does not set the ped model to the one from PedData.pedModel, it assumes the ped given to the constructor already has that model.

    Parameters

    Returns void

setPedFaceFeature

setPedHeadBlendData

setPedHeadOverlay

setPedHeadOverlayColor

setPlayerModel

setPosition

setPropDrawableVariation

setRotation

setSource

setVelocity

setVisible

toNet

toObject

unload

Staticcreate

StaticfromNet

StaticgetInstance

StaticonPlayerReady

  • onPlayerReady(cb): void
  • No Self

    Parameters

    • cb: ((player: Player) => void)
        • (player): void

        • Parameters

          Returns void

    Returns void

StaticonPlayerReadySync

StaticplayerPed

StaticsetInstance

  • setInstance(instance): void
  • No Self

    Static method called by the server to set the instance of the player with the initial player data Never call this function manually

    Parameters

    • instance: Player

      Instance of the player

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
asJSONasStringclonecomparedeleteequalsfreezegetAccuracygetAlphagetClosestEntityOfTypegetConfigFlaggetCurrentDrawableVariationgetCurrentPropDrawableVariationgetCurrentPropTextureVariationgetCurrentTextureVariationgetDatagetDimensionsgetEntitygetEntityTypegetExistsgetGanggetGangIndexgetGangsgetHairColorgetHairHightlightColorgetHashgetHeadinggetInventorygetIsInCdImagegetIsLoadedgetIsMissionEntitygetIsModelValidgetJobgetJobIndexgetJobsgetMaxComponentsgetMaxFaceFeaturesgetMaxHealthgetMaxOverlaysgetMaxPropsgetMaxValuesgetModelgetNamegetNetworkIdgetPedgetPedComponentsgetPedFaceFeaturegetPedFaceFeaturesgetPedGendergetPedHeadBlendDatagetPedHeadBlendHeadsgetPedHeadBlendsHeadsByGendergetPedHeadOverlaygetPedHeadOverlayColorTypegetPedHeadOverlaysgetPedPropsgetPositiongetRotationgetSizegetSourcegetUuidgetVelocitygetVisiblehasGanghashhasJobisFrozenloadrefreshPedHeadBlendDataresurrectsetAccuracysetAlphasetConfigFlagsetCurrentDrawableVariationsetEntitysetHairColorsetHeadingsetIsMissionEntitysetModelsetPedDatasetPedFaceFeaturesetPedHeadBlendDatasetPedHeadOverlaysetPedHeadOverlayColorsetPlayerModelsetPositionsetPropDrawableVariationsetRotationsetSourcesetVelocitysetVisibletoNettoObjectunloadcreatefromNetgetInstanceonPlayerReadyonPlayerReadySyncplayerPedsetInstance