{{tag>dragonscript appbehavior}}
<WRAP youarehere>
[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[dragengine:modules:dragonscript:abstractions|Abstraction Layers: How you want to build your Game]] >> [[dragengine:modules:dragonscript:behavior_elements|Behavior Elements]] >> **GABehaviorShoutConsole**
</WRAP>

====== GABehaviorShoutConsole ======

Game application behavior adding a #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1ShoutConsole.html,ShoutConsole~@# to the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1WindowGameWorld.html,WindowGameWorld~@#. The console is added as overlay panel to the window and transparently overlaps the upper area. If messages are added to the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Utils_1_1Console.html,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.:
<code xml>
<action name='shoutConsole.update'>
  <parameter name='clear'/>
</action>
</code>

====== State Machine Conditions ======

This behavior adds no state machine conditions.

====== State Machine Events ======

This behavior sends no state machine events.

====== Required Behaviors ======

This behavior requires no other behaviors.

====== Optional Behaviors ======

  * [[gabehavior_statemachine|GABehaviorStateMachine]]: Add actions and conditions for state machine to use.

====== API Documentation ======

#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1GABehaviorShoutConsole.html,GABehaviorShoutConsole~@#.

Since DragonScript Module Version ''1.35''

====== Use Cases ======

  * Show log messages on the screen.

====== Live Examples ======

  * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]