User Tools

Site Tools


dragengine:modules:dragonscript:behavior_showmessage

ECBehaviorShowMessage

Behavior element behavior showing message to player if triggered. The message is shown each time the trigger evaluates to true.

By default message is printed on console. Typically a shout panel is used to show the latest console messages for a short time. Optionally you can also use subtitle instead.

Instance Counts

This behavior can be used multiple times on an element to show different messages. Use the behavior identifier to tell them apart.

Element Class Properties

Element class properties have the prefix showMessage. or showMessage({id}). if id is not empty.

trigger

Set trigger. Message is shown if trigger evaluates to true.

  • Full name: showMessage.trigger or showMessage({id}).trigger
  • Type: string
  • Default Value: state of enabled
  • Example (*.deeclass)
    <string name='showMessage.trigger'>@switchOnVent & @powerEnabled</string>

message

Set message.

  • Full name: showMessage.message or showMessage({id}).message
  • Type: string
  • Default Value: empty string
  • Example (*.deeclass)
    <string name='showMessage.message'>You touched me!</string>

Events

This behavior has no events.

Required Behaviors

This behavior requires no other behaviors.

Optional Behaviors

This behavior does not support optional behaviors.

Persistency

This behavior does support element class to be persistable (setPersistable). Saves selected color.

API Documentation

ECBehaviorShowMessage.

Since DragonScript Module Version 1.0

Use Cases

  • Show message on console if player touches a trigger.

Element Class Example

This example defines an element which shows message if player touches a trigger.

class MyElement extends BehaviorElementClass
  public var ECBehaviorShowMessage showMessage
  func new()
    showMessage = ECBehaviorShowMessage.new(this)
  end
end

Behavior Factory

Using element class supporting adding behaviors the behavior can be added like this:

<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBehaviorShowMessage'>
    <!-- optional: use BaseGameApp trigger table. game can add more supported values.
                   default is 'default' -->
    <string name='triggerTable'>default</string>
 
    <!-- optional: use BaseGameApp console. game can add more supported values.
                   default is 'default' -->
    <string name='console'>default</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.message'>You touched me!</string>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorShowMessage' id='second'/>
</elementClass>

Live Examples

You could leave a comment if you were logged in.
dragengine/modules/dragonscript/behavior_showmessage.txt · Last modified: 2025/03/11 19:57 by dragonlord