User Tools

Site Tools


dragengine:modules:dragonscript:behavior_actortransmission

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
dragengine:modules:dragonscript:behavior_actortransmission [2024/03/14 16:49] dragonlorddragengine:modules:dragonscript:behavior_actortransmission [2025/03/13 17:08] (current) dragonlord
Line 1: Line 1:
 {{tag>dragonscript behavior}} {{tag>dragonscript behavior}}
 <WRAP youarehere> <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorActorTransmission**+[[: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]] >> **ECBehaviorActorTransmission**
 </WRAP> </WRAP>
  
Line 19: Line 19:
 ====== Instance Counts ====== ====== Instance Counts ======
  
-This behavior can be added only once to an element class. While technically possible it there is no reason to use multiple transmissions since the sub titles can be styled.+This behavior can be used only once on an element.
  
 ====== Element Class Properties ====== ====== Element Class Properties ======
  
-Element class properties have the prefix **transmission.** if id is not empty.+Element class properties have the prefix ''transmission.''.
  
 ===== waitInConversation ===== ===== waitInConversation =====
 If enabled causes conversation scripts to wait for the transmission to end. If enabled causes conversation scripts to wait for the transmission to end.
-  * Full name: "transmission.waitInConversation" +  * Full name: ''transmission.waitInConversation'' 
-  * Type boolean +  * Typeboolean 
-  * Default Value false+  * Default Value: ''false''
   * Example (*.deeclass) <code xml><boolean name='transmission.waitInConversation'>true</boolean></code>   * Example (*.deeclass) <code xml><boolean name='transmission.waitInConversation'>true</boolean></code>
  
 ===== style ===== ===== style =====
 Style identifier to use. Same as style identifiers used in sub title boxes. Style identifier to use. Same as style identifiers used in sub title boxes.
-  * Full name: "transmission.style" +  * Full name: ''transmission.style'' 
-  * Type string +  * Typestring 
-  * Default Value //null//+  * Default Value: ''null''
   * Example (*.deeclass) <code xml><string name='transmission.style'>think</string></code>   * Example (*.deeclass) <code xml><string name='transmission.style'>think</string></code>
  
 ===== timeout ===== ===== timeout =====
 Timeout in seconds to display individual transmission parts. Timeout in seconds to display individual transmission parts.
-  * Full name: "transmission.timeout" +  * Full name: ''transmission.timeout'' 
-  * Type float +  * Typefloat 
-  * Default Value 5 +  * Default Value: ''5'' 
-  * Example (*.deeclass) <code xml><string name='actorIK.controllerIKHeight'>ik.height</string></code>+  * Example (*.deeclass) <code xml><string name='transmission.timeout'>ik.height</string></code> 
 + 
 +===== clearEnterConversation ===== 
 +Set clear transmission upon entering conversation. 
 +  * Full name: ''transmission.clearEnterConversation'' 
 +  * Type: boolean 
 +  * Default Value: false 
 +  * Example (*.deeclass) <code xml><boolean name='transmission.clearEnterConversation'>true</boolean></code> 
 + 
 +====== Events ====== 
 +This behavior has no events.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 62: Line 72:
 #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorActorTransmission.html,ECBehaviorActorTransmission~@#. #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorActorTransmission.html,ECBehaviorActorTransmission~@#.
  
-Since DragonScript Module Version **1.7**+Since DragonScript Module Version ''1.7''
  
 ====== Use Cases ====== ====== Use Cases ======
Line 112: Line 122:
 end end
 </code> </code>
 +
 +====== Behavior Factory ======
 +
 +Using element class supporting adding behaviors the behavior can be added like this:
 +<code xml>
 +<?xml version='1.0' encoding='UTF-8'?>
 +<elementClass name='MyClass' class='GenericBehaviorElement'>
 +  <behavior type='ECBehaviorComponent'/>
 +  <behavior type='ECBehaviorCollider'/>
 +  <behavior type='ECBehaviorConversationActor'/>
 +  
 +  <behavior type='ECBehaviorActorTransmission'>
 +    <!-- optional: use BaseGameApp sub title. game can add more supported values.
 +                   default is 'default' -->
 +    <string name='subTitle'>default</string>
 +    
 +    <!-- set element properties. omit property prefix if used inside behavior tag -->
 +    <float name='.timeout'>3</float>
 +  </behavior>
 +</elementClass>
 +</code>
 +
 +====== Live Examples ======
 +
 +  * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]
 +
dragengine/modules/dragonscript/behavior_actortransmission.1710434941.txt.gz · Last modified: 2024/03/14 16:49 by dragonlord