Adding Animations

To implement animations in-game, use scripts. For this tutorial, you’ll add your victory animation into a game using a pre-made script. Once finished, this animation can be used to celebrate a player’s accomplishment, like reaching the end of an obby or finding a secret.

New to Scripting? »

This guide covers step-by-step how to add and modify a script. It assumes some previous knowledge of scripting and isn’t intended to teach these concepts.

For your own game, you may need to make modifications to this script. To better understand scripting, we recommend going through the Code Fundamentals series.

Scripting Animations

Set up the Project

To organize all parts that will play the animation, add a folder in Workspace (hover over Workspace and click ) named TouchPartFolder.

Why Add Parts in a Folder? »

The script provided later will play feedback for any parts in this folder that are touched. This makes organizing your game easier than attaching a script onto an individual part.

In TouchPartFolder, add a part.

Make sure the part is placed where playing the animation would make sense, such as the end of a level or near an object players collect.

This first script attaches a Touched() event to any parts in the TouchPartFolder. Once a player touches any part there, it’ll play an animation.

To add the script, in StarterPlayer → StarterCharacterScripts, create a LocalScript named TouchPartRegister. Then copy and paste the code below.

			
				TouchPartRegister
			
				Expected Output
			
				Expand
				
			-- Used with "PlayerAnimationFeedback" script to play animations on part touches

-- Services
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Players = game:GetService("Players")

local player = Players.LocalPlayer
local character = player.Character or player.Character:Wait()
local humanoid = character:WaitForChild("Humanoid")
local canTouch = false

-- Include feedback animation module
local PlayerAnimationFeedback = require(ReplicatedStorage:WaitForChild("PlayerAnimationFeedback"))

-- Function called when a part is touched
local function onPartTouch(otherPart)
	if humanoid and canTouch == false then
		canTouch = true
		PlayerAnimationFeedback:PlayAnimation()
		canTouch = false
	end
end

-- On startup, call animation module load function
PlayerAnimationFeedback:LoadAnimation(humanoid)
-- Also bind a folder of parts to the "Touched" event to run "onPartTouch()"
local touchPartFolder = workspace:WaitForChild("TouchPartFolder")
local touchParts = touchPartFolder:GetChildren()

for objectIndex = 1, #touchParts do
	local touchPart = touchParts[objectIndex]
	touchPart.Touched:Connect(onPartTouch)
end
		
				Copy Code
			
				Light Theme

The next script triggers animations for a player. In ReplicatedStorage, create a new ModuleScript named PlayerAnimationFeedback. Then, copy and paste the code below.

			
				PlayerAnimationFeedback
			
				Expected Output
			
				Expand
				
			-- Used with "TouchPartRegister" script to play animations for a player
local PlayerAnimationFeedback = {}

local feedbackAnimationTrack
local ANIMATION_FADE = 0.3
local ANIMATION_ID = "rbxassetid://YOUR_ANIMATION"

-- Function to load animation onto player's character
function PlayerAnimationFeedback:LoadAnimation(humanoid)
	local feedbackAnimation = Instance.new("Animation")
	feedbackAnimation.AnimationId = ANIMATION_ID
	feedbackAnimationTrack = humanoid:LoadAnimation(feedbackAnimation)
	feedbackAnimationTrack.Priority = Enum.AnimationPriority.Action
	feedbackAnimationTrack.Looped = false
end

-- Function to play the animation
function PlayerAnimationFeedback:PlayAnimation()
	feedbackAnimationTrack:Play(ANIMATION_FADE)
	wait(feedbackAnimationTrack.Length)
end

return PlayerAnimationFeedback
		
				Copy Code
			
				Light Theme

Previous Improve and Export Next Playing Animations