Drag[en]gine Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{tag>motioncapture democap behavior}}
<WRAP youarehere>
[[:start|Start Page]] >> [[main|DEMoCap: Drag[en]gine Motion Capture]] >> [[democap:elementclasses|XML Element Classes]] >> ** ECBHideCondition **
</WRAP>

====== ECBHideCondition ======

Behavior hide component if condition is true. User can change conditions.

====== Instance Counts ======

This behavior can be used only once on an element.

====== Element Class Properties ======

Element class properties have the prefix ''hideCondition.''.

===== live =====

Hide object while not recording, playing back or preparing to record. Basically this hides the object while setting up the scene for motion capture.

  * Full name: ''hideCondition.live''
  * Type: boolean
  * Default Value: ''false''
  * Example (*.deeclass) <code xml><boolean name='hideCondition.live'>false</boolean></code>

===== playback =====

Hide object during playing back.

  * Full name: ''hideCondition.playback''
  * Type: boolean
  * Default Value: ''true''
  * Example (*.deeclass) <code xml><boolean name='hideCondition.playback'>true</boolean></code>

===== record =====

Hide object during recording.

  * Full name: ''hideCondition.record''
  * Type: boolean
  * Default Value: ''true''
  * Example (*.deeclass) <code xml><boolean name='hideCondition.record'>true</boolean></code>

====== Events ======

===== hideObject =====

Determine if object has to be hidden. Object is hidden if one or more listeners return ''true''.

====== 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 ======

  * [[behavior_ecbbehaviorguipanels|ECBBehaviorGuiPanels]]

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

This behavior does not support optional behaviors.

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

Since DEMoCap Version ''1.3''

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

  * Hide object under specific conditions.

====== Element Class Example ======

<code>
class MyElement extends BehaviorElementClass
  public var ECBHideCondition hideCondition
  func new()
    hideCondition = ECBHideCondition.new(this)
  end
end
</code>

====== 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):

<code xml>
<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBHideCondition'>
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <boolean name='.record'>true</boolean>
  </behavior>
</elementClass>
</code>

====== Live Examples ======
Drag[en]gine Wiki

User Tools

Site Tools

Page Tools
