This is an old revision of the document!
Table of Contents
Start Page » DragonScript Scripting Language » Abstraction Layers: How you want to build your Game » Behavior Elements » GABehaviorShoutConsole
GABehaviorShoutConsole
Game application behavior adding a ShoutConsole to the WindowGameWorld. The console is added as overlay panel to the window and transparently overlaps the upper area. If messages are added to the Console the message is briefly shown then hidden.
To access this behavior from other application behaviors use GABehaviorShoutConsole.getBehaviorInApp().
State Machine Actions
This behavior adds these state machine actions.
shoutConsole.update
Update shout console parameters and run shout console actions.
| Parameter | Value | Description |
|---|---|---|
| addToWindow | Add the console to the current game world window. The console is only added if it is not already in that window. Use this if you assigned a new game world window. | |
| clear | Clear the console. | |
| visible | true, false | Show or hide the console. |
This is an example of using this action to clear the panel, for example after initializing the game potentially showing unrelated messages.:
<action name='shoutConsole.update'> <parameter name='clear'/> </action>
Required Behaviors
This behavior requires no other behaviors.
Optional Behaviors
- GABehaviorStateMachine: Add actions and conditions for state machine to use.
API Documentation
Since DragonScript Module Version 1.35
Use Cases
- Show log messages on the screen.
Live Examples
