ParticleEffectActor (libGDX Core 1.10.0 API)

java.lang.Object
- com.badlogic.gdx.scenes.scene2d.Actor
- - com.badlogic.gdx.scenes.scene2d.ui.ParticleEffectActor

All Implemented Interfaces:

Disposable
```
public class ParticleEffectActor
extends Actor
implements Disposable
```
ParticleEffectActor holds an ParticleEffect to use in Scene2d applications. The particle effect is positioned at 0, 0 in the ParticleEffectActor. Its bounding box is not limited to the size of this actor.

Constructor Summary

Constructors
Constructor and Description
`ParticleEffectActor(FileHandle particleFile, FileHandle imagesDir)`
`ParticleEffectActor(FileHandle particleFile, TextureAtlas atlas)`
`ParticleEffectActor(ParticleEffect particleEffect, boolean resetOnStart)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`act(float delta)` Updates the actor based on time.
`void`	`allowCompletion()`
`void`	`cancel()`
`void`	`dispose()` Releases all resources of this object.
`void`	`draw(Batch batch, float parentAlpha)` Draws the actor.
`ParticleEffect`	`getEffect()`
`boolean`	`isAutoRemove()`
`boolean`	`isResetOnStart()`
`boolean`	`isRunning()`
`ParticleEffectActor`	`setAutoRemove(boolean autoRemove)`
`ParticleEffectActor`	`setResetOnStart(boolean resetOnStart)`
`void`	`start()`

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor
addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clear, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebug, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, hit, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, remove, removeAction, removeCaptureListener, removeListener, rotateBy, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ParticleEffectActor
```
public ParticleEffectActor(ParticleEffect particleEffect,
                           boolean resetOnStart)
```
  - ParticleEffectActor
```
public ParticleEffectActor(FileHandle particleFile,
                           TextureAtlas atlas)
```
  - ParticleEffectActor
```
public ParticleEffectActor(FileHandle particleFile,
                           FileHandle imagesDir)
```
- Method Detail
  - draw
```
public void draw(Batch batch,
                 float parentAlpha)
```
    Description copied from class: Actor
    
    Draws the actor. The batch is configured to draw in the parent's coordinate system. This draw method is convenient to draw a rotated and scaled TextureRegion. Batch.begin() has already been called on the batch. If Batch.end() is called to draw without the batch then Batch.begin() must be called before the method returns.
    The default implementation does nothing.
    
    Overrides:
    
    draw in class Actor
    
    parentAlpha - The parent alpha, to be multiplied with this actor's alpha, allowing the parent's alpha to affect all children.
  - act
```
public void act(float delta)
```
    Description copied from class: Actor
    
    Updates the actor based on time. Typically this is called each frame by Stage.act(float).
    The default implementation calls Action.act(float) on each action and removes actions that are complete.
    
    Overrides:
    
    act in class Actor
    
    Parameters:
    
    delta - Time in seconds since the last frame.
  - start
```
public void start()
```
  - isResetOnStart
```
public boolean isResetOnStart()
```
  - setResetOnStart
```
public ParticleEffectActor setResetOnStart(boolean resetOnStart)
```
  - isAutoRemove
```
public boolean isAutoRemove()
```
  - setAutoRemove
```
public ParticleEffectActor setAutoRemove(boolean autoRemove)
```
  - isRunning
```
public boolean isRunning()
```
  - getEffect
```
public ParticleEffect getEffect()
```
  - cancel
```
public void cancel()
```
  - allowCompletion
```
public void allowCompletion()
```
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Releases all resources of this object.
    
    Specified by:
    
    dispose in interface Disposable

Class ParticleEffectActor

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ParticleEffectActor

ParticleEffectActor

ParticleEffectActor

Method Detail

draw

act

start

isResetOnStart

setResetOnStart

isAutoRemove

setAutoRemove

isRunning

getEffect

cancel

allowCompletion

dispose