Interface State

Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1884–1916

* The object can take 5 states: OnFloor, Falling, Jumping, GrabbingPlatform and OnLadder. * The implementations of this interface hold the specific behaviors and internal state of theses 5 states. * @see PlatformerObjectRuntimeBehavior.doStepPreEvents to understand how the functions are called

   * @see PlatformerObjectRuntimeBehavior.doStepPreEvents to understand how the functions are called.
   */
  interface State {
    /**
     * Called when the object leaves this state.
     * It's a good place to reset the internal state.
     * @see OnFloor.enter that is not part of the interface because it takes specific parameters.
     */
    leave(): void;
    /**
     * Called before the obstacle search.
     * The object position may need adjustments to handle external changes.
     */
    beforeUpdatingObstacles(timeDelta: float): void;
    /**
     * Check if transitions to other states are needed and apply them before moving horizontally.
     */
    checkTransitionBeforeX(): void;
    /**
     * Use _requestedDeltaX and _requestedDeltaY to choose the movement that suits the state before moving horizontally.
     */
    beforeMovingX(): void;
    /**
     * Check if transitions to other states are needed and apply them before moving vertically.
     */
    checkTransitionBeforeY(timeDelta: float): void;
    /**
     * Use _requestedDeltaY to choose the movement that suits the state before moving vertically.
     */
    beforeMovingY(timeDelta: float, oldX: float): void;

    getNetworkSyncData(): StateNetworkSyncData;

    updateFromNetworkSyncData(syncData: StateNetworkSyncData): void;
  }

  /**
   * The object is on the floor standing or walking.