Animate 2 - A more memory-efficient alternative

[JohhnyLegoKing]

I understand the issue much better now, but unfortunately this is a situation where trying to fix this issue is creating a new problem

As I previously mentioned (and I learned today while trying to fix this issue), the default animation script uses a BindableFunction to handle emotes. The BindableFunction seems to be invoked from a core script, so I won’t be able to make any changes there. The script that’s invoking the BindableFunction passes either a string, or an animation, as an argument. It passes a string when you use one of the “regular” emotes, and an animation when you use one of the emotes you have equipped to your character

I tried handling emote command logic myself, which worked when playing the “regular” emotes, but kept giving me that error when I tried playing the equipped emotes, and the only solution I found to avoid that error is to use the BindableFunction, which unfortunately displays the “You do not own that emote” warning when you try to play a custom emote

Essentially, I don’t think there’s currently a way to handle “regular”, equipped, and custom emotes combined at the moment, without some kind of error or warning showing up

---

@iProjectionix

This version might allow you to use your custom emotes, and it also supports the “regular” emotes, but doesn’t support equipped emotes:

--!strict
local TextChatService = game:GetService("TextChatService")

local DEFAULT_FADE_TIME: number = 0.1

local character: Model = script.Parent
local humanoid = character:WaitForChild("Humanoid"):: Humanoid

local animationTracks: {[string]: AnimationTrack} = {}

do
	local animator = humanoid:WaitForChild("Animator"):: Animator

	local animationData: {[string]: {any}} = {
		cheer = {"rbxassetid://507770677", Enum.AnimationPriority.Idle},
		Climb = {"rbxassetid://507765644", Enum.AnimationPriority.Core},
		dance = {"rbxassetid://507772104", Enum.AnimationPriority.Core},
		dance2 = {"rbxassetid://507776879", Enum.AnimationPriority.Core},
		dance3 = {"rbxassetid://507777623", Enum.AnimationPriority.Core},
		Fall = {"rbxassetid://507767968", Enum.AnimationPriority.Core},
		Idle = {"rbxassetid://507766388", Enum.AnimationPriority.Core},
		laugh = {"rbxassetid://507770818", Enum.AnimationPriority.Idle},
		Lunge = {"rbxassetid://522638767", Enum.AnimationPriority.Movement},
		point = {"rbxassetid://507770453", Enum.AnimationPriority.Idle},
		Run = {"rbxassetid://913376220", Enum.AnimationPriority.Core},
		Sit = {"rbxassetid://2506281703", Enum.AnimationPriority.Core},
		Slash = {"rbxassetid://522635514", Enum.AnimationPriority.Movement},
		Swim = {"rbxassetid://913384386", Enum.AnimationPriority.Core},
		SwimIdle = {"rbxassetid://913389285", Enum.AnimationPriority.Core},
		Tool = {"rbxassetid://507768375", Enum.AnimationPriority.Idle},
		wave = {"rbxassetid://507770239", Enum.AnimationPriority.Idle},

		bk = {"rbxassetid://129393686778054", Enum.AnimationPriority.Idle}}

	for name, data in animationData do
		local animation = Instance.new("Animation")
		animation.AnimationId = data[1]

		local animationTrack = animator:LoadAnimation(animation)
		animationTrack.Priority = data[2]

		animationTracks[name] = animationTrack
		animation:Destroy()
	end
end

local animationTrack = animationTracks.Idle
animationTrack:Play(0)

local childAddedConnection: RBXScriptConnection?

local round = math.round

local function play(newAnimationTrack: AnimationTrack, fadeTime: number?)
	if newAnimationTrack.IsPlaying then return end

	local fadeTime = fadeTime or DEFAULT_FADE_TIME

	animationTrack:Stop(fadeTime)
	animationTrack = newAnimationTrack
	animationTrack:Play(fadeTime)
end

local function onClimbing(speed: number)
	play(animationTracks.Climb)

	animationTracks.Climb:AdjustSpeed(round(speed) / 11)
end

local function onFreeFalling(active: boolean)
	if active then play(animationTracks.Fall) end
end

local function onRunning(speed: number)
	local speed = round(speed)

	if speed > 0 then
		play(animationTracks.Run)

		animationTracks.Run:AdjustSpeed(speed / 16)
	else
		play(animationTracks.Idle)
	end
end

local function onSeated(active: boolean)
	if active then play(animationTracks.Sit) end
end

local function onSwimming(speed: number)
	local speed = round(speed)

	if speed > 2 then
		play(animationTracks.Swim)

		animationTracks.Swim:AdjustSpeed(speed / 12)
	else
		play(animationTracks.SwimIdle)
	end
end

local function onChildAdded(child: Instance)
	if child:IsA("Tool") and child:FindFirstChild("Handle") then
		animationTracks.Tool:Play(DEFAULT_FADE_TIME)

		childAddedConnection = child.ChildAdded:Connect(function(child: Instance)
			if child:IsA("StringValue") and child.Name == "toolanim" then
				if child.Value == "Slash" then
					animationTracks.Slash:Play(0)
				elseif child.Value == "Lunge" then
					animationTracks.Lunge:Play(0, 1, 6)
				end

				child:Destroy()
			end
		end)
	end
end

local function onChildRemoved(child: Instance)
	if child:IsA("Tool") and child:FindFirstChild("Handle") then
		if childAddedConnection then
			childAddedConnection:Disconnect()
			childAddedConnection = nil
		end

		animationTracks.Tool:Stop(DEFAULT_FADE_TIME)
	end
end

humanoid.Climbing:Connect(onClimbing)
humanoid.FreeFalling:Connect(onFreeFalling)
humanoid.Running:Connect(onRunning)
humanoid.Seated:Connect(onSeated)
humanoid.Swimming:Connect(onSwimming)
character.ChildAdded:Connect(onChildAdded)
character.ChildRemoved:Connect(onChildRemoved)

if TextChatService.ChatVersion == Enum.ChatVersion.TextChatService
	and TextChatService.CreateDefaultCommands
	and TextChatService.CreateDefaultTextChannels
then
	local rbxEmoteCommand = Instance.new("TextChatCommand")
	rbxEmoteCommand.Name = "RBXEmoteCommand"
	rbxEmoteCommand.PrimaryAlias = "/emote"
	rbxEmoteCommand.SecondaryAlias = "/e"

	local textChatCommands = TextChatService:WaitForChild("TextChatCommands")
	textChatCommands:WaitForChild("RBXEmoteCommand"):Destroy()
	rbxEmoteCommand.Parent = textChatCommands

	local rbxSystem: TextChannel = TextChatService:WaitForChild("TextChannels"):WaitForChild("RBXSystem")

	rbxEmoteCommand.Triggered:Connect(function(_, unfilteredText: string)
		local emote = string.split(unfilteredText, " ")[2]
		local animationTrack = animationTracks[emote]

		if animationTrack then
			if string.find(emote, "dance") then
				play(animationTrack)
			else
				animationTrack.Looped = false
				animationTrack:Play(DEFAULT_FADE_TIME)
			end
		else
			rbxSystem:DisplaySystemMessage("<font color='#FF4040'>You do not own that emote.</font>")
		end
	end)
end

[iProjectionix (Project)]

Ahh you didn’t have to do that, it worked like charm, thank you ever so much!!!

[xvywop (JJCavalli)]

Hey i am currently using this, and it does not seem to be working, i assume i have done something wrong, Animations are not playing at ALL

[JohhnyLegoKing]

It’s quite late where I live at the moment, so I won’t be able to help you until tomorrow

It needs to be named Animate in-order to replace the default animation script, and make sure that it’s a direct child of StarterCharacterScripts, not StarterPlayerScripts or somewhere else

If you’ve made any changes to it, you can try reimporting it from the marketplace

[xvywop (JJCavalli)]

Well, here is the issue aha, i’m respecting all the requirements in order for it to work as it should but turns out it does not. the animations are not loading at all, im just a brick walking

[JohhnyLegoKing]

Are there any errors showing up in the output?

If you replaced the default animation IDs with your own, make sure that the animations were published under the same person or group that owns the game, otherwise they’ll fail to load

I also recommend temporarily disabling any other scripts which are handling the player’s animations, if you have any, as one of them could be blocking Animate 2 from running correctly

Also make sure that you don’t have any plugins running which edit the source code of scripts, as they could be accidentally breaking it

One last recommendation: If you have set Workspace’s SandboxedInstanceMode to Experimental, you’ll need to set Animate 2’s permissions in-order for it to be able to work

[Alacaii (Alacai)]

What’s wrong with the default one?

[xvywop (JJCavalli)]

@JohhnyLegoKing

One last recommendation: If you have set Workspace’s SandboxedInstanceMode to Experimental, you’ll need to set Animate 2’s permissions in-order for it to be able to work

i think its because of that, it cant be because of custom animation ids i don’t have custom ones i just plugged and play

[SpaceBlacksmith]

this looks really interesting! are you planning on adding staging animations to it?

[JohhnyLegoKing]

In that case, make sure that the script’s Sandboxed property is disabled/false

If the script doesn’t have a property named Sandboxed, then SandboxedInstanceMode isn’t enabled, so the cause of the issue is something else

Does Animate 2 work if you test it in a different experience, or a new baseplate?

Another question, just to confirm: Are you using Animate 2 for player controlled characters, or for NPCs? You’ll need to copy and paste its code to a server Script with it’s RunContext set to Client if you want to use it for NPCs (also make sure to add a BindableFunction named PlayEmote as a direct child of the script, otherwise WaitForChild will yield indefinitely (or you could delete the line that’s waiting for it, if you prefer))

[JohhnyLegoKing]

One of the benefits that Animate 2 has over the default script is that it’s purely event based, there aren’t any infinite loops running in the background (the default script has an infinite while loop that handles tool animations, and also handles transitioning between the jump animation to the free-fall animation. I opted to skip the jump animation in Animate 2, since the switch to the free-fall animation happens too quickly in the default script to justify adding it. Tool animations are handled using events)

There’s nothing “wrong” with the default script, if you prefer it over Animate 2

[BlueDeveloper24]

I have a landing animation. how do i play the landing animation when my humanoid landed? when i do it the animation wont play properly

[JohhnyLegoKing]

This should work:

--!strict
local DEFAULT_FADE_TIME: number = 0.1

local character: Model = script.Parent
local humanoid = character:WaitForChild("Humanoid"):: Humanoid
local animator = humanoid:WaitForChild("Animator"):: Animator

local playEmote = script:WaitForChild("PlayEmote")

local animationTracks: {[string]: AnimationTrack} = {}

do
	local animationData: {[string]: {any}} = {
		cheer = {"rbxassetid://507770677", Enum.AnimationPriority.Idle},
		Climb = {"rbxassetid://507765644", Enum.AnimationPriority.Core},
		dance = {"rbxassetid://507772104", Enum.AnimationPriority.Core},
		dance2 = {"rbxassetid://507776879", Enum.AnimationPriority.Core},
		dance3 = {"rbxassetid://507777623", Enum.AnimationPriority.Core},
		Fall = {"rbxassetid://507767968", Enum.AnimationPriority.Core},
		Idle = {"rbxassetid://507766388", Enum.AnimationPriority.Core},
		Landed = {"rbxassetid://507770677", Enum.AnimationPriority.Core}, -- I used the cheer animation ID for testing, replace it with the actual ID of the landing animation
		laugh = {"rbxassetid://507770818", Enum.AnimationPriority.Idle},
		Lunge = {"rbxassetid://522638767", Enum.AnimationPriority.Movement},
		point = {"rbxassetid://507770453", Enum.AnimationPriority.Idle},
		Run = {"rbxassetid://913376220", Enum.AnimationPriority.Core},
		Sit = {"rbxassetid://2506281703", Enum.AnimationPriority.Core},
		Slash = {"rbxassetid://522635514", Enum.AnimationPriority.Movement},
		Swim = {"rbxassetid://913384386", Enum.AnimationPriority.Core},
		SwimIdle = {"rbxassetid://913389285", Enum.AnimationPriority.Core},
		Tool = {"rbxassetid://507768375", Enum.AnimationPriority.Idle},
		wave = {"rbxassetid://507770239", Enum.AnimationPriority.Idle}}

	for name, data in animationData do
		local animation = Instance.new("Animation")
		animation.AnimationId = data[1]

		local animationTrack = animator:LoadAnimation(animation)
		animationTrack.Priority = data[2]

		animationTracks[name] = animationTrack

		animation:Destroy()
	end
end

local animationTrack = animationTracks.Idle
animationTrack:Play(0)

local childAddedConnection: RBXScriptConnection?
local landedIsPlaying = false

local round = math.round

local function play(newAnimationTrack: AnimationTrack, fadeTime: number?)
	if newAnimationTrack.IsPlaying or landedIsPlaying then return end

	local fadeTime = fadeTime or DEFAULT_FADE_TIME

	animationTrack:Stop(fadeTime)
	animationTrack = newAnimationTrack
	animationTrack:Play(fadeTime)
end

local function onClimbing(speed: number)
	play(animationTracks.Climb)

	animationTracks.Climb:AdjustSpeed(round(speed) / 11)
end

local function onFreeFalling(active: boolean)
	if active then play(animationTracks.Fall) end
end

local function onRunning(speed: number)
	local speed = round(speed)

	if speed > 0 then
		play(animationTracks.Run)

		animationTracks.Run:AdjustSpeed(speed / 16)
	else
		play(animationTracks.Idle)
	end
end

local function onSeated(active: boolean)
	if active then play(animationTracks.Sit) end
end

local function onStateChanged(_, humanoidStateType)
	if humanoidStateType == Enum.HumanoidStateType.Landed and landedIsPlaying == false then
		landedIsPlaying = true

		local walkSpeed = humanoid.WalkSpeed
		humanoid.WalkSpeed = 0
		humanoid:SetStateEnabled(Enum.HumanoidStateType.Jumping, false)

		animationTrack:Stop(DEFAULT_FADE_TIME)
		animationTracks.Landed:Play(DEFAULT_FADE_TIME)
		animationTracks.Landed.Stopped:Wait()
		animationTrack = animationTracks.Idle
		animationTrack:Play(DEFAULT_FADE_TIME)

		humanoid.WalkSpeed = walkSpeed
		humanoid:SetStateEnabled(Enum.HumanoidStateType.Jumping, true)

		landedIsPlaying = false
	end
end

local function onSwimming(speed: number)
	local speed = round(speed)

	if speed > 2 then
		play(animationTracks.Swim)

		animationTracks.Swim:AdjustSpeed(speed / 12)
	else
		play(animationTracks.SwimIdle)
	end
end

local function onChildAdded(child: Instance)
	if child:IsA("Tool") and child:FindFirstChild("Handle") then
		animationTracks.Tool:Play(DEFAULT_FADE_TIME)

		childAddedConnection = child.ChildAdded:Connect(function(child: Instance)
			if child:IsA("StringValue") and child.Name == "toolanim" then
				if child.Value == "Slash" then
					animationTracks.Slash:Play(0)
				elseif child.Value == "Lunge" then
					animationTracks.Lunge:Play(0, 1, 6)
				end

				child:Destroy()
			end
		end)
	end
end

local function onChildRemoved(child: Instance)
	if child:IsA("Tool") and child:FindFirstChild("Handle") then
		if childAddedConnection then
			childAddedConnection:Disconnect()
			childAddedConnection = nil
		end

		animationTracks.Tool:Stop(DEFAULT_FADE_TIME)
	end
end

humanoid.Climbing:Connect(onClimbing)
humanoid.FreeFalling:Connect(onFreeFalling)
humanoid.Running:Connect(onRunning)
humanoid.Seated:Connect(onSeated)
humanoid.StateChanged:Connect(onStateChanged)
humanoid.Swimming:Connect(onSwimming)
character.ChildAdded:Connect(onChildAdded)
character.ChildRemoved:Connect(onChildRemoved)

playEmote.OnInvoke = function(emote: any): boolean
	local emoteType = typeof(emote)

	if emoteType == "string" then
		local animationTrack = animationTracks[emote]
		if animationTrack == nil then return false end

		if string.find(emote, "dance") then
			play(animationTrack)
		else
			animationTrack.Looped = false
			animationTrack:Play(DEFAULT_FADE_TIME)
		end

		return true
	elseif emoteType == "Instance" and emote:IsA("Animation") then
		local animationTrack = animationTracks[emote.Name] -- Buggy type warnings are pretty annoying...

		if animationTrack == nil then
			animationTrack = animator:LoadAnimation(emote)
			animationTrack.Priority = Enum.AnimationPriority.Idle
			animationTracks[emote.Name] = animationTrack
		end

		play(animationTrack)
		return true
	end

	return false
end

Since humanoids don’t have a Landed event, I needed to use the StateChanged event to detect when they’ve landed. Replace the animation ID of the Landed animation found in line 21 with the animation ID of the landing animation that you’d like to use, and it should work correctly

[BlueDeveloper24]

How would roblox locomotion 8 directional animation would work with that?

also i found an issue the character still plays swimming animation when he gets out of water

[JohhnyLegoKing]

@BlueDeveloper24

How would roblox locomotion 8 directional animation would work with that?

Honestly, I don’t even know what that is, so I can’t really confirm whether or not Animate 2 is compatible with it. Theoretically, Animate 2 should be compatible with any animation system that’s based on AnimationTracks, so if locomotion 8 uses anything else to handle its logic, then it’s not supported

@BlueDeveloper24

also i found an issue the character still plays swimming animation when he gets out of water

I’m aware of that issue, and I did my best to try to fix it, but I wasn’t able to find a good solution. From testing, it seems that it only occurs when you try to exit slowly from water terrain at the very edge of its region. There shouldn’t be any issues occuring if you exit the terrain from the surface, or exit from the sides very quickly, so if there are, please let me know

[BlueDeveloper24]

Honestly, I don’t even know what that is

If you go to players you will have an option to tick strafing animations. that will make your character be able to go with 10-directional animations when shiftlock

[BlueDeveloper24]

Oh are you here?

guess what. it happens in the official roblox animation script as well!
I will file a bug report next week to make sure engineers will see it

[JohhnyLegoKing]

That would explain why I wasn’t able to find a way to prevent that from happening

Currently Studio’s buggy for me (sometimes it crashes as soon as I try to open it), so it’ll take a bit until I can test strafing animations. I’ll bookmark your post to make sure to test it as soon as I’m able to

---

@BlueDeveloper24 I was able to confirm that strafing animations do not work with Animate 2. I will take note of this feature to add it to Animate 2, if I’m able to figure out how

[towerscripter1386 (Tower)]

Great rewrite; the thing that makes me use it over the default one is simply compactness. Unlike the default one, I can actually properly edit the script knowing what exactly the script will do

[BlueDeveloper24]

Hi there @JohhnyLegoKing. I have filed a bug report as i promised.
here it is:

(Bug) Humanoids Wont Detect Ground When they Fall On their Back (or sides) From Swimming State!

I have noticed my npc keeps swimming despite being on ground and It does always happen when the NPC character falls on its back or sides from swimming state. this is what happens on game: Also when that happens humanoid floor material is air and not ground as it should be Frequancy: Always. File: Animation - Copy.rbxl (84.3 KB) Expected behavior When falling on its back from getting out of water, Humanoids should detect ground, fire the falling down, landed, and then get up sta…

Hopefully roblox team will look at it