Table of Contents

Class InGameBase

Namespace
FrameOfReference.States
Assembly
FrameOfReference.dll

Common base for states with an active InGamePresenter and pause support.

public abstract class InGameBase : SessionStateBase, IGameState, IDisposable
Inheritance
object
InGameBase
Implements
Derived
Inherited Members

Constructors

InGameBase(Game, Session)

protected InGameBase(Game game, Session session)

Parameters

game Game
session Session

Fields

_presenter

protected readonly InGamePresenter _presenter

Field Value

InGamePresenter

Properties

HudDialog

protected abstract string HudDialog { get; }

Property Value

string

Methods

BindLua(Lua)

Registers state-specific values in the given Lua environment.

[LuaHide]
public override void BindLua(Lua lua)

Parameters

lua Lua

Dispose()

[LuaHide]
public override void Dispose()

Enter()

Called when this state becomes the active state.

[LuaHide]
public override void Enter()

Exit()

Called when this state is no longer the active state.

[LuaHide]
public override void Exit()

OnPresenterInitialized()

protected virtual void OnPresenterInitialized()

TogglePause()

Toggles between gameplay and the pause menu.

public void TogglePause()

Update(double)

Advances the state by elapsedTime seconds of real time. Called once per frame before rendering.

[LuaHide]
public override double Update(double elapsedTime)

Parameters

elapsedTime double

Returns

double

The amount of game time that has passed. Drives time-based visual effects.