NPC Animator Module

Resources Community Resources
#1

NPCAnimate Module Instruction Manual

Overview:
The NPCAnimate module allows for simple animation control of NPCs in your game. Designed to animate both moving and non-moving NPCs, this module provides essential functions to load, play, and manage animations. It also includes movement detection to automatically switch between idle and walking animations.

Features:

  • Create and Initialize NPC Animation: Instantiate the module and start with a default idle animation.
  • Load Animations: Easily load and assign animations to NPCs.
  • Play and Stop Animations: Control which animation is playing and stop all animations when needed.
  • Movement Monitoring: Automatically switches between idle and walking animations based on NPC movement.

Instructions:

  1. Setup:
    Ensure your NPC model includes a Humanoid and HumanoidRootPart.

  2. Creating an Instance:

    local NPCAnimate = require(game.ServerScriptService.NPCAnimate)
local npc = game.Workspace.NPC -- Replace with your NPC model
local npcAnimator = NPCAnimate.New(npc)

  3. Loading Animations:
    Load animations by specifying a name and asset ID. Example:

    npcAnimator:LoadAnimation("Idle", "rbxassetid://18789682643")
npcAnimator:LoadAnimation("Walk", "rbxassetid://18889146679")

  4. Playing an Animation:
    To play an animation:

    npcAnimator:PlayAnimation("Idle")

  5. Stopping an Animation:
    To stop a specific animation:

    npcAnimator:StopAnimation("Walk")

  6. Stopping All Animations:
    To stop all animations:

    npcAnimator:StopAllAnimations()

  7. Checking Current Animation:
    Retrieve the name of the currently playing animation:

    local currentAnim = npcAnimator:GetCurrentAnimation()

  8. Movement Monitoring:
    The module automatically switches between idle and walking animations based on the NPC’s movement.

Notes:

  • Ensure that the NPC model has a HumanoidRootPart and Humanoid.
  • Animations are looped by default; adjust as needed.

Elevate your NPC interactions with the NPCAnimate module! This versatile tool brings your NPCs to life by seamlessly animating them based on their movement. Whether your NPC is idle or on the move, this module ensures smooth transitions and engaging animations. With easy-to-use functions for loading, playing, and managing animations, you can quickly enhance the visual appeal of your game. Try NPCAnimate today and add dynamic character animation to your Roblox experience!

Also please remember that this tool will work as soon as you make a new NPC instance as shown in part 2 of the instructions.

Get the module at this link: NPC Animate - Creator Store (roblox.com)

5 Likes
#2

Please note that this Module is suppose to be runned on the Client however it works on both the server and client!

Thank you again! :slightly_smiling_face:

#3

You can now set the idle animation by creating the animation id as a number attribute called Idle and the same for walk except call it Walk!

#4

Dude this is so good :sweat_smile: Im actually suprised

1 Like
#5

Thank you, how come you are surprised?

#6

Usually resources are half done or just very bare and unpolished…

Especially on a scale this small, its impressive how clean this is.

Thank you for your contribution man :sweat_smile:

1 Like
#7

No problem, it makes me glad someone is using it!

#8

If I want to play animations other than walk and idle, can I overwrite the stored animation number?

-- Stop the current "Idle" animation before loading the new one
npcAnimator:StopAnimation("Idle")

-- Now load the new dance animation into the "Idle" slot
npcAnimator:LoadAnimation("Idle", "507771019")

-- Play the new animation
npcAnimator:PlayAnimation("Idle")
1 Like
#9

Yes, what you are doing there will work, if there are any errors please contact me.