Game app behavior running a state machine (*.desm) on the BaseGameApp. The state machine is loaded from the application configuration and runs for the whole lifetime of the application. Other game app behaviors and state machines can add actions and conditions to it to control the application flow, for example showing logos, changing input processors or quitting the engine.

The class works similar to ECBehaviorStateMachine.

The state machine is configured in the application configuration file like this example:

<parameterTree>
    <string path='appBehavior/stateMachine/path'>/content/statemachines/game.desm</string>
    <string path='appBehavior/stateMachine/debug'>SM-Game</string>
</parameterTree>

Multiple instances can be added to the application using an identifier. If the path is not set or the file is missing an empty state machine is used.

To access this behavior from other application behaviors use GABehaviorStateMachine.getBehaviorInApp(). If more than one state machine is used use GABehaviorStateMachine.getBehaviorInApp(id) with the identifier of the desired state machine. Add actions and conditions in the initGame() function.

The state machine is configured in the application configuration file using these keys:

Set path to state machine file to load.

• Full name: appBehavior/stateMachine/path or appBehavior/stateMachine({id})/path
• Type: string
• Default Value: empty string
• Expected File Type: *.desm
• Example (*.deeclass)

  <string path='appBehavior/stateMachine/path'>/content/statemachines/game/game.desm</string>

Enable debug logging for the state machine using the given logging name.

• Full name: appBehavior/stateMachine/debug or appBehavior/stateMachine({id})/debug
• Type: string
• Default Value: <null>
• Example (*.deeclass)

  <string path='appBehavior/stateMachine/debug'>SM-Game</string>

This behavior runs these state machine events.

Run after all game app behaviors have initialized.

Run once when all game service initialization has finished.

Run every frame. The event parameter is the elapsed time in seconds.

Run when the application window has been activated.

Run when the application window has been deactivated.

This behavior adds these state machine actions.

Update game engine parameters and run game engine actions.

This is an example of using this action to reset timers after lengthy loading:

<action name='engine.update'>
  <parameter name='resetTimers'/>
</action>

Update application parameters and run application actions.

This is an example of using this action to set input processing to bindings:

<action name='app.update'>
  <parameter name='inputProcessor'>bindings</parameter>
</action>

Update window logo parameters and run window logo actions. Allows to show logos as typically done on game start up. The logo window is faded in, stays a short time, then fades out again.

This is an example of using this action to show an image logo:

<action name='windowLogo.update'>
  <parameter name='show'>image</parameter>
  <parameter name='image'>/content/logo.avif</parameter>
  <parameter name='sound'>/content/logo.ogg</parameter>
  <parameter name='event'>logo finished</parameter>
</action>

Set WindowGameWorld parameters.

This is an example of using this action to hide the WindowGameWorld:

<action name='windowGameWorld.set'>
  <parameter name='visible'>false</parameter>
</action>

Update WindowGameWorld parameters and run WindowGameWorld actions.

This is an example of using this action:

<action name='windowGameWorld.update'>
  <parameter name='runEvent'>inventory closed</parameter>
</action>

This behavior adds these state machine conditions.

Evaluate engine parameters.

This is an example of using this condition to check if a game service is supported and can be used (in this example modding using Mod.io):

<action name='myAction'>
  <condition>engine.check</condition>
  <parameter name='engine.supportsService'>Mod.io</parameter>
</action>

Evaluate application parameters. app.config. checks BaseGameApp.getConfiguration(). app.setting. checks BaseGameApp.getSettings(). Configuration and setting values can be various data types. These comparisons require boolean and integer values. Other values fail the test if their toString() implementation does not produce a value convertible to an integer value or boolean value (true, false). If you just want to test for equality you can use string type too.

This is an example of using this condition to check a string configuration value:

<action name='myAction'>
  <condition>app.check</condition>
  <parameter name='app.config'>game/mode</parameter>
  <parameter name='app.config.equal'>multiplayer</parameter>
</action>

This is an example of using this condition to check an integer configuration value:

<action name='myAction'>
  <condition>app.check</condition>
  <parameter name='app.config'>game/maxPlayers</parameter>
  <parameter name='app.config.lessOrEqual'>2</parameter>
</action>

Evaluate WindowGameWorld parmaeters.

This is an example of using this condition:

<action name='myAction'>
  <condition>windowGameWorld.check</condition>
  <parameter name='visible'>true</parameter>
</action>

This behavior requires no other behaviors.

This behavior does not support optional behaviors.

GABehaviorStateMachine.

Since DragonScript Module Version 1.35

• Drive higher level application logic using state machine.
• Drive UI interaction using state machine.

• DEExamples Repository