com.badlogic.gdx.scenes.scene2d.actions

Class DelegateAction

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Action

com.badlogic.gdx.scenes.scene2d.actions.DelegateAction

All Implemented Interfaces:

Pool.Poolable

Direct Known Subclasses:

AfterAction, DelayAction, RepeatAction, TimeScaleAction

public abstract class DelegateAction
extends Action

Base class for an action that wraps another action.

Field Summary

Fields

Modifier and Type	Field and Description
protected Action	action

Fields inherited from class com.badlogic.gdx.scenes.scene2d.Action

actor, target

Constructor Summary

Constructors

Constructor and Description
DelegateAction()

Method Summary

Modifier and Type	Method and Description
boolean	act(float delta) Updates the action based on time.
protected abstract boolean	delegate(float delta)
Action	getAction()
void	reset() Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused.
void	restart() Sets the state of the action so it can be run again.
void	setAction(Action action) Sets the wrapped action.
void	setActor(Actor actor) Sets the actor this action is attached to.
void	setTarget(Actor target) Sets the actor this action will manipulate.
java.lang.String	toString()

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Action

getActor, getPool, getTarget, setPool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

action

protected Action action

Constructor Detail

DelegateAction

public DelegateAction()

Method Detail

setAction

public void setAction(Action action)

Sets the wrapped action.

getAction

public Action getAction()

delegate

protected abstract boolean delegate(float delta)

act

public final boolean act(float delta)

Description copied from class: Action

Updates the action based on time. Typically this is called each frame by Actor.act(float).

Specified by:

act in class Action

Parameters:

delta - Time in seconds since the last frame.

Returns:

true if the action is done. This method may continue to be called after the action is done.

restart

public void restart()

Description copied from class: Action

Sets the state of the action so it can be run again.

Overrides:

restart in class Action

reset

public void reset()

Description copied from class: Action

Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused. State required to be set for every usage of this action or computed during the action does not need to be reset.

The default implementation calls Action.restart().

If a subclass has optional state, it must override this method, call super, and reset the optional state.

Specified by:

reset in interface Pool.Poolable

Overrides:

reset in class Action

setActor

public void setActor(Actor actor)

Description copied from class: Action

Sets the actor this action is attached to. This also sets the target actor if it is null. This method is called automatically when an action is added to an actor. This method is also called with null when an action is removed from an actor.

When set to null, if the action has a pool then the action is returned to the pool (which calls Action.reset()) and the pool is set to null. If the action does not have a pool, Action.reset() is not called.

This method is not typically a good place for an action subclass to query the actor's state because the action may not be executed for some time, eg it may be delayed. The actor's state is best queried in the first call to Action.act(float). For a TemporalAction, use TemporalAction#begin().

Overrides:

setActor in class Action

setTarget

public void setTarget(Actor target)

Description copied from class: Action

Sets the actor this action will manipulate. If no target actor is set, Action.setActor(Actor) will set the target actor when the action is added to an actor.

Overrides:

setTarget in class Action

toString

public java.lang.String toString()

Overrides:

toString in class Action