Scripting an animation clip

Overview

This guide provides information on how to find an animation clip in Asset Library, configure it in your Space, and play it using a LUA script.

Steps to Follow

1. Finding an appropriate animation clip

   1. Navigate to Asset Library to browse available animation clips.
   2. Look for and add the animation clip titled "Wave Hip Hop Dance_Wave Hip Hop Dance."

2. Selecting a suitable model

   1. Since the animation clips in Asset Library are designed for humanoid models, locate an appropriate model.
   2. Find the humanoid model named "BackRoomsCharacter01" and place it in your Space.

3. Binding the animation clip to the model

   1. To bind the selected animation clip to your model, you will need a community component called "Animation-play ability."

      

   2. This component can also be found in the Asset Library.

   3. Attach this component to your chosen model and select the animation clip you wish to bind.

      

4. Converting the model into an animator controller

   1. Only an animator controller can play animation clips. Convert your model into an AnimatorController by making it a non-player character (NPC).
   2. This can be done by attaching a Monster component, which designates the model as an NPC.

5. Playing the Animation Create a script and attach it to the model that has been added to your Space.

   Script Setup:

   1. Create an entity for your model in the scene.
   2. Check if the entity is an animator controller, as only animator controllers can play animation clips.

   local _selfEntity = script:SelfEntity()
    if not YaAnimatorAPI.IsAnimatorController(_selfEntity) then
    return
    end
   3. To play the animation clip, retrieve the AnimatorControllerEntity using the entity and call the play function with the name of your animation clip:

   local _animatorControllerEntity = YaAnimatorAPI.Instance(_selfEntity)
   local _handle = _animatorControllerEntity:Play("Wave Hip Hop Dance_Wave Hip Hop Dance")
   4. Set the animation to loop:

   _handle:SetLooping(true)

6. Triggering the animation clip To trigger the animation when certain events occur, add an event listener in your script:

   local _selfEntity = script:SelfEntity()
   function OnAvatarSpawned(playerId, spawnPointEntity, avatarEntity)
       if not YaAnimatorAPI.IsAnimatorController(_selfEntity) then
           return
       end
       local _animatorControllerEntity = YaAnimatorAPI.Instance(_selfEntity)
       local _handle = _animatorControllerEntity:Play("Wave Hip Hop Dance_Wave Hip Hop Dance")
       _handle:SetLooping(true)
   end
   function OnPlayerJoined(playerId)
       local player = YaGame:GetPlayer(playerId)
       EventHelper.AddListener(player, "SpawnedEvent", OnAvatarSpawned)
   end
   EventHelper.AddListener(YaGame, "PlayerJoinedEvent", OnPlayerJoined)

7. Save your script and enter Play Mode to test your setup.