Engine API Reference - v2.23.0-beta.17
    Preparing search index...

    Class AnimEvents

    AnimEvents stores a sorted array of animation events which should fire sequentially during the playback of an AnimTrack. Each event is an object with a name and a time in seconds plus any extra properties you attach. When playback passes an event's time it is fired on the AnimComponent under the event's name, so a script listens with entity.anim.on('footstep', callback) and receives the event object.

    Index
    • Create a new AnimEvents instance.

      Parameters

      • events: any[]

        An array of animation events.

      Returns AnimEvents

      const events = new AnimEvents([
      {
      name: 'my_event',
      time: 1.3, // given in seconds
      // any additional properties added are optional and will be available in the EventHandler callback's event object
      myProperty: 'test',
      myOtherProperty: true
      }
      ]);
      animTrack.events = events;