Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_outline

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_outline [2020/05/24 14:06] – dragonlorddragengine:modules:dragonscript:behavior_outline [2025/05/04 13:46] (current) – [outline.check] 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]] >> **ECBehaviorOutline**+[[: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]] >> **ECBehaviorOutline**
 </WRAP> </WRAP>
 +
 +  * [[behaviors_use_cases|Behaviors Explained: By Use-Case]]
 +  * [[behaviors_a_to_z|Behaviors Explained: From A to Z]]
  
 ====== ECBehaviorOutline ====== ====== ECBehaviorOutline ======
Line 21: Line 24:
 Then an outline skin is assigned to the new component and all textures it contains. This replaces every texture in the new component with the outline skin. Then an outline skin is assigned to the new component and all textures it contains. This replaces every texture in the new component with the outline skin.
  
-The outline skin is set by the user. To work properly it has to use the "outline.*" skin texture properties to render the outline and "solidity" with value "0" to hide everything but the outline.+The outline skin is set by the user. To work properly it has to use the ''outline.*'' skin texture properties to render the outline and ''solidity'' with value ''0'' to hide everything but the outline.
  
 A typical outline skin looks like this: A typical outline skin looks like this:
Line 38: Line 41:
 </code> </code>
  
-By default the skin "/shareddata/materials/outlined.deskin" is used which is provided by the shared DragonScript Module data and provides tintable and emissive outlines.+By default the skin ''/shareddata/materials/outlined.deskin'' is used which is provided by the shared DragonScript Module data and provides tintable and emissive outlines.
  
-The emissivity is optional and allows to make the outline glow in the dark. Using renderable "color" is also optional but recommended. This allows this behavior to change the outline color using a dynamic skin.+The emissivity is optional and allows to make the outline glow in the dark. Using renderable ''color'' is also optional but recommended. This allows this behavior to change the outline color using a dynamic skin.
  
 This set up allows to add an outline skin to any [[behavior_component|ECBehaviorComponent]] without the need to create skins with built-in support for outline rendering. If you want to use outline for all objects by default better build it into their skins which is faster. This set up allows to add an outline skin to any [[behavior_component|ECBehaviorComponent]] without the need to create skins with built-in support for outline rendering. If you want to use outline for all objects by default better build it into their skins which is faster.
Line 50: Line 53:
 ====== Instance Counts ====== ====== Instance Counts ======
  
-Multiple instances of ECBehaviorOutline can be used for example to create different outlines to switch on and off or to add multiple outline skins to a single ECBehaviorComponent. Keep in mind though that each instance of ECBehaviorOutline creates a new component and dynamic skin resource which can impact performance if the used model has high polygon count. To use multiple instances use code like this in your subclass constructor: +Multiple instances of ECBehaviorOutline can be used for example to create different outlines to switch on and off or to add multiple outline skins to a single ECBehaviorComponent. Keep in mind though that each instance of ECBehaviorOutline creates a new component and dynamic skin resource which can impact performance if the used model has high polygon count. Use the behavior identifier to tell them apart.
-<code> +
-class MultiInstanceClass extends BehaviorElementClass +
-  public var ECBehaviorComponent component +
-  public var ECBehaviorCollider collider +
-   +
-  public func new() super("MultiInstance") +
-    component = ECBehaviorComponent.new(this) +
-    collider = ECBehaviorCollider.new(this, component) +
-    ECBehaviorOutline.new(this, component, collider) +
-    ECBehaviorOutline.new(this, component, collider, "secondOutline") +
-  end +
-end +
-</code>+
  
 ====== Element Class Properties ====== ====== Element Class Properties ======
  
-Element class properties have the prefix **outline.** or **outline(id).** if id is not empty.+Element class properties have the prefix ''outline.'' or ''outline(id).'' if id is not empty.
  
 ===== skin ===== ===== skin =====
 Path to skin to use to render the outline. Path to skin to use to render the outline.
-  * Full name: "outline.skin" or "outline(id).skin" +  * Full name: ''outline.skin'' or ''outline(id).skin'' 
-  * Type skin path +  * Type: string 
-  * Default Value "/shareddata/materials/outlined.deskin"+  * Default Value: ''/shareddata/materials/outlined.deskin'' 
 +  * File Pattern: ''*.deskin'' (all skin modules)
   * Example (*.deeclass) <code xml><string name='outline.skin'>outline.deskin</string></code>   * Example (*.deeclass) <code xml><string name='outline.skin'>outline.deskin</string></code>
  
 ===== model ===== ===== model =====
 Path to model to use instead of the model of the dependency component Path to model to use instead of the model of the dependency component
-  * Full name: "outline.model" or "outline(id).model" +  * Full name: ''outline.model'' or ''outline(id).model'' 
-  * Type model path +  * Type: string 
-  * Default value //null//+  * Default value: ''null'' 
 +  * FIle Pattern: ''*.demodel'' (all model modules)
   * Example (*.deeclass) <code xml><string name='outline.model'>outline.demodel</string></code>   * Example (*.deeclass) <code xml><string name='outline.model'>outline.demodel</string></code>
  
 ===== rig ===== ===== rig =====
 Path to rig to use instead of the rig of the dependency component. If null uses the dependency component rig. Path to rig to use instead of the rig of the dependency component. If null uses the dependency component rig.
-  * Full name: "outline.rig" or "outline(id).rig" +  * Full name: ''outline.rig'' or ''outline(id).rig'' 
-  * Type rig path +  * Type: String 
-  * Default value //null//+  * Default value: ''null'' 
 +  * File Pattern: ''*.derig'' (all rig modules)
   * Example (*.deeclass) <code xml><string name='outline.rig'>outline.derig</string></code>   * Example (*.deeclass) <code xml><string name='outline.rig'>outline.derig</string></code>
  
 ===== color ===== ===== color =====
-Color of the outline. For this property to have any effect the used skin requires to have a renderable named "color". +Color of the outline. For this property to have any effect the used skin requires to have a renderable named ''color''. 
-  * Full name: "outline.color" or "outline(id).color" +  * Full name: ''outline.color'' or ''outline(id).color'' 
-  * Type color +  * Type: 3-component color 
-  * Default value //black (0, 0, 0)//+  * Default value: ''(0, 0, 0)''
   * Example (*.deeclass) <code xml><color name='outline.color' r='1' g='0' b='0'/></code>   * Example (*.deeclass) <code xml><color name='outline.color' r='1' g='0' b='0'/></code>
  
 ===== intensity ===== ===== intensity =====
-Emissivity intensity of the outline. For this property to have any effect the used skin requires to have a renderable named "intensity". +Emissivity intensity of the outline. For this property to have any effect the used skin requires to have a renderable named ''intensity''. 
-  * Full name: "outline.intensity" or "outline(id).intensity" +  * Full name: ''outline.intensity'' or ''outline(id).intensity'' 
-  * Type floating point +  * Type: floating point 
-  * Minimum Value 0 +  * Default value: ''0'' 
-  * Default value 0+  * Restriction: At least 0
   * Example (*.deeclass) <code xml><float name='outline.intensity'>4</float></code>   * Example (*.deeclass) <code xml><float name='outline.intensity'>4</float></code>
  
 ===== thickness ===== ===== thickness =====
-Thickness of the outline. The measurement unit of this value depends on the outline type in the used skin. For this property to have any effect the used skin requires to have a renderable named "thickness". +Thickness of the outline. The measurement unit of this value depends on the outline type in the used skin. For this property to have any effect the used skin requires to have a renderable named ''thickness''. 
-  * Full name: "outline.thickness" or "outline(id).thickness" +  * Full name: ''outline.thickness'' or ''outline(id).thickness'' 
-  * Type floating point +  * Type: floating point 
-  * Minimum Value 0 +  * Default value: ''0.005'' 
-  * Default value 0.005+  * Restrictions: At least 0
   * Example (*.deeclass) <code xml><float name='outline.thickness'>0.005</float></code>   * Example (*.deeclass) <code xml><float name='outline.thickness'>0.005</float></code>
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''outline'' with ''outline(id)''.
 +
 +===== outline.set =====
 +
 +Set one or more outline parameters.
 +
 +^Parameter^Value^Description^
 +|visible|true,false|Show outline|
 +|color|3-component color|Set outline color|
 +|intensity|float|Set outline intensity|
 +|thickness|float|Set outline thickness|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='outline.set'>
 +  <parameter name='visible'>true</parameter>
 +</action>
 +</code>
 +
 +===== outline.check =====
 +
 +Check one or more outline parameters. Action succeeds if all parameter value matches their respective outline parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a outline parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|visible|true,false|Outline is visible or not|
 +|wait| |If present action returns BTResult.running instead of BTResult.failed to wait until the checks are all fulfilled|
 +
 +This is an example of using this action:
 +<code xml>
 +<sequence>
 +  <action name='outline.check'>
 +    <parameter name='visible'>true</parameter>
 +  </action>
 +  <!-- actions here run only if outline is visible -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''outline'' with ''outline(id)''.
 +
 +===== outline.check =====
 +
 +Check one or more outline parameters. Conditions returns true if all parameter value match their respective outline parameter. This condition is typically used to run an action or sequence of actions as long as outline conditions are true.
 +
 +^Parameter^Value^Description^
 +|outline.visible|true,false|Outline is visible or not|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='outline.visible'>true</parameter>
 +  <condition>outline.check</condition>
 +</action>
 +</code>
 +
 +====== State Machine Actions ======
 +
 +Same as [[#behavior_tree_actions|Behavior Tree Actions]].
 +
 +====== State Machine Conditions ======
 +
 +Same as [[#behavior_tree_conditions|Behavior Tree Conditions]].
 +
 +====== State Machine Events ======
 +
 +This behavior sends these state machine events. If behavior has non-empty identifier replace ''outline'' with ''outline(id)''.
 +
 +===== outline.visible =====
 +
 +Outline is now visible.
 +
 +===== outline.invisible =====
 +
 +Outline is now invisible.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
 +
   * [[behavior_component|ECBehaviorComponent]]   * [[behavior_component|ECBehaviorComponent]]
   * [[behavior_collider|ECBehaviorCollider]]   * [[behavior_collider|ECBehaviorCollider]]
Line 119: Line 191:
 ====== Optional Behaviors ====== ====== Optional Behaviors ======
  
-Thie behavior does not support optional behaviors. +  * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: Add actions and conditions for behavior trees to use. 
 +  * [[behavior_statemachine|ECBehaviorStateMachine]]: Add actions and conditions for state machine to use and events to send to the state machine.
 ====== Persistency ====== ====== Persistency ======
  
-This behavior does support element class to be persistable (setPersistable). Saves color, intensity and visiblity state.+This behavior does support element class to be persistable (setPersistable).
  
 ====== API Documentation ====== ====== API Documentation ======
  
-[[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorOutline.html|ECBehaviorOutline]].+#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorOutline.html,ECBehaviorOutline~@#.
  
-Since DragonScript Module Version **1.1**+Since DragonScript Module Version ''1.1''
  
 ====== Use Cases ====== ====== Use Cases ======
 +
   * Highlight objects player can interact with. Combine this with [[behavior_lookedat|ECBehaviorLookedAt]] using a listening to show/hide the highlight if the player looks at the object.   * Highlight objects player can interact with. Combine this with [[behavior_lookedat|ECBehaviorLookedAt]] using a listening to show/hide the highlight if the player looks at the object.
   * Use for Toon-Rendering to draw a black outline on all objects.   * Use for Toon-Rendering to draw a black outline on all objects.
 +
 ====== Element Class Example ====== ====== Element Class Example ======
  
Line 148: Line 222:
            
      // create outline behavior and set parameters. the outline will be colored red      // create outline behavior and set parameters. the outline will be colored red
-     // and has a thickness of 0.0075 using a custom "outline.deskin" skin+     // and has a thickness of 0.0075 using a custom ''outline.deskin" skin
      outline = ECBehaviorOutline.new(this, component, collider)      outline = ECBehaviorOutline.new(this, component, collider)
-     outline.getSkin().setPath("outline.deskin")+     outline.getSkin().setPath(''outline.deskin")
      outline.getColor().setColor(Color.red)      outline.getColor().setColor(Color.red)
      outline.getThickness().setValue(0.0075)      outline.getThickness().setValue(0.0075)
Line 156: Line 230:
 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='ECBehaviorOutline'>
 +    <!-- optional: use component with id instead of empty string -->
 +    <string name='component'>second</string>
 +    
 +    <!-- optional: use behavior tree with id instead of empty string -->
 +    <string name='behaviorTree'>second</string>
 +    
 +    <!-- optional: use state machine with id instead of empty string -->
 +    <string name='stateMachine'>second</string>
 +    
 +    <!-- set element properties. omit property prefix if used inside behavior tag -->
 +    <string name='.model'>outline.demodel</string>
 +  </behavior>
 +  
 +  <!-- for adding multiple behaviors use unique identifiers -->
 +  <behavior type='ECBehaviorOutline' id='second'/>
 +</elementClass>
 +</code>
 +
 +====== Live Examples ======
 +
 +  * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]
 +
dragengine/modules/dragonscript/behavior_outline.1590329214.txt.gz · Last modified: 2020/05/24 14:06 by dragonlord

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki