IndigoDemo

trait IndigoDemo[BootData, StartUpData, Model, ViewModel] extends GameLauncher

A trait representing a minimal set of functions to get your game running

Type Params
BootData

The class type representing you a successful game boot up

Model

The class type representing your game's model

StartUpData

The class type representing your successful startup data

ViewModel

The class type representing your game's view model

Example

object MyGame extends IndigoDemo[BootData, StartUpData, Model, ViewModel]

class Object
trait Matchable
class Any

Value members

Abstract methods

def boot(flags: Map[String, String]): Outcome[BootResult[BootData]]

boot provides the initial boot up function for your game, accepting commandline-like arguments and allowing you to declare pre-requist assets assets and data that must be in place for your game to get going.

boot provides the initial boot up function for your game, accepting commandline-like arguments and allowing you to declare pre-requist assets assets and data that must be in place for your game to get going.

Value Params
flags

A simply key-value object/map passed in during initial boot.

Returns

Bootup data consisting of a custom data type, animations, subsytems, assets, fonts, and the game's config.

Event filters represent a mapping from events to possible events, and act like a firewall to prevent unnecessary event processing by the model or view model.

Event filters represent a mapping from events to possible events, and act like a firewall to prevent unnecessary event processing by the model or view model.

def initialModel(startupData: StartUpData): Outcome[Model]

Set up of your initial model state

Set up of your initial model state

Value Params
startupData

Access to Startup data in case you need it for the model

Returns

An instance of your game model

def initialViewModel(startupData: StartUpData, model: Model): Outcome[ViewModel]

Set up of your initial view model state

Set up of your initial view model state

Value Params
startupData

Access to Startup data in case you need it for the view model

Returns

An instance of your game's view model

def present(context: FrameContext[StartUpData], model: Model, viewModel: ViewModel): Outcome[SceneUpdateFragment]

A pure function for presenting your game. The result is a side effect free declaration of what you intend to be presented to the player next.

A pure function for presenting your game. The result is a side effect free declaration of what you intend to be presented to the player next.

Value Params
context

The context the frame should be produced in, including the time, input state, a dice instance, the state of the inputs, and a read only reference to your start up data.

model

The latest version of the model to read from.

viewModel

The latest version of the view model to read from.

Returns

A function that produces a description of what to present next, and encapsuates failures or resulting events within the Outcome wrapper.

def setup(bootData: BootData, assetCollection: AssetCollection, dice: Dice): Outcome[Startup[StartUpData]]

The setup function is your only opportunity to do an initial work to set up your game. For example, perhaps one of your assets was a JSON description of a map or an animation sequence, you could process that now, which is why you have access to the AssetCollection object. setup is typically only called when new assets are loaded. In a simple game this may only be once, but if assets are dynamically loaded, set up will be called again.

The setup function is your only opportunity to do an initial work to set up your game. For example, perhaps one of your assets was a JSON description of a map or an animation sequence, you could process that now, which is why you have access to the AssetCollection object. setup is typically only called when new assets are loaded. In a simple game this may only be once, but if assets are dynamically loaded, set up will be called again.

Value Params
assetCollection

Access to the Asset collection in order to, for example, parse text files.

bootData

Data created during initial game boot.

dice

Psuedorandom number generator

Returns

Return start up data, which can include animations and fonts that could not be declared at boot time.

def updateModel(context: FrameContext[StartUpData], model: Model): GlobalEvent => Outcome[Model]

A pure function for updating your game's model in the context of the running frame and the events acting upon it.

A pure function for updating your game's model in the context of the running frame and the events acting upon it.

Value Params
context

The context the frame should be produced in, including the time, input state, a dice instance, the state of the inputs, and a read only reference to your start up data.

model

The latest version of the model to read from.

Returns

A function that maps GlobalEvent's to the next version of your model, and encapsuates failures or resulting events within the Outcome wrapper.

def updateViewModel(context: FrameContext[StartUpData], model: Model, viewModel: ViewModel): GlobalEvent => Outcome[ViewModel]

A pure function for updating your game's view model in the context of the running frame and the events acting upon it.

A pure function for updating your game's view model in the context of the running frame and the events acting upon it.

Value Params
context

The context the frame should be produced in, including the time, input state, a dice instance, the state of the inputs, and a read only reference to your start up data.

model

The latest version of the model to read from.

viewModel

The latest version of the view model to read from.

Returns

A function that maps GlobalEvent's to the next version of your view model, and encapsuates failures or resulting events within the Outcome wrapper.

Concrete methods

@SuppressWarnings(scala.Array.apply[java.lang.String]("scalafix:DisableSyntax.throw")(scala.reflect.ClassTag.apply[java.lang.String](classOf[java.lang.String])))
final protected def ready(flags: Map[String, String]): Unit

Inherited methods

@JSExport
def launch(flags: Dictionary[String]): Unit
Inherited from
GameLauncher
@JSExport
def launch(): Unit
Inherited from
GameLauncher