User Tools

Site Tools


democap:behavior_ecbhelptopic

ECBHelpTopic

Behavior adding support to define help topic. Help topic is used by the “?” button shown next to the behavior panel if it supports ECBBehaviorGuiPanels.

Instance Counts

This behavior can be used only once on an element.

Element Class Properties

Element class properties have the prefix helpTopic..

string

Help topic to show. Values have to match a wiki-page identifier relative to the democap namespace. For example ocls_actormarker shows the help page https://developer.dragondreams.ch/wiki/doku.php/democap:ocls_actormarker .

  • Full name: helpTopic.topic
  • Type: string
  • Default Value: empty string
  • Example (*.deeclass)
    <string name='helpTopic.topic'>ocls_actormarker</string>

Events

This behavior has no events.

Conversation Commands

This behavior adds no conversation commands.

Conversation Conditions

This behavior adds no conversation conditions.

Behavior Tree Actions

This behavior adds no behavior tree actions.

Behavior Tree Conditions

This behavior adds no behavior tree conditions.

Required Behaviors

This behavior requires no other behaviors.

Optional Behaviors

This behavior does not support optional behaviors.

API Documentation

Since DEMoCap Version 1.3

Use Cases

  • Define help topic

Element Class Example

class MyElement extends BehaviorElementClass
  public var ECBHelpTopic helpTopic
  func new()
    helpTopic = ECBHelpTopic.new(this)
		helpTopic.getHelpTopic().setValue("ocls_actormarker")
  end
end

Behavior Factory

Using element class supporting adding behaviors the behavior can be added like this (again create an example which creates a valid element class):

<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBHelpTopic'>
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.topic'>ocls_actormarker</string>
  </behavior>
</elementClass>

Live Examples

You could leave a comment if you were logged in.
democap/behavior_ecbhelptopic.txt · Last modified: 2025/03/22 17:39 by dragonlord