Package net.minecraftforge.common.model.animation

Interface IAnimationStateMachine

All Known Implementing Classes:
AnimationStateMachine
public interface IAnimationStateMachine
State machine representing the model animation.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.commons.lang3.tuple.Pair<ModelState,​Iterable<Event>>
    apply​(float time)
    Sample the state and events at the current time.
    String
    currentState()
    Get current state name.
    void
    shouldHandleSpecialEvents​(boolean value)
    Set to true if the machine should handle special events that come from the clips (they start with '!').
    void
    transition​(String newState)
    Transition to a new state.

  • Method Details

    • apply

      org.apache.commons.lang3.tuple.Pair<ModelState,​Iterable<Event>> apply​(float time)
      Sample the state and events at the current time. Event iterable will contain all events that happened from the last invocation of this method, from most to least recent. Event offset is relative to the previous event, and for the first event it's relative to the current time.

    • transition

      void transition​(String newState)
      Transition to a new state.

    • currentState

      String currentState()
      Get current state name.

    • shouldHandleSpecialEvents

      void shouldHandleSpecialEvents​(boolean value)
      Set to true if the machine should handle special events that come from the clips (they start with '!'). Right now only implemented event is "!transition:<state_name>". Default value is true.