Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ActionComponent

[20:7] extends: Component

Wraps FXGL's ActionComponent (com.almasb.fxgl.entity.action.ActionComponent), the queue-of- Actions controller that drives an entity through a sequence of behaviors. Add Action subclasses (instant, continuous, idle) and the component runs them in FIFO order each frame. Authoring new Action subclasses from Aussom requires a Java bridge (see CancelPolicy + IdleAction for the pre-built helpers); the wrapper here drives existing Actions through the component's queue.

Methods

  • ActionComponent ()

    Creates a new ActionComponent.

  • adopt (object Ajo)

    Wraps an existing ActionComponent AussomJavaObject.

  • addAction (object ActionObj)

    Adds an Action to the queue.

  • removeAction (object ActionObj)

    Removes a queued Action.

  • cancelActions ()

    Cancels every queued Action according to the cancel policy.

  • actionsProperty ()

    Returns the actions ObservableList AJO.

  • getCurrentAction ()

    Returns the currently running Action AJO.

  • getNextAction ()

    Returns the next queued Action AJO.

  • isIdle ()

    Returns whether the queue is empty.

  • hasNextActions ()

    Returns whether there are pending queued actions.

  • getCancelPolicy ()

    Returns the cancel policy name ("ONE" or "ALL").

  • setCancelPolicy (string PolicyName)

    Sets the cancel policy.

    • @p PolicyName is "ONE" (cancel just the current action) or "ALL" (cancel every queued action).
    • @r this object