User Tools

Site Tools


dragengine:modules:dragonscript:behavior_showelement

ECBehaviorShowElement

Behavior element behavior show/hide element if triggered.

If trigger evaluates to true the element is set visible and touchable others not.

Instance Counts

This behavior can be used only once on an element.

Element Class Properties

Element class properties have the prefix showElement..

trigger

Set trigger to show element.

  • Full name: showElement.trigger or showElement({id}).trigger
  • Type: string
  • Default Value: empty string
  • Example (*.deeclass)
    <string name='showElement.trigger'>@playerEnterSpot & @ghostPresent</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 shown state.

API Documentation

ECBehaviorShowElement.

Since DragonScript Module Version 1.19

Use Cases

  • Make element appear if player touches a trigger.

Element Class Example

This example defines an element which contains a resources.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorShowElement showElement
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    showElement = ECBehaviorShowElement.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='ECBehaviorComponent'/>
  <behavior type='ECBehaviorCollider'/>
 
  <behavior type='ECBehaviorShowElement'>
    <!-- optional: use BaseGameApp trigger table. game can add more supported values.
                   default is 'default' -->
    <string name='triggerTable'>default</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.name'>value</string>
  </behavior>
</elementClass>

Live Examples

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