User Tools

Site Tools


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
Next revisionBoth sides next revision
dragengine:modules:dragonscript:behavior_outline [2020/05/24 01:11] – [Element Class Example] dragonlorddragengine:modules:dragonscript:behavior_outline [2020/05/24 13:11] dragonlord
Line 67: Line 67:
 ====== Element Class Properties ====== ====== Element Class Properties ======
  
-Element class properties have the prefix **outline{(id)}.**.+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{(id)}.skin" +  * Full name: "outline.skin" or "outline(id).skin" 
-  * Type ECPSkin+  * Type skin path
   * Default Value "/shareddata/materials/outlined.deskin"   * Default Value "/shareddata/materials/outlined.deskin"
   * Example (*.deeclass) <code xml><string name='outline.skin'>outline.deskin</string></code>   * Example (*.deeclass) <code xml><string name='outline.skin'>outline.deskin</string></code>
Line 78: Line 78:
 ===== 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{(id)}.model" +  * Full name: "outline.model" or "outline(id).model" 
-  * Type ECPModel+  * Type model path
   * Default value //null//   * Default value //null//
   * Example (*.deeclass) <code xml><string name='outline.model'>outline.demodel</string></code>   * Example (*.deeclass) <code xml><string name='outline.model'>outline.demodel</string></code>
Line 85: Line 85:
 ===== 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{(id)}.rig" +  * Full name: "outline.rig" or "outline(id).rig" 
-  * Type ECPRig+  * Type rig path
   * Default value //null//   * Default value //null//
   * Example (*.deeclass) <code xml><string name='outline.rig'>outline.derig</string></code>   * Example (*.deeclass) <code xml><string name='outline.rig'>outline.derig</string></code>
Line 92: Line 92:
 ===== 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{(id)}.color" +  * Full name: "outline.color" or "outline(id).color" 
-  * Type ECPColor +  * Type color 
-  * Default value //white (111)//+  * Default value //black (000)//
   * 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{(id)}.intensity" +  * Full name: "outline.intensity" or "outline(id).intensity" 
-  * Type ECPFloat+  * Type floating point
   * Minimum Value 0   * Minimum Value 0
   * Default value 0   * Default value 0
Line 107: Line 107:
 ===== 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{(id)}.thickness" +  * Full name: "outline.thickness" or "outline(id).thickness" 
-  * Type ECPFloat+  * Type floating point
   * Minimum Value 0   * Minimum Value 0
   * Default value 0.005   * Default value 0.005
Line 131: Line 131:
 Since DragonScript Module Version **1.1** Since DragonScript Module Version **1.1**
  
 +====== 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.
 +  * Use for Toon-Rendering to draw a black outline on all objects.
 ====== Element Class Example ====== ====== Element Class Example ======
  
Line 145: Line 148:
      outline = ECBehaviorOutline.new(this, component, collider)      outline = ECBehaviorOutline.new(this, component, collider)
            
-     // set parameters of outline behavior to red color with 0.0075 thickness using a custom "outline.deskin" skin+     // set parameters of outline behavior to red color with 0.0075 thickness 
 +     // using a custom "outline.deskin" skin
      outline.getSkin().setPath("outline.deskin")      outline.getSkin().setPath("outline.deskin")
      outline.getColor().setColor(Color.red)      outline.getColor().setColor(Color.red)
dragengine/modules/dragonscript/behavior_outline.txt · Last modified: 2024/03/14 16:55 by dragonlord