StateHelper (LionEngine Helper 9.0.4 API)

java.lang.Object
- com.b3dgs.lionengine.game.feature.state.StateAbstract
- - com.b3dgs.lionengine.helper.StateHelper<M>

Type Parameters:

M - The model feature.

All Implemented Interfaces:

State, TileCollidableListener, Updatable
```
public class StateHelper<M extends EntityModelHelper>
extends StateAbstract
implements TileCollidableListener
```
State base implementation.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Animatable`	`animatable` Animator reference.
`protected Animation`	`animation` State animation data.
`protected Body`	`body` Body reference.
`protected Collidable`	`collidable` Collidable reference.
`protected InputDeviceControl`	`input` Input control reference.
`protected Mirrorable`	`mirrorable` Mirrorable reference.
`protected M`	`model` Entity model reference.
`protected Rasterable`	`rasterable` Rasterable reference.
`protected TileCollidable`	`tileCollidable` Tile collidable reference.
`protected Transformable`	`transformable` Transformable reference.

Constructor Summary

Constructors
Modifier Constructor and Description

protected StateHelper(M model, Animation animation)
Create the state.

Constructors
Modifier	Constructor and Description
`protected`	`StateHelper(M model, Animation animation)` Create the state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enter()`
`void`	`exit()`
`protected boolean`	`is(AnimState state)` Check if is anim state.
`protected boolean`	`is(Mirror mirror)` Check if is current mirror state.
`protected boolean`	`isChangingDirectionHorizontal(Force force)` Check if checking horizontal direction side.
`protected boolean`	`isCollideX()` Check if horizontal collide.
`protected boolean`	`isCollideY()` Check if vertical collide.
`protected boolean`	`isFire(Integer index)` Check if fire button is enabled.
`protected boolean`	`isFireOnce(Integer index)` Check if fire button is enabled once.
`protected boolean`	`isGo()` Check if going somewhere.
`protected boolean`	`isGoDown()` Check if going down.
`protected boolean`	`isGoDownOnce()` Check if going down one time.
`protected boolean`	`isGoHorizontal()` Check if going horizontally in any way.
`protected boolean`	`isGoLeft()` Check if going left.
`protected boolean`	`isGoLeftOnce()` Check if going left once.
`protected boolean`	`isGoNone()` Check if going nowhere.
`protected boolean`	`isGoRight()` Check if going right.
`protected boolean`	`isGoRightOnce()` Check if going right once.
`protected boolean`	`isGoUp()` Check if going up.
`protected boolean`	`isGoUpOnce()` Check if going up one time.
`protected boolean`	`isGoVertical()` Check if going vertically in any way.
`protected void`	`mirrorHorizontal()` Perform horizontal mirroring.
`void`	`notifyTileCollided(CollisionResult result, CollisionCategory category)`
`protected void`	`onCollided(CollisionResult result, CollisionCategory category)` Called on collided.
`void`	`update(double extrp)`
`protected void`	`updateMirrorHorizontal()` Update mirror on horizontal axis (perform mirror when going on the opposite side).
`protected void`	`updateMirrorVertical()` Update mirror on vertical axis (perform mirror when going on the opposite side).

Methods inherited from class com.b3dgs.lionengine.game.feature.state.StateAbstract
addTransition, checkTransitions, clearTransitions, postUpdate

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

- Field Detail
  - model
```
protected final M extends EntityModelHelper model
```
    Entity model reference.
  - animation
```
protected final Animation animation
```
    State animation data.
  - input
```
protected final InputDeviceControl input
```
    Input control reference.
  - transformable
```
protected final Transformable transformable
```
    Transformable reference.
  - mirrorable
```
protected final Mirrorable mirrorable
```
    Mirrorable reference.
  - rasterable
```
protected final Rasterable rasterable
```
    Rasterable reference.
  - body
```
protected final Body body
```
    Body reference.
  - animatable
```
protected final Animatable animatable
```
    Animator reference.
  - tileCollidable
```
protected final TileCollidable tileCollidable
```
    Tile collidable reference.
  - collidable
```
protected final Collidable collidable
```
    Collidable reference.
- Constructor Detail
  - StateHelper
```
protected StateHelper(M model,
                      Animation animation)
```
    Create the state.
    
    Parameters:
    
    model - The model reference.
    
    animation - The animation reference.
- Method Detail
  - onCollided
```
protected void onCollided(CollisionResult result,
                          CollisionCategory category)
```
    Called on collided.
    
    Parameters:
    
    result - The collided tile.
    
    category - The collided axis.
  - mirrorHorizontal
```
protected void mirrorHorizontal()
```
    Perform horizontal mirroring.
  - updateMirrorHorizontal
```
protected void updateMirrorHorizontal()
```
    Update mirror on horizontal axis (perform mirror when going on the opposite side).
  - updateMirrorVertical
```
protected void updateMirrorVertical()
```
    Update mirror on vertical axis (perform mirror when going on the opposite side).
  - is
```
protected final boolean is(AnimState state)
```
    Check if is anim state.
    
    Parameters:
    
    state - The expected anim state.
    
    Returns:
    
    true if is state, false else.
  - is
```
protected final boolean is(Mirror mirror)
```
    Check if is current mirror state.
    
    Parameters:
    
    mirror - The expected mirror to be.
    
    Returns:
    
    true if is mirror, false else.
  - isGo
```
protected final boolean isGo()
```
    Check if going somewhere.
    
    Returns:
    
    true if not going to move, false else.
  - isGoNone
```
protected final boolean isGoNone()
```
    Check if going nowhere.
    
    Returns:
    
    true if not going to move, false else.
  - isGoHorizontal
```
protected final boolean isGoHorizontal()
```
    Check if going horizontally in any way.
    
    Returns:
    
    true if going to left or right, false else.
  - isGoLeft
```
protected final boolean isGoLeft()
```
    Check if going left.
    
    Returns:
    
    true if going to left, false else.
  - isGoRight
```
protected final boolean isGoRight()
```
    Check if going right.
    
    Returns:
    
    true if going to right, false else.
  - isGoVertical
```
protected final boolean isGoVertical()
```
    Check if going vertically in any way.
    
    Returns:
    
    true if going to up or down, false else.
  - isGoUp
```
protected final boolean isGoUp()
```
    Check if going up.
    
    Returns:
    
    true if going to up, false else.
  - isGoDown
```
protected final boolean isGoDown()
```
    Check if going down.
    
    Returns:
    
    true if going to down, false else.
  - isGoUpOnce
```
protected final boolean isGoUpOnce()
```
    Check if going up one time.
    
    Returns:
    
    true if going to up, false else.
  - isGoDownOnce
```
protected final boolean isGoDownOnce()
```
    Check if going down one time.
    
    Returns:
    
    true if going to down, false else.
  - isGoLeftOnce
```
protected final boolean isGoLeftOnce()
```
    Check if going left once.
    
    Returns:
    
    true if going to left, false else.
  - isGoRightOnce
```
protected final boolean isGoRightOnce()
```
    Check if going right once.
    
    Returns:
    
    true if going to right, false else.
  - isFire
```
protected final boolean isFire(Integer index)
```
    Check if fire button is enabled.
    
    Parameters:
    
    index - The button index (must not be null, must be positive).
    
    Returns:
    
    true if active, false else.
  - isFireOnce
```
protected final boolean isFireOnce(Integer index)
```
    Check if fire button is enabled once.
    
    Parameters:
    
    index - The button index (must not be null, must be positive).
    
    Returns:
    
    true if active, false else.
  - isChangingDirectionHorizontal
```
protected final boolean isChangingDirectionHorizontal(Force force)
```
    Check if checking horizontal direction side.
    
    Parameters:
    
    force - The force reference.
    
    Returns:
    
    true if going to the opposite, false else.
  - isCollideX
```
protected final boolean isCollideX()
```
    Check if horizontal collide.
    
    Returns:
    
    true if horizontal collide, false else.
  - isCollideY
```
protected final boolean isCollideY()
```
    Check if vertical collide.
    
    Returns:
    
    true if vertical collide, false else.
  - enter
```
public void enter()
```
    Specified by:
    
    enter in interface State
  - update
```
public void update(double extrp)
```
    Specified by:
    
    update in interface Updatable
  - exit
```
public void exit()
```
    Specified by:
    
    exit in interface State
    
    Overrides:
    
    exit in class StateAbstract
  - notifyTileCollided
```
public void notifyTileCollided(CollisionResult result,
                               CollisionCategory category)
```
    Specified by:
    
    notifyTileCollided in interface TileCollidableListener

Class StateHelper<M extends EntityModelHelper>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.b3dgs.lionengine.game.feature.state.StateAbstract

Methods inherited from class java.lang.Object

Field Detail

model

animation

input

transformable

mirrorable

rasterable

body

animatable

tileCollidable

collidable

Constructor Detail

StateHelper

Method Detail

onCollided

mirrorHorizontal

updateMirrorHorizontal

updateMirrorVertical

is

is

isGo

isGoNone

isGoHorizontal

isGoLeft

isGoRight

isGoVertical

isGoUp

isGoDown

isGoUpOnce

isGoDownOnce

isGoLeftOnce

isGoRightOnce

isFire

isFireOnce

isChangingDirectionHorizontal

isCollideX

isCollideY

enter

update

exit

notifyTileCollided