libGDX 1.14.2 · com.badlogic.gdx.scenes.scene2d.Action

Modifier and Type	Field and Description
protected Actor	actor The actor this action is attached to, or null if it is not attached.
private Pool<T>	pool
protected Actor	target The actor this action targets, or null if a target has not been set.

Access	Constructor and Description
public	Action()

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: true if the action is done. This method may continue to be called after the action is done. act(float Time in seconds since the last frame. delta) Updates the action based on time.
public Actor	getActor() Returns: null if the action is not attached to an actor.
public Pool<T>	getPool()
public Actor	getTarget() Returns: null if the action has no target.
public void	reset() Implements com.badlogic.gdx.utils.Pool.Poolable.reset. Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused.
public void	restart() Sets the state of the action so it can be run again.
public void	setActor(Actor actor) Sets the actor this action is attached to.
public void	setPool(Pool<T> May be null. pool) Sets the pool that the action will be returned to when removed from the actor.
public void	setTarget(Actor target) Sets the actor this action will manipulate.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

actor	back to summary
protected Actor actor The actor this action is attached to, or null if it is not attached.

pool	back to summary
private Pool<T> pool Annotations @Null

target	back to summary
protected Actor target The actor this action targets, or null if a target has not been set.

Action	back to summary
public Action()

Method Detail

act back to summary

act	back to summary
public abstract boolean act(float delta) Updates the action based on time. Typically this is called each frame by `Actor#act(float)`. Parameters delta:float Time in seconds since the last frame. Returns:boolean true if the action is done. This method may continue to be called after the action is done.

public abstract boolean act(float delta)

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

Parameters

delta:float: Time in seconds since the last frame.

Returns:boolean

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

getActor	back to summary
public Actor getActor() Returns:Actor null if the action is not attached to an actor.

getPool	back to summary
public Pool<T> getPool() Annotations @Null

getTarget	back to summary
public Actor getTarget() Returns:Actor null if the action has no target.

reset back to summary

reset	back to summary
public void reset() Implements com.badlogic.gdx.utils.Pool.Poolable.reset. 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 `restart()`. If a subclass has optional state, it must override this method, call super, and reset the optional state.

public void reset()

Implements com.badlogic.gdx.utils.Pool.Poolable.reset.

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 restart().

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

restart	back to summary
public void restart() Sets the state of the action so it can be run again.

setActor back to summary

setActor	back to summary
public void setActor(Actor actor) 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 `reset()`) and the pool is set to null. If the action does not have a pool, `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 `act(float)`. For a `TemporalAction`, use TemporalAction#begin().

public void setActor(Actor actor)

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 reset()) and the pool is set to null. If the action does not have a pool, 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 act(float). For a TemporalAction, use TemporalAction#begin().

setPool back to summary

setPool	back to summary
public void setPool(Pool<T> pool) Sets the pool that the action will be returned to when removed from the actor. Parameters pool:Pool<T> May be null. See Also `setActor(Actor)`

public void setPool(Pool<T> pool)

Sets the pool that the action will be returned to when removed from the actor.

Parameters

pool:Pool<T>: May be null.

See Also

setActor(Actor)

setTarget	back to summary
public void setTarget(Actor target) Sets the actor this action will manipulate. If no target actor is set, `setActor(Actor)` will set the target actor when the action is added to an actor.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

public abstract Class Action

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail