Class AvatarState

Hierarchy

Pseudo
- AvatarState

Index

Constructors

constructor

Constructors

constructor

new AvatarState(
    Player: Model | Player,
    FromDescription?:
        | number
        | boolean
        | AvatarStateSaveData
        | HumanoidDescription,
): AvatarState
Parameters
- Player: Model | Player
- OptionalFromDescription: number | boolean | AvatarStateSaveData | HumanoidDescription
Returns AvatarState
Overrides Pseudo.constructor
- Defined in index.ts:837

Properties

`Readonly`Accessories

Accessories: string = ""

AccessoryAdded

AccessoryAdded: Signal<(AccessoryKey: string, AccessoryId: number) => void>

AccessoryRemoved

AccessoryRemoved: Signal<(AccessoryKey: string, AccessoryId: number) => void>

AnimationBundle

AnimationBundle: number = -1

AutoApplyOnReset

AutoApplyOnReset: boolean = true

BodyTypeScale

BodyTypeScale: number = 0

CharacterBundle

CharacterBundle: number = -1

ClimbAnimation

ClimbAnimation: number = 0

DepthScale

DepthScale: number = 0

DynamicHead

DynamicHead: number = 0

EmotesChanged

EmotesChanged: Signal<(newEmotes: { [key: string]: number }) => void>

The actual roblox signal

EquippedEmotesChanged

EquippedEmotesChanged: Signal<
(newEquippedEmotes: { [key: string]: number }) => void,
>

The actual roblox signal

Face

Face: number = 0

FallAnimation

FallAnimation: number = 0

GraphicTShirt

GraphicTShirt: number = 0

Head

Head: number = 0

HeadColor

HeadColor: Color3 = ...

HeadScale

HeadScale: number = 0

HeightScale

HeightScale: number = 0

IdleAnimation

IdleAnimation: number = 0

includeRigidAccessories

includeRigidAccessories: boolean = true

JumpAnimation

JumpAnimation: number = 0

LeftArm

LeftArm: number = 0

LeftArmColor

LeftArmColor: Color3 = ...

LeftLeg

LeftLeg: number = 0

LeftLegColor

LeftLegColor: Color3 = ...

MaximumAccessoryBehavior

MaximumAccessoryBehavior: MaximumAccessoryBehavior = MaximumAccessoryBehavior.Shift

MaximumAccessoryBehaviors

MaximumAccessoryBehaviors: typeof MaximumAccessoryBehavior = MaximumAccessoryBehavior

Pop - removes from back. Shift - removes from front.

MoodAnimation

MoodAnimation: number = 0

Pants

Pants: number = 0

Player

Player: Model | Player

ProportionScale

ProportionScale: number = 0

Resetted

Resetted: Signal<() => void>

RightArm

RightArm: number = 0

RightArmColor

RightArmColor: Color3 = ...

RightLeg

RightLeg: number = 0

RightLegColor

RightLegColor: Color3 = ...

RunAnimation

RunAnimation: number = 0

Shirt

Shirt: number = 0

SwimAnimation

SwimAnimation: number = 0

Torso

Torso: number = 0

TorsoColor

TorsoColor: Color3 = ...

WalkAnimation

WalkAnimation: number = 0

WidthScale

WidthScale: number = 0

Methods

AddAccessory

AddAccessory(AccessoryKey: string, AddAccessoryInfo: AddAccessoryInfo): void
To have the accessory actually applied, make sure to call _FilterMaximumAccessoriesForAllTypes and _applyDescription.
Parameters
- AccessoryKey: string
- AddAccessoryInfo: AddAccessoryInfo
Returns void
- Defined in index.ts:559

AddEmote

AddEmote(...args: [name: string, assetId: number]): void
Parameters
- ...args: [name: string, assetId: number]
Returns void
- Defined in index.ts:494

Apply

Apply(UniqueKey: string, AssetId: number): Promise<void>
Will resolve the type of item based on the AssetId provided.
Parameters
- UniqueKey: string
- AssetId: number
Returns Promise<void>
- Defined in index.ts:429

ApplyDescription

ApplyDescription(): void
Returns void
- Defined in index.ts:232

GenerateSaveData

GenerateSaveData(): AvatarStateSaveData
Returns AvatarStateSaveData
- Defined in index.ts:769

GetAccessory

GetAccessory(AccessoryKeyOrId: string | number): number
Parameters
- AccessoryKeyOrId: string | number
Returns number
- Defined in index.ts:534

GetApplyMethod

GetApplyMethod(
    AssetId: number,
): Promise<
    | undefined
    | {
        assetAccessoryType?: AccessoryType;
        assetType: AssetType;
        avatarStateProperty?: | "HeadColor"
        | "LeftArmColor"
        | "LeftLegColor"
        | "RightArmColor"
        | "RightLegColor"
        | "TorsoColor"
        | "BodyTypeScale"
        | "ClimbAnimation"
        | "DepthScale"
        | "Face"
        | "FallAnimation"
        | "GraphicTShirt"
        | "Head"
        | "HeadScale"
        | "HeightScale"
        | "IdleAnimation"
        | "JumpAnimation"
        | "LeftArm"
        | "LeftLeg"
        | "MoodAnimation"
        | "Pants"
        | "ProportionScale"
        | "RightArm"
        | "RightLeg"
        | "RunAnimation"
        | "Shirt"
        | "SwimAnimation"
        | "Torso"
        | "WalkAnimation"
        | "WidthScale";
    },
>
Returns the type of method that would be used if you were to call Apply/Unapply based on the parameters provided.

Does not support bundles.
Parameters
- AssetId: number
Returns Promise<
    | undefined
    | {
        assetAccessoryType?: AccessoryType;
        assetType: AssetType;
        avatarStateProperty?: | "HeadColor"
        | "LeftArmColor"
        | "LeftLegColor"
        | "RightArmColor"
        | "RightLegColor"
        | "TorsoColor"
        | "BodyTypeScale"
        | "ClimbAnimation"
        | "DepthScale"
        | "Face"
        | "FallAnimation"
        | "GraphicTShirt"
        | "Head"
        | "HeadScale"
        | "HeightScale"
        | "IdleAnimation"
        | "JumpAnimation"
        | "LeftArm"
        | "LeftLeg"
        | "MoodAnimation"
        | "Pants"
        | "ProportionScale"
        | "RightArm"
        | "RightLeg"
        | "RunAnimation"
        | "Shirt"
        | "SwimAnimation"
        | "Torso"
        | "WalkAnimation"
        | "WidthScale";
    },
>
- Defined in index.ts:335

GetBundleInfo

GetBundleInfo(...args: [Bundle: number]): Promise<BundleInfo>
Details are cached.
Parameters
- ...args: [Bundle: number]
Returns Promise<BundleInfo>
- Defined in index.ts:245

GetEmotes

GetEmotes(...args: []): EmoteDictionary
Parameters
- ...args: []
Returns EmoteDictionary
- Defined in index.ts:497

GetMaximumAccessoriesForType

GetMaximumAccessoriesForType(AccessoryType: AccessoryType): undefined | number
Parameters
- AccessoryType: AccessoryType
Returns undefined | number
- Defined in index.ts:832

GetMutatAccessories

GetMutatAccessories(includeRigidAccessories?: boolean): AddAccessoryInfo[]
Parameters
- OptionalincludeRigidAccessories: boolean
Returns AddAccessoryInfo[]
- Defined in index.ts:526

GetProductInfo

GetProductInfo(...args: [Product: number]): Promise<AssetProductInfo>
Details are cached.
Parameters
- ...args: [Product: number]
Returns Promise<AssetProductInfo>
- Defined in index.ts:239

HasAccessory

HasAccessory(AccessoryKeyOrId: string | number): boolean
Parameters
- AccessoryKeyOrId: string | number
Returns boolean
- Defined in index.ts:552

LoadFromPlayer

LoadFromPlayer(Player: Player): HumanoidDescription
Parameters
- Player: Player
Returns HumanoidDescription
- Defined in index.ts:650

LoadFromSavedData

LoadFromSavedData(SavedData: AvatarStateSaveData): HumanoidDescription
Parameters
- SavedData: AvatarStateSaveData
Returns HumanoidDescription
- Defined in index.ts:653

LoadFromUserId

LoadFromUserId(UserId: number): HumanoidDescription
Parameters
- UserId: number
Returns HumanoidDescription
- Defined in index.ts:647

RemoveAccessories

RemoveAccessories(AccessoriesKeys: string[]): void
Parameters
- AccessoriesKeys: string[]
Returns void
- Defined in index.ts:580

RemoveAccessory

RemoveAccessory(AccessoryKey: string, DoNotApplyDescription?: boolean): number
Parameters
- AccessoryKey: string
- OptionalDoNotApplyDescription: boolean
Returns number
- Defined in index.ts:586

RemoveAccessoryById

RemoveAccessoryById(
AccessoryId: number,
maxRemovals?: number,
): LuaTuple<number[]>
Parameters
- AccessoryId: number
- maxRemovals: number = 1
Returns LuaTuple<number[]>
- Defined in index.ts:606

RemoveAllAccessories

RemoveAllAccessories(): void
Returns void
- Defined in index.ts:633

Reset

Reset(
    FromDescription?:
        | number
        | boolean
        | AvatarStateSaveData
        | HumanoidDescription,
    IsInitialRun?: boolean,
): HumanoidDescription
Parameters
- OptionalFromDescription: number | boolean | AvatarStateSaveData | HumanoidDescription
- OptionalIsInitialRun: boolean
Returns HumanoidDescription
- Defined in index.ts:657

ResetToDefault

ResetToDefault(
    Key:
        | "HeadColor"
        | "LeftArmColor"
        | "LeftLegColor"
        | "RightArmColor"
        | "RightLegColor"
        | "TorsoColor"
        | "BodyTypeScale"
        | "ClimbAnimation"
        | "DepthScale"
        | "Face"
        | "FallAnimation"
        | "GraphicTShirt"
        | "Head"
        | "HeadScale"
        | "HeightScale"
        | "IdleAnimation"
        | "JumpAnimation"
        | "LeftArm"
        | "LeftLeg"
        | "MoodAnimation"
        | "Pants"
        | "ProportionScale"
        | "RightArm"
        | "RightLeg"
        | "RunAnimation"
        | "Shirt"
        | "SwimAnimation"
        | "Torso"
        | "WalkAnimation"
        | "WidthScale"
        | "DynamicHead"
        | "AnimationBundle"
        | "CharacterBundle",
): void
Parameters
- Key:
      | "HeadColor"
      | "LeftArmColor"
      | "LeftLegColor"
      | "RightArmColor"
      | "RightLegColor"
      | "TorsoColor"
      | "BodyTypeScale"
      | "ClimbAnimation"
      | "DepthScale"
      | "Face"
      | "FallAnimation"
      | "GraphicTShirt"
      | "Head"
      | "HeadScale"
      | "HeightScale"
      | "IdleAnimation"
      | "JumpAnimation"
      | "LeftArm"
      | "LeftLeg"
      | "MoodAnimation"
      | "Pants"
      | "ProportionScale"
      | "RightArm"
      | "RightLeg"
      | "RunAnimation"
      | "Shirt"
      | "SwimAnimation"
      | "Torso"
      | "WalkAnimation"
      | "WidthScale"
      | "DynamicHead"
      | "AnimationBundle"
      | "CharacterBundle"
Returns void
- Defined in index.ts:765

SetBodyColor

SetBodyColor(
    Color: Color3,
    Exclude?: readonly [
        "HeadColor",
        "LeftArmColor",
        "LeftLegColor",
        "RightArmColor",
        "RightLegColor",
        "TorsoColor",
    ],
): void
Parameters
- Color: Color3
- OptionalExclude: readonly [
      "HeadColor",
      "LeftArmColor",
      "LeftLegColor",
      "RightArmColor",
      "RightLegColor",
      "TorsoColor",
  ]
Returns void
- Defined in index.ts:513

SetEmotes

SetEmotes(...args: [emotes: EmoteDictionary]): void
Parameters
- ...args: [emotes: EmoteDictionary]
Returns void
- Defined in index.ts:502

SetEquippedEmotes

SetEquippedEmotes(...args: [equippedEmotes: EquippedEmotes]): void
Parameters
- ...args: [equippedEmotes: EquippedEmotes]
Returns void
- Defined in index.ts:507

SetMaximumAccessoriesForType

SetMaximumAccessoriesForType(
AccessoryType: AccessoryType,
MaximumLimit: number,
): void
Parameters
- AccessoryType: AccessoryType
- MaximumLimit: number
Returns void
- Defined in index.ts:826

SetMutatAccessories

SetMutatAccessories(
Accessories: AddAccessoryInfo[],
includeRigidAccessories?: boolean,
): void
Parameters
- Accessories: AddAccessoryInfo[]
- OptionalincludeRigidAccessories: boolean
Returns void
- Defined in index.ts:529

Class AvatarState

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AvatarState

Properties

ReadonlyAccessories

AccessoryAdded

AccessoryRemoved

AnimationBundle

AutoApplyOnReset

BodyTypeScale

CharacterBundle

ClimbAnimation

DepthScale

DynamicHead

EmotesChanged

EquippedEmotesChanged

Face

FallAnimation

GraphicTShirt

Head

HeadColor

HeadScale

HeightScale

IdleAnimation

includeRigidAccessories

JumpAnimation

LeftArm

LeftArmColor

LeftLeg

LeftLegColor

MaximumAccessoryBehavior

MaximumAccessoryBehaviors

MoodAnimation

Pants

Player

ProportionScale

Resetted

RightArm

RightArmColor

RightLeg

RightLegColor

RunAnimation

Shirt

SwimAnimation

Torso

TorsoColor

WalkAnimation

WidthScale

Methods

AddAccessory

Parameters

Returns void

AddEmote

Parameters

Returns void

Apply

Parameters

Returns Promise<void>

ApplyDescription

Returns void

GenerateSaveData

Returns AvatarStateSaveData

GetAccessory

Parameters

Returns number

GetApplyMethod

Parameters

GetBundleInfo

Parameters

Returns Promise<BundleInfo>

GetEmotes

Parameters

Returns EmoteDictionary

`Readonly`Accessories