Class AnimatorWrapper

constructor

• new AnimatorWrapper(instance: Instance): AnimatorWrapper

  Parameters

  • instance: Instance

  Returns AnimatorWrapper

StaticclassName

StaticrequiredProperties

data

• get data(): AnimatorWrapperData

  Returns AnimatorWrapperData

_getTrack

• _getTrack(id: string): AnimationTrack | undefined

  Parameters

  • id: string

  Returns AnimationTrack | undefined

created

• created(): void

  Returns void

getCurrentAnimationTrack

• getCurrentAnimationTrack(): AnimationTrack | undefined

  Returns AnimationTrack | undefined

  Currently playing animation track

isValidTrackForSet

• isValidTrackForSet(track: AnimationTrack, name: string): boolean

  Parameters

  • track: AnimationTrack
  • name: string

  Returns boolean

loadAnimation

• loadAnimation(
      id: bigint,
      forceLoop?: boolean,
  ): Promise<Response | AnimationTrack | undefined>

  Loads an animation (not to be confused with an avatar animation like those found on the catalog)

  Parameters

  • id: bigint
  • forceLoop: boolean = false

    Forces animation track to loop

  Returns Promise<Response | AnimationTrack | undefined>

  AnimationTrack on success

loadAvatarAnimation

• loadAvatarAnimation(
      id: bigint,
      isEmote?: boolean,
      forceLoop?: boolean,
  ): Promise<Response | undefined>

  Loads a new avatar animation (catalog run animation or emote, not to be confused with a creator store animation)

  Parameters

  • id: bigint
  • isEmote: boolean = false
  • forceLoop: boolean = false

    Forces animation track to loop

  Returns Promise<Response | undefined>

  undefined on success

playAnimation

• playAnimation(name: string, type?: "mood" | "main" | "tool"): boolean

  Switches to new animation

  Parameters

  • name: string

    Animation name, such as "idle", "walk", "emote.1234" or "id.1234"

  • type: "mood" | "main" | "tool" = "main"

  Returns boolean

  If animation sucessfully played

renderAnimation

• renderAnimation(
      addTime?: number,
      forceTime?: number,
      forceKeyframe?: number,
  ): void

  Renders animation pose

  Parameters

  • addTime: number = ...

    Time to add to the current time

  • OptionalforceTime: number

    Time to force animation to be at, -1 is in the middle of the animation

  • OptionalforceKeyframe: number

    Keyframe to force animation to be at

  Returns void

restPose

• restPose(includeMotors?: boolean, includeFACS?: boolean): void

  Resets all joints in the rig to be in their rest pose

  Parameters

  • includeMotors: boolean = true

    If motors (body movement joints) should be set to rest pose

  • includeFACS: boolean = true

    If FACS (face movement bones) should be set to rest pose

  Returns void

setup

• setup(): void

  Returns void

stopMoodAnimation

• stopMoodAnimation(): void

  Returns void

stopToolAnimation

• stopToolAnimation(): void

  Returns void

updateToolAnimation

• updateToolAnimation(rig: Instance): void

  Parameters

  • rig: Instance

  Returns void

updateToolConnections

• updateToolConnections(): void

  Returns void