Skip to main content

AnimationsClient

This item only works when running on the client. Client
note

Roblox model path: Animations.Package.AnimationsClient

info

Any reference to "client animation tracks" is referring to animation ids found under rigType of "Player" in the AnimationIds module.

Types​

initOptions​

</>
interface initOptions {
AutoRegisterPlayer: true
AutoLoadAllPlayerTracks: false
TimeToLoadPrints: true
EnableAutoCustomRBXAnimationIds: false
AnimatedObjectsDebugMode: false
}

Gets applied to Properties.

path​

</>
type path = {any} | string
-- In a LocalScript
local Animations = require(game.ReplicatedStorage.Animations.Package.AnimationsClient)


-- These are all valid options for retrieving an animation track
local animationPath = "Jump" -- A single key (any type)

local animationPath = {"Dodge", Vector3.xAxis} -- An array path (values of any type)

local animationPath = "Climb.Right" -- A path seperated by "." (string)


local animationTrack = Animations:GetTrack(animationPath)

customRBXAnimationIds​

</>
interface customRBXAnimationIds {
run: number?
walk: number?
jump: number?
idle: {
Animation1: number?,
Animation2: number?
}?
fall: number?
swim: number?
swimIdle: number?
climb: number?
}

A table of animation ids to replace the default roblox animation ids.

info

Roblox applies the "walk" animation id for R6 characters and the "run" animation id for R15 characters (instead of both).

humanoidRigTypeToCustomRBXAnimationIds​

</>
interface humanoidRigTypeToCustomRBXAnimationIds {
[Enum.HumanoidRigType.R6]: customRBXAnimationIds?
[Enum.HumanoidRigType.R15]: customRBXAnimationIds?
}

A table mapping a Enum.HumanoidRigType to its supported animation ids that will replace the default roblox animation ids.

Properties​

DepsFolderPath​

</>
AnimationsClient.DepsFolderPath: nil

Set the path to the dependencies folder if you have moved it from its original location inside of the root Animations folder.

added in version 2.0.0-rc1

AutoRegisterPlayer​

</>
AnimationsClient.AutoRegisterPlayer: true

If set to true, the client will automatically be registered on spawn. See Animations:Register() for more info.

warning

Must have animation ids under rigType of "Player" in the AnimationIds module.

added in version 2.0.0-rc1

AutoLoadAllPlayerTracks​

</>
AnimationsClient.AutoLoadAllPlayerTracks: false

If set to true, client animation tracks will be loaded each time the client spawns.

warning

Must have animation ids under rigType of "Player" in the AnimationIds module.

changed in version 2.0.0-rc1

Renamed: AutoLoadPlayerTracks -> AutoLoadAllPlayerTracks

Will automatically register client as well if AutoRegisterPlayer is not already set to true.

TimeToLoadPrints​

</>
AnimationsClient.TimeToLoadPrints: true

If set to true, makes helpful prints about the time it takes to pre-load and load animations.

EnableAutoCustomRBXAnimationIds​

</>
AnimationsClient.EnableAutoCustomRBXAnimationIds: false

If set to true, applies the AutoCustomRBXAnimationIds module table to the client on spawn.

added in version 2.0.0-rc1

AnimatedObjectsDebugMode​

</>
AnimationsClient.AnimatedObjectsDebugMode: false

If set to true, prints will be made to help debug attaching and detaching animated objects.

PreloadAsyncProgressed​

</>
AnimationsClient.PreloadAsyncProgressed: RBXScriptSignal

Fires when ContentProvider:PreloadAsync() finishes pre-loading one animation instance.

-- In a LocalScript
Animations.PreloadAsyncProgressed:Connect(function(n, total, loadedAnimInstance)
	print("ContentProvider:PreloadAsync() finished pre-loading one:", n, total, loadedAnimInstance)
end)
added in version 2.0.0-rc1

Functions​

Init​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:Init(initOptions: initOptions?) → ()

Initializes AnimationsClient.

Yields when...

  • ...server has not initialized.
  • ...animations are being pre-loaded with ContentProvider:PreloadAsync() (could take a while).
info

Should be called once before any other method.

GetAppliedProfileName​

</>
AnimationsClient:GetAppliedProfileName() → string?

Returns the client's currently applied animation profile name or nil.

added in version 2.0.0

GetRigAppliedProfileName​

</>
AnimationsClient:GetRigAppliedProfileName(rig: Model) → string?

Returns the rig's currently applied animation profile name or nil.

added in version 2.0.0

AwaitPreloadAsyncFinished​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitPreloadAsyncFinished() → {Animation?}

Yields until ContentProvider:PreloadAsync() finishes pre-loading all animation instances.

-- In a LocalScript
local loadedAnimInstances = Animations:AwaitPreloadAsyncFinished()
	
print("ContentProvider:PreloadAsync() finished pre-loading all:", loadedAnimInstances)
added in version 2.0.0-rc1

Register​

</>
AnimationsClient:Register() → ()

Registers the client's character so that methods using animation tracks can be called.

tip

Automatically gives the rig (the client's character) an attribute "AnimationsRigType" set to the rigType (which is "Player" in this case).

added in version 2.0.0-rc1

RegisterRig​

</>
AnimationsClient:RegisterRig(
rig: Model,
rigType: string
) → ()

Registers the rig so that rig methods using animation tracks can be called.

tip

Automatically gives the rig an attribute "AnimationsRigType" set to the rigType.

added in version 2.0.0-rc1

AwaitRegistered​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitRegistered() → ()

Yields until the client gets registered.

added in version 2.0.0-rc1

AwaitRigRegistered​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitRigRegistered(rig: Model) → ()

Yields until the rig gets registered.

added in version 2.0.0-rc1

IsRegistered​

</>
AnimationsClient:IsRegistered() → boolean

Returns if the client is registered.

added in version 2.0.0-rc1

IsRigRegistered​

</>
AnimationsClient:IsRigRegistered(rig: Model) → boolean

Returns if the rig is registered.

added in version 2.0.0-rc1

ApplyCustomRBXAnimationIds​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:ApplyCustomRBXAnimationIds(humanoidRigTypeToCustomRBXAnimationIds: humanoidRigTypeToCustomRBXAnimationIds) → ()

Applies the animation ids specified in the humanoidRigTypeToCustomRBXAnimationIds table on the client's character.

Yields when...

  • ...the client's character, humanoid, animator, or animate script aren't immediately available.
tip

See ApplyAnimationProfile() for a more convenient way of overriding default roblox character animations.

-- In a LocalScript
local Animations = require(game.ReplicatedStorage.Animations.Package.AnimationsClient)

Animations:Init()

task.wait(5)

print("Applying r15 ninja jump & idle animations")

-- These animations will only work if your character is R15
Animations:ApplyCustomRBXAnimationIds({
	[Enum.HumanoidRigType.R15] = {
		jump = 656117878,
		idle = {
			Animation1 = 656117400,
			Animation2 = 656118341
		}
	}
})

ApplyRigCustomRBXAnimationIds​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:ApplyRigCustomRBXAnimationIds(
rig: Model,
humanoidRigTypeToCustomRBXAnimationIds: humanoidRigTypeToCustomRBXAnimationIds
) → ()

Applies the animation ids specified in the humanoidRigTypeToCustomRBXAnimationIds table on the rig.

Yields when...

  • ...the rig's humanoid or animate script aren't immediately available.
warning

This function only works for R6/R15 NPCs that are local to the client or network-owned by the client and have a client-side "Animate" script in their model.

tip

See ApplyRigAnimationProfile() for a more convenient way of overriding default roblox character animations.

GetAnimationProfile​

</>
AnimationsClient:GetAnimationProfile(animationProfileName: string) → animationProfilehumanoidRigTypeToCustomRBXAnimationIds?

Returns the humanoidRigTypeToCustomRBXAnimationIds table found in the profile module script Deps.<animationProfileName>, or not if it doesn't exist.

ApplyAnimationProfile​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:ApplyAnimationProfile(animationProfileName: string) → ()

Applies the animation ids found in the animation profile on the client's character.

Yields when...

  • ...the client's character, humanoid, animator, or animate script aren't immediately available.
info

For more information on setting up animation profiles check out animation profiles tutorial.

ApplyRigAnimationProfile​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:ApplyRigAnimationProfile(
rig: Model,
animationProfileName: string
) → ()

Applies the animation ids found in the animation profile on the rig.

Yields when...

  • ...the rig's humanoid or animate script aren't immediately available.
warning

This function only works for R6/R15 NPCs that are local to the client or network-owned by the client and have a client-side "Animate" script in their model.

info

For more information on setting up animation profiles check out animation profiles tutorial.

AwaitAllTracksLoaded​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitAllTracksLoaded() → ()

Yields until the client has been registered and then until all animation tracks have loaded.

changed in version 2.0.0-rc1

Renamed: AwaitLoaded -> AwaitAllTracksLoaded

-- In a LocalScript
-- [WARNING] For this to work you need animation ids under the rig type of "Player" in the 'AnimationIds' module
local Animations = require(game.ReplicatedStorage.Animations.Package.AnimationsClient)

Animations:Init({
	AutoRegisterPlayer = true, -- Defaults to true (on the client)
	AutoLoadAllPlayerTracks = true -- Defaults to false
})

Animations:AwaitAllTracksLoaded()

print("Animation tracks finished loading on the client!")

AwaitAllRigTracksLoaded​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitAllRigTracksLoaded(rig: Model) → ()

Yields until the rig has been registered and then until all animation tracks have loaded.

changed in version 2.0.0-rc1

Renamed: AwaitRigTracksLoaded -> AwaitAllRigTracksLoaded

AwaitTracksLoadedAt​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitTracksLoadedAt(path: path) → ()

Yields until the client has been registered and then until all animation tracks have loaded at path.

added in version 2.0.0-rc1

AwaitRigTracksLoadedAt​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
AnimationsClient:AwaitRigTracksLoadedAt(
rig: Model,
path: path
) → ()

Yields until the rig has been registered and then until all animation tracks have loaded at path.

added in version 2.0.0-rc1

AreAllTracksLoaded​

</>
AnimationsClient:AreAllTracksLoaded() → boolean

Returns if the client has had all its animation tracks loaded.

changed in version 2.0.0-rc1

Renamed: AreTracksLoaded -> AreAllTracksLoaded

AreAllRigTracksLoaded​

</>
AnimationsClient:AreAllRigTracksLoaded(rig: Model) → boolean

Returns if the rig has had all its animation tracks loaded.

changed in version 2.0.0-rc1

Renamed: AreRigTracksLoaded -> AreAllRigTracksLoaded

AreTracksLoadedAt​

</>
AnimationsClient:AreTracksLoadedAt(path: path) → boolean

Returns if the client has had its animation tracks loaded at path.

added in version 2.0.0-rc1

AreRigTracksLoadedAt​

</>
AnimationsClient:AreRigTracksLoadedAt(
rig: Model,
path: path
) → boolean

Returns if the rig has had its animation tracks loaded at path.

added in version 2.0.0-rc1

LoadAllTracks​

</>
AnimationsClient:LoadAllTracks() → ()

Creates animation tracks from all animation ids in AnimationIds for the client.

changed in version 2.0.0-rc1

Renamed: LoadTracks -> LoadAllTracks

Now requires Animations:Register() before usage unless Animations.AutoRegisterPlayer is enabled.

LoadAllRigTracks​

</>
AnimationsClient:LoadAllRigTracks(rig: Model) → ()

Creates animation tracks from all animation ids in AnimationIds for the rig.

changed in version 2.0.0-rc1

Renamed: LoadRigTracks -> LoadAllRigTracks

Now requires Animations:RegisterRig() before usage.

LoadTracksAt​

</>
AnimationsClient:LoadTracksAt(path: path) → ()

Creates animation tracks from all animation ids in AnimationIds for the client at path.

added in version 2.0.0-rc1

LoadRigTracksAt​

</>
AnimationsClient:LoadRigTracksAt(
rig: Model,
path: path
) → ()

Creates animation tracks from all animation ids in AnimationIds for the rig at path.

added in version 2.0.0-rc1

GetTrack​

</>
AnimationsClient:GetTrack(path: path) → AnimationTrack?

Returns a client animation track or nil.

GetRigTrack​

</>
AnimationsClient:GetRigTrack(
rig: Model,
path: path
) → AnimationTrack?

Returns a rig animation track or nil.

PlayTrack​

</>
AnimationsClient:PlayTrack(
path: path,
fadeTime: number?,
weight: number?,
speed: number?
) → AnimationTrack

Returns a playing client animation track.

PlayRigTrack​

</>
AnimationsClient:PlayRigTrack(
rig: Model,
path: path,
fadeTime: number?,
weight: number?,
speed: number?
) → AnimationTrack

Returns a playing rig animation track.

StopTrack​

</>
AnimationsClient:StopTrack(
path: path,
fadeTime: number?
) → AnimationTrack

Returns a stopped client animation track.

StopRigTrack​

</>
AnimationsClient:StopRigTrack(
rig: Model,
path: path,
fadeTime: number?
) → AnimationTrack

Returns a stopped rig animation track.

StopPlayingTracks​

</>
AnimationsClient:StopPlayingTracks(fadeTime: number?) → {AnimationTrack?}

Returns the stopped client animation tracks.

changed in version 2.0.0-rc1

Renamed: StopAllTracks -> StopPlayingTracks

StopRigPlayingTracks​

</>
AnimationsClient:StopRigPlayingTracks(
rig: Model,
fadeTime: number?
) → {AnimationTrack?}

Returns the stopped rig animation tracks.

changed in version 2.0.0-rc1

Renamed: StopRigAllTracks -> StopRigPlayingTracks

GetPlayingTracks​

</>
AnimationsClient:GetPlayingTracks() → {AnimationTrack?}

Returns the playing client animation tracks.

added in version 2.0.0-rc1

GetRigPlayingTracks​

</>
AnimationsClient:GetRigPlayingTracks(rig: Model) → {AnimationTrack?}

Returns the playing rig animation tracks.

added in version 2.0.0-rc1

StopTracksOfPriority​

</>
AnimationsClient:StopTracksOfPriority(
animationPriority: Enum.AnimationPriority,
fadeTime: number?
) → {AnimationTrack?}

Returns the stopped client animation tracks.

StopRigTracksOfPriority​

</>
AnimationsClient:StopRigTracksOfPriority(
rig: Model,
animationPriority: Enum.AnimationPriority,
fadeTime: number?
) → {AnimationTrack?}

Returns the stopped rig animation tracks.

GetTrackFromAlias​

</>
AnimationsClient:GetTrackFromAlias(alias: any) → AnimationTrack?

Returns a client animation track or nil.

GetRigTrackFromAlias​

</>
AnimationsClient:GetRigTrackFromAlias(
rig: Model,
alias: any
) → AnimationTrack?

Returns a rig animation track or nil.

PlayTrackFromAlias​

</>
AnimationsClient:PlayTrackFromAlias(
alias: any,
fadeTime: number?,
weight: number?,
speed: number?
) → AnimationTrack

Returns a playing client animation track.

PlayRigTrackFromAlias​

</>
AnimationsClient:PlayRigTrackFromAlias(
rig: Model,
alias: any,
fadeTime: number?,
weight: number?,
speed: number?
) → AnimationTrack

Returns a playing rig animation track.

StopTrackFromAlias​

</>
AnimationsClient:StopTrackFromAlias(
alias: any,
fadeTime: number?
) → AnimationTrack

Returns a stopped client animation track.

StopRigTrackFromAlias​

</>
AnimationsClient:StopRigTrackFromAlias(
rig: Model,
alias: any,
fadeTime: number?
) → AnimationTrack

Returns a stopped rig animation track.

SetTrackAlias​

</>
AnimationsClient:SetTrackAlias(
alias: any,
path: path
) → ()

Sets an alias to be the equivalent of the path for a client animation track.

tip

You can use the alias as the last key in the path. Useful for a table of animations. Example:

-- In ReplicatedStorage.Animations.Deps.AnimationIds
local animationIds = {
	Player = {
		FistsCombat = {
			-- Fists 3 hit combo
			Combo = {
				[1] = 1234567,
				[2] = 1234567,
				[3] = 1234567
			},

			-- Fists heavy attack
			HeavyAttack = 1234567
		},

		SwordCombat = {
			-- Sword 3 hit combo
			Combo = {
				[1] = 1234567,
				[2] = 1234567,
				[3] = 1234567
			},

			-- Sword heavy attack
			HeavyAttack = 1234567
		}
	}
}

-- In a LocalScript

-- After the client's animation tracks are loaded...

local heavyAttackAlias = "HeavyAttack" -- We want this alias in order to call Animations:PlayTrackFromAlias(heavyAttackAlias) regardless what weapon is equipped

local currentEquippedWeapon

local function updateHeavyAttackAliasPath()
	local alias = heavyAttackAlias
	local path = currentEquippedWeapon .. "Combat"

	Animations:SetTrackAlias(alias, path) -- Running this will search first "path.alias" and then search "path" if it didn't find "path.alias"
end

local function equipNewWeapon(weaponName)
	currentEquippedWeapon = weaponName

	updateHeavyAttackAliasPath()
end

equipNewWeapon("Fists")

Animations:PlayTrackFromAlias(heavyAttackAlias) -- Plays "FistsCombat.HeavyAttack" on the client's character

equipNewWeapon("Sword")

Animations:PlayTrackFromAlias(heavyAttackAlias) -- Plays "SwordCombat.HeavyAttack" on the client's character

SetRigTrackAlias​

</>
AnimationsClient:SetRigTrackAlias(
rig: Model,
alias: any,
path: path
) → ()

Sets an alias to be the equivalent of the path for a rig animation track.

tip

Same tip for Animations:SetTrackAlias() applies here.

RemoveTrackAlias​

</>
AnimationsClient:RemoveTrackAlias(alias: any) → ()

Removes the alias for a client animation track.

RemoveRigTrackAlias​

</>
AnimationsClient:RemoveRigTrackAlias(
rig: Model,
alias: any
) → ()

Removes the alias for a rig animation track.

AttachAnimatedObject​

Beta
</>
AnimationsClient:AttachAnimatedObject(animatedObjectPath: path) → ()

Attaches the animated object to the client's character.

note

This does not replicate to the server.

tip

Enable initOptions.AnimatedObjectsDebugMode for detailed prints about animated objects.

info

For more information on setting up animated objects check out animated objects tutorial.

AttachRigAnimatedObject​

Beta
</>
AnimationsClient:AttachRigAnimatedObject(
rig: Model,
animatedObjectPath: path
) → ()

Attaches the animated object to the rig.

note

This does not replicate to the server.

tip

Enable initOptions.AnimatedObjectsDebugMode for detailed prints about animated objects.

info

For more information on setting up animated objects check out animated objects tutorial.

DetachAnimatedObject​

Beta
</>
AnimationsClient:DetachAnimatedObject(animatedObjectPath: path) → ()

Detaches the animated object from the client's character.

note

This does not replicate to the server.

tip

Enable initOptions.AnimatedObjectsDebugMode for detailed prints about animated objects.

info

For more information on setting up animated objects check out animated objects tutorial.

DetachRigAnimatedObject​

Beta
</>
AnimationsClient:DetachRigAnimatedObject(
rig: Model,
animatedObjectPath: path
) → ()

Detaches the animated object from the rig.

note

This does not replicate to the server.

tip

Enable initOptions.AnimatedObjectsDebugMode for detailed prints about animated objects.

info

For more information on setting up animated objects check out animated objects tutorial.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes `AnimationsClient`.\n\nYields when...\n- ...server has not initialized.\n- ...animations are being pre-loaded with `ContentProvider:PreloadAsync()` (could take a while).\n\n:::info\nShould be called once before any other method.\n:::",
            "params": [
                {
                    "name": "initOptions",
                    "desc": "",
                    "lua_type": "initOptions?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 154,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetAppliedProfileName",
            "desc": "Returns the client's currently applied animation profile name or nil.\n\n:::tip *added in version 2.0.0*\n:::",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 306,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetRigAppliedProfileName",
            "desc": "Returns the `rig`'s currently applied animation profile name or nil.\n\n:::tip *added in version 2.0.0*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 317,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitPreloadAsyncFinished",
            "desc": "Yields until `ContentProvider:PreloadAsync()` finishes pre-loading all animation instances.\n\n```lua\n-- In a LocalScript\nlocal loadedAnimInstances = Animations:AwaitPreloadAsyncFinished()\n\t\nprint(\"ContentProvider:PreloadAsync() finished pre-loading all:\", loadedAnimInstances)\n```\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Animation?}"
                }
            ],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 336,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "Register",
            "desc": "Registers the client's character so that methods using animation tracks can be called.\n\n:::tip\nAutomatically gives the `rig` (the client's character) an attribute `\"AnimationsRigType\"` set to the [`rigType`](/api/AnimationIds#rigType) (which is \"Player\" in this case).\n:::\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 394,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "RegisterRig",
            "desc": "Registers the `rig` so that rig methods using animation tracks can be called.\n\n:::tip\nAutomatically gives the `rig` an attribute `\"AnimationsRigType\"` set to the [`rigType`](/api/AnimationIds/#rigType).\n:::\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "rigType",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 409,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitRegistered",
            "desc": "Yields until the client gets registered.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 420,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitRigRegistered",
            "desc": "Yields until the `rig` gets registered.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 431,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "IsRegistered",
            "desc": "Returns if the client is registered.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 442,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "IsRigRegistered",
            "desc": "Returns if the `rig` is registered.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 453,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "ApplyCustomRBXAnimationIds",
            "desc": "Applies the animation ids specified in the [`humanoidRigTypeToCustomRBXAnimationIds`](#humanoidRigTypeToCustomRBXAnimationIds) table on the client's character.\n\nYields when...\n- ...the client's character, humanoid, animator, or animate script aren't immediately available.\n\n:::tip\nSee [`ApplyAnimationProfile()`](#ApplyAnimationProfile) for a more convenient way of overriding default roblox character animations.\n:::\n\n```lua\n-- In a LocalScript\nlocal Animations = require(game.ReplicatedStorage.Animations.Package.AnimationsClient)\n\nAnimations:Init()\n\ntask.wait(5)\n\nprint(\"Applying r15 ninja jump & idle animations\")\n\n-- These animations will only work if your character is R15\nAnimations:ApplyCustomRBXAnimationIds({\n\t[Enum.HumanoidRigType.R15] = {\n\t\tjump = 656117878,\n\t\tidle = {\n\t\t\tAnimation1 = 656117400,\n\t\t\tAnimation2 = 656118341\n\t\t}\n\t}\n})\n```",
            "params": [
                {
                    "name": "humanoidRigTypeToCustomRBXAnimationIds",
                    "desc": "",
                    "lua_type": "humanoidRigTypeToCustomRBXAnimationIds"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 491,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "ApplyRigCustomRBXAnimationIds",
            "desc": "Applies the animation ids specified in the [`humanoidRigTypeToCustomRBXAnimationIds`](#humanoidRigTypeToCustomRBXAnimationIds) table on the `rig`.\n\nYields when...\n- ...the `rig`'s humanoid or animate script aren't immediately available.\n\n:::warning\nThis function only works for R6/R15 NPCs that are local to the client or network-owned by the client and have a client-side `\"Animate\"` script in their model.\n:::\n:::tip\nSee [`ApplyRigAnimationProfile()`](#ApplyRigAnimationProfile) for a more convenient way of overriding default roblox character animations.\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "humanoidRigTypeToCustomRBXAnimationIds",
                    "desc": "",
                    "lua_type": "humanoidRigTypeToCustomRBXAnimationIds"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 510,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetAnimationProfile",
            "desc": "Returns the [`humanoidRigTypeToCustomRBXAnimationIds`](api/AnimationsServer#humanoidRigTypeToCustomRBXAnimationIds) table found in the profile module script `Deps.<animationProfileName>`, or not if it doesn't exist.",
            "params": [
                {
                    "name": "animationProfileName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "animationProfile humanoidRigTypeToCustomRBXAnimationIds?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 519,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "ApplyAnimationProfile",
            "desc": "Applies the animation ids found in the animation profile on the client's character.\n\nYields when...\n- ...the client's character, humanoid, animator, or animate script aren't immediately available.\n\n:::info\nFor more information on setting up animation profiles check out [animation profiles tutorial](/docs/animation-profiles).\n:::",
            "params": [
                {
                    "name": "animationProfileName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 535,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "ApplyRigAnimationProfile",
            "desc": "Applies the animation ids found in the animation profile on the `rig`.\n\nYields when...\n- ...the `rig`'s humanoid or animate script aren't immediately available.\n\n:::warning\nThis function only works for R6/R15 NPCs that are local to the client or network-owned by the client and have a client-side `\"Animate\"` script in their model.\n:::\n:::info\nFor more information on setting up animation profiles check out [animation profiles tutorial](/docs/animation-profiles).\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "animationProfileName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 554,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitAllTracksLoaded",
            "desc": "Yields until the client has been registered and then until all animation tracks have loaded.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`AwaitLoaded`~~ -> `AwaitAllTracksLoaded`\n:::\n\n```lua\n-- In a LocalScript\n-- [WARNING] For this to work you need animation ids under the rig type of \"Player\" in the 'AnimationIds' module\nlocal Animations = require(game.ReplicatedStorage.Animations.Package.AnimationsClient)\n\nAnimations:Init({\n\tAutoRegisterPlayer = true, -- Defaults to true (on the client)\n\tAutoLoadAllPlayerTracks = true -- Defaults to false\n})\n\nAnimations:AwaitAllTracksLoaded()\n\nprint(\"Animation tracks finished loading on the client!\")\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 581,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitAllRigTracksLoaded",
            "desc": "Yields until the `rig` has been registered and then until all animation tracks have loaded.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`AwaitRigTracksLoaded`~~ -> `AwaitAllRigTracksLoaded`\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 593,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitTracksLoadedAt",
            "desc": "Yields until the client has been registered and then until all animation tracks have loaded at `path`.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 605,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AwaitRigTracksLoadedAt",
            "desc": "Yields until the `rig` has been registered and then until all animation tracks have loaded at `path`.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "yields": true,
            "source": {
                "line": 617,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AreAllTracksLoaded",
            "desc": "Returns if the client has had all its animation tracks loaded.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`AreTracksLoaded`~~ -> `AreAllTracksLoaded`\n:::",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 629,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AreAllRigTracksLoaded",
            "desc": "Returns if the `rig` has had all its animation tracks loaded.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`AreRigTracksLoaded`~~ -> `AreAllRigTracksLoaded`\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 641,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AreTracksLoadedAt",
            "desc": "Returns if the client has had its animation tracks loaded at `path`.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 653,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AreRigTracksLoadedAt",
            "desc": "Returns if the `rig` has had its animation tracks loaded at `path`.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 665,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "LoadAllTracks",
            "desc": "Creates animation tracks from all animation ids in [`AnimationIds`](/api/AnimationIds) for the client.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`LoadTracks`~~ -> `LoadAllTracks`\n\nNow requires `Animations:Register()` before usage unless [`Animations.AutoRegisterPlayer`](/api/AnimationsClient/#AutoRegisterPlayer) is enabled.\n:::",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 678,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "LoadAllRigTracks",
            "desc": "Creates animation tracks from all animation ids in [`AnimationIds`](/api/AnimationIds) for the `rig`.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`LoadRigTracks`~~ -> `LoadAllRigTracks`\n\nNow requires `Animations:RegisterRig()` before usage.\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 691,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "LoadTracksAt",
            "desc": "Creates animation tracks from all animation ids in [`AnimationIds`](/api/AnimationIds) for the client at `path`.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 702,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "LoadRigTracksAt",
            "desc": "Creates animation tracks from all animation ids in [`AnimationIds`](/api/AnimationIds) for the `rig` at `path`.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 713,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetTrack",
            "desc": "Returns a client animation track or nil.",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 722,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetRigTrack",
            "desc": "Returns a `rig` animation track or nil.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 731,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "PlayTrack",
            "desc": "Returns a playing client animation track.",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 743,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "PlayRigTrack",
            "desc": "Returns a playing `rig` animation track.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 755,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopTrack",
            "desc": "Returns a stopped client animation track.",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 765,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopRigTrack",
            "desc": "Returns a stopped `rig` animation track.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 775,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopPlayingTracks",
            "desc": "Returns the stopped client animation tracks.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`StopAllTracks`~~ -> `StopPlayingTracks`\n:::",
            "params": [
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{AnimationTrack?}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 788,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopRigPlayingTracks",
            "desc": "Returns the stopped `rig` animation tracks.\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`StopRigAllTracks`~~ -> `StopRigPlayingTracks`\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{AnimationTrack?}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 801,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetPlayingTracks",
            "desc": "Returns the playing client animation tracks.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{AnimationTrack?}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 811,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetRigPlayingTracks",
            "desc": "Returns the playing `rig` animation tracks.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{AnimationTrack?}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 822,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopTracksOfPriority",
            "desc": "Returns the stopped client animation tracks.",
            "params": [
                {
                    "name": "animationPriority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{AnimationTrack?}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 832,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopRigTracksOfPriority",
            "desc": "Returns the stopped `rig` animation tracks.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "animationPriority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{AnimationTrack?}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 842,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetTrackFromAlias",
            "desc": "Returns a client animation track or nil.",
            "params": [
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 851,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "GetRigTrackFromAlias",
            "desc": "Returns a `rig` animation track or nil.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 860,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "PlayTrackFromAlias",
            "desc": "Returns a playing client animation track.",
            "params": [
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 872,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "PlayRigTrackFromAlias",
            "desc": "Returns a playing `rig` animation track.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 884,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopTrackFromAlias",
            "desc": "Returns a stopped client animation track.",
            "params": [
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 894,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "StopRigTrackFromAlias",
            "desc": "Returns a stopped `rig` animation track.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 904,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "SetTrackAlias",
            "desc": "Sets an alias to be the equivalent of the path for a client animation track.\n\n:::tip\nYou can use the alias as the last key in the path. Useful for a table of animations. Example:\n\n```lua\n-- In ReplicatedStorage.Animations.Deps.AnimationIds\nlocal animationIds = {\n\tPlayer = {\n\t\tFistsCombat = {\n\t\t\t-- Fists 3 hit combo\n\t\t\tCombo = {\n\t\t\t\t[1] = 1234567,\n\t\t\t\t[2] = 1234567,\n\t\t\t\t[3] = 1234567\n\t\t\t},\n\n\t\t\t-- Fists heavy attack\n\t\t\tHeavyAttack = 1234567\n\t\t},\n\n\t\tSwordCombat = {\n\t\t\t-- Sword 3 hit combo\n\t\t\tCombo = {\n\t\t\t\t[1] = 1234567,\n\t\t\t\t[2] = 1234567,\n\t\t\t\t[3] = 1234567\n\t\t\t},\n\n\t\t\t-- Sword heavy attack\n\t\t\tHeavyAttack = 1234567\n\t\t}\n\t}\n}\n```\n\n```lua\n-- In a LocalScript\n\n-- After the client's animation tracks are loaded...\n\nlocal heavyAttackAlias = \"HeavyAttack\" -- We want this alias in order to call Animations:PlayTrackFromAlias(heavyAttackAlias) regardless what weapon is equipped\n\nlocal currentEquippedWeapon\n\nlocal function updateHeavyAttackAliasPath()\n\tlocal alias = heavyAttackAlias\n\tlocal path = currentEquippedWeapon .. \"Combat\"\n\n\tAnimations:SetTrackAlias(alias, path) -- Running this will search first \"path.alias\" and then search \"path\" if it didn't find \"path.alias\"\nend\n\nlocal function equipNewWeapon(weaponName)\n\tcurrentEquippedWeapon = weaponName\n\n\tupdateHeavyAttackAliasPath()\nend\n\nequipNewWeapon(\"Fists\")\n\nAnimations:PlayTrackFromAlias(heavyAttackAlias) -- Plays \"FistsCombat.HeavyAttack\" on the client's character\n\nequipNewWeapon(\"Sword\")\n\nAnimations:PlayTrackFromAlias(heavyAttackAlias) -- Plays \"SwordCombat.HeavyAttack\" on the client's character\n```\n:::",
            "params": [
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 979,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "SetRigTrackAlias",
            "desc": "Sets an alias to be the equivalent of the path for a `rig` animation track.\n\n:::tip\nSame tip for [`Animations:SetTrackAlias()`](#SetTrackAlias) applies here.\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 992,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "RemoveTrackAlias",
            "desc": "Removes the alias for a client animation track.",
            "params": [
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 1000,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "RemoveRigTrackAlias",
            "desc": "Removes the alias for a `rig` animation track.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "alias",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 1008,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AttachAnimatedObject",
            "desc": "Attaches the animated object to the client's character.\n\n:::note\nThis does not replicate to the server.\n:::\n:::tip\nEnable [`initOptions.AnimatedObjectsDebugMode`](/api/AnimationsClient/#initOptions) for detailed prints about animated objects.\n:::\n:::info\nFor more information on setting up animated objects check out [animated objects tutorial](/docs/animated-objects).\n:::",
            "params": [
                {
                    "name": "animatedObjectPath",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Beta"
            ],
            "source": {
                "line": 1027,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AttachRigAnimatedObject",
            "desc": "Attaches the animated object to the `rig`.\n\n:::note\nThis does not replicate to the server.\n:::\n:::tip\nEnable [`initOptions.AnimatedObjectsDebugMode`](/api/AnimationsClient/#initOptions) for detailed prints about animated objects.\n:::\n:::info\nFor more information on setting up animated objects check out [animated objects tutorial](/docs/animated-objects).\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "animatedObjectPath",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Beta"
            ],
            "source": {
                "line": 1046,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "DetachAnimatedObject",
            "desc": "Detaches the animated object from the client's character.\n\n:::note\nThis does not replicate to the server.\n:::\n:::tip\nEnable [`initOptions.AnimatedObjectsDebugMode`](/api/AnimationsClient/#initOptions) for detailed prints about animated objects.\n:::\n:::info\nFor more information on setting up animated objects check out [animated objects tutorial](/docs/animated-objects).\n:::",
            "params": [
                {
                    "name": "animatedObjectPath",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Beta"
            ],
            "source": {
                "line": 1065,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "DetachRigAnimatedObject",
            "desc": "Detaches the animated object from the `rig`.\n\n:::note\nThis does not replicate to the server.\n:::\n:::tip\nEnable [`initOptions.AnimatedObjectsDebugMode`](/api/AnimationsClient/#initOptions) for detailed prints about animated objects.\n:::\n:::info\nFor more information on setting up animated objects check out [animated objects tutorial](/docs/animated-objects).\n:::",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "animatedObjectPath",
                    "desc": "",
                    "lua_type": "path"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Beta"
            ],
            "source": {
                "line": 1084,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "DepsFolderPath",
            "desc": "Set the path to the dependencies folder if you have moved it from its original location inside of the root `Animations` folder.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "lua_type": "nil",
            "source": {
                "line": 78,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AutoRegisterPlayer",
            "desc": "If set to true, the client will automatically be registered on spawn. See [`Animations:Register()`](/api/AnimationsClient/#Register) for more info.\n\n:::warning\nMust have animation ids under [`rigType`](/api/AnimationIds#rigType) of **\"Player\"** in the [`AnimationIds`](/api/AnimationIds) module.\n:::\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "lua_type": "true",
            "source": {
                "line": 93,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AutoLoadAllPlayerTracks",
            "desc": "If set to true, client animation tracks will be loaded each time the client spawns.\n\n:::warning\nMust have animation ids under [`rigType`](/api/AnimationIds#rigType) of **\"Player\"** in the [`AnimationIds`](/api/AnimationIds) module.\n:::\n\n:::caution *changed in version 2.0.0-rc1*\nRenamed: ~~`AutoLoadPlayerTracks`~~ -> `AutoLoadAllPlayerTracks`\n\nWill automatically register client as well if [`AutoRegisterPlayer`](/api/AnimationsClient/#AutoRegisterPlayer) is not already set to true.\n:::",
            "lua_type": "false",
            "source": {
                "line": 111,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "TimeToLoadPrints",
            "desc": "If set to true, makes helpful prints about the time it takes to pre-load and load animations.",
            "lua_type": "true",
            "source": {
                "line": 119,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "EnableAutoCustomRBXAnimationIds",
            "desc": "If set to true, applies the [`AutoCustomRBXAnimationIds`](/api/AutoCustomRBXAnimationIds) module table to the client on spawn.\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "lua_type": "false",
            "source": {
                "line": 130,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "AnimatedObjectsDebugMode",
            "desc": "If set to true, prints will be made to help debug attaching and detaching animated objects.",
            "lua_type": "false",
            "source": {
                "line": 138,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "PreloadAsyncProgressed",
            "desc": "Fires when `ContentProvider:PreloadAsync()` finishes pre-loading one animation instance.\n\n```lua\n-- In a LocalScript\nAnimations.PreloadAsyncProgressed:Connect(function(n, total, loadedAnimInstance)\n\tprint(\"ContentProvider:PreloadAsync() finished pre-loading one:\", n, total, loadedAnimInstance)\nend)\n```\n\n:::tip *added in version 2.0.0-rc1*\n:::",
            "lua_type": "RBXScriptSignal",
            "source": {
                "line": 352,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        }
    ],
    "types": [
        {
            "name": "initOptions",
            "desc": "Gets applied to [`Properties`](/api/AnimationsClient/#properties).",
            "fields": [
                {
                    "name": "AutoRegisterPlayer",
                    "lua_type": "true",
                    "desc": ""
                },
                {
                    "name": "AutoLoadAllPlayerTracks",
                    "lua_type": "false",
                    "desc": ""
                },
                {
                    "name": "TimeToLoadPrints",
                    "lua_type": "true",
                    "desc": ""
                },
                {
                    "name": "EnableAutoCustomRBXAnimationIds",
                    "lua_type": "false",
                    "desc": ""
                },
                {
                    "name": "AnimatedObjectsDebugMode",
                    "lua_type": "false",
                    "desc": ""
                }
            ],
            "source": {
                "line": 31,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "path",
            "desc": "```lua\n-- In a LocalScript\nlocal Animations = require(game.ReplicatedStorage.Animations.Package.AnimationsClient)\n\n\n-- These are all valid options for retrieving an animation track\nlocal animationPath = \"Jump\" -- A single key (any type)\n\nlocal animationPath = {\"Dodge\", Vector3.xAxis} -- An array path (values of any type)\n\nlocal animationPath = \"Climb.Right\" -- A path seperated by \".\" (string)\n\n\nlocal animationTrack = Animations:GetTrack(animationPath)\n```",
            "lua_type": "{any} | string",
            "source": {
                "line": 53,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "customRBXAnimationIds",
            "desc": "A table of animation ids to replace the default roblox animation ids.\n\n:::info\nRoblox applies the `\"walk\"` animation id for `R6` characters and the `\"run\"` animation id for `R15` characters (instead of both).\n:::",
            "fields": [
                {
                    "name": "run",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "walk",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "jump",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "idle",
                    "lua_type": "{Animation1: number?, Animation2: number?}?",
                    "desc": ""
                },
                {
                    "name": "fall",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "swim",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "swimIdle",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "climb",
                    "lua_type": "number?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 371,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        },
        {
            "name": "humanoidRigTypeToCustomRBXAnimationIds",
            "desc": "A table mapping a `Enum.HumanoidRigType` to its supported animation ids that will replace the default roblox animation ids.",
            "fields": [
                {
                    "name": "[Enum.HumanoidRigType.R6]",
                    "lua_type": "customRBXAnimationIds?",
                    "desc": ""
                },
                {
                    "name": "[Enum.HumanoidRigType.R15]",
                    "lua_type": "customRBXAnimationIds?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 380,
                "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
            }
        }
    ],
    "name": "AnimationsClient",
    "desc": ":::note\nRoblox model path: `Animations.Package.AnimationsClient`\n:::\n\n:::info\nAny reference to \"client animation tracks\" is referring to animation ids found under [`rigType`](/api/AnimationIds#rigType) of **\"Player\"** in the [`AnimationIds`](/api/AnimationIds) module.\n:::",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 67,
        "path": "src/ReplicatedStorage/Animations/Package/AnimationsClient.lua"
    }
}