libgdx API

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

java.lang.Object
  extended by com.badlogic.gdx.scenes.scene2d.Action
      extended by com.badlogic.gdx.scenes.scene2d.actions.DelegateAction
All Implemented Interfaces:
Pool.Poolable
Direct Known Subclasses:
AfterAction, DelayAction, RepeatAction

public abstract class DelegateAction
extends Action

Base class for an action that wraps another action.

Author:
Nathan Sweet

Field Summary
protected  Action action
           
 
Fields inherited from class com.badlogic.gdx.scenes.scene2d.Action
actor
 
Constructor Summary
DelegateAction()
           
 
Method Summary
 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 will be used for.
 java.lang.String toString()
           
 
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Action
act, getActor, getPool, 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()

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 will be used for. This is called automatically when an action is added to an actor. This 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 called.

This method is not typically a good place for a 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

toString

public java.lang.String toString()
Overrides:
toString in class Action

libgdx API

Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)