Module me.stringdotjar.flixelgdx.core

Package me.stringdotjar.flixelgdx

Class FlixelSubState

java.lang.Object

me.stringdotjar.flixelgdx.FlixelBasic

me.stringdotjar.flixelgdx.group.FlixelBasicGroup<FlixelBasic>

me.stringdotjar.flixelgdx.FlixelState

me.stringdotjar.flixelgdx.FlixelSubState

All Implemented Interfaces:

com.badlogic.gdx.Screen, com.badlogic.gdx.utils.Disposable, com.badlogic.gdx.utils.Pool.Poolable, FlixelDestroyable, FlixelDrawable, FlixelUpdatable, FlixelBasicGroupable<FlixelBasic>, FlixelGroupable<FlixelBasic>

public abstract class FlixelSubState
extends FlixelState

A FlixelSubState can be opened inside a FlixelState. By default, it stops the parent state from updating, making it convenient for pause screens or menus.

The parent state's FlixelState.persistentUpdate and FlixelState.persistentDraw flags control whether it continues to update and draw while this substate is active.

Substates can be nested: a substate can open another substate on top of itself.

Field Summary

Fields

Modifier and Type	Field	Description
Runnable	closeCallback	Called when this substate is closed.
Runnable	openCallback	Called when this substate is opened or resumed.

Fields inherited from class me.stringdotjar.flixelgdx.FlixelState

destroySubStates, persistentDraw, persistentUpdate

Fields inherited from class me.stringdotjar.flixelgdx.FlixelBasic

active, alive, cameras, exists, ID, visible

Constructor Summary

Constructors

Constructor	Description
FlixelSubState()	Creates a new substate with a clear background.
FlixelSubState(com.badlogic.gdx.graphics.Color bgColor)	Creates a new substate with the given background color.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this substate by telling the parent state to remove it.
String	toString()

Methods inherited from class me.stringdotjar.flixelgdx.FlixelState

add, closeSubState, create, destroy, draw, getBgColor, getSubState, hide, openSubState, pause, recycle, render, resetSubState, resize, resume, setBgColor, show, startOutro, update

Methods inherited from class me.stringdotjar.flixelgdx.group.FlixelBasicGroup

clear, ensureMembers, getMaxSize, getMembers, remove, setMaxSize

Methods inherited from class me.stringdotjar.flixelgdx.FlixelBasic

dispose, kill, reset, revive

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface me.stringdotjar.flixelgdx.group.FlixelBasicGroupable

getFirstDead, removeMember

Methods inherited from interface me.stringdotjar.flixelgdx.group.FlixelGroupable

detach, forEachMember, forEachMemberType, getFirstNullIndex

Methods inherited from interface com.badlogic.gdx.Screen

dispose

Field Details

openCallback

public Runnable openCallback

Called when this substate is opened or resumed.

closeCallback

public Runnable closeCallback

Called when this substate is closed.

Constructor Details

FlixelSubState

public FlixelSubState()

Creates a new substate with a clear background.

FlixelSubState

public FlixelSubState(com.badlogic.gdx.graphics.Color bgColor)

Creates a new substate with the given background color.

Parameters:

bgColor - The background color for this substate.

Method Details

close

public void close()

Closes this substate by telling the parent state to remove it.

toString

public String toString()

Overrides:

toString in class FlixelState