dragengine:modules:dragonscript:behavior_outline
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| dragengine:modules:dragonscript:behavior_outline [2020/05/24 01:04] – created dragonlord | dragengine:modules:dragonscript:behavior_outline [2024/03/14 16:55] (current) – dragonlord | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| [[: | [[: | ||
| </ | </ | ||
| + | |||
| + | * [[behaviors_use_cases|Behaviors Explained: By Use-Case]] | ||
| + | * [[behaviors_a_to_z|Behaviors Explained: From A to Z]] | ||
| ====== ECBehaviorOutline ====== | ====== ECBehaviorOutline ====== | ||
| Line 42: | Line 45: | ||
| The emissivity is optional and allows to make the outline glow in the dark. Using renderable " | The emissivity is optional and allows to make the outline glow in the dark. Using renderable " | ||
| - | This set up allows to add an outline skin to any 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. |
| - | This behavior can be also used to add outer skins in general to an ECBehaviorComponent. You have to adjust the outline skin to achieve the desired result. | + | This behavior can be also used to add outer skins in general to an [[behavior_component|ECBehaviorComponent]]. You have to adjust the outline skin to achieve the desired result. |
| This is an effect type behavior and starts out invisible. Use setVisible() to switch the outline on and off. Typically this is done in response to game events or by other behaviors managing outline parameters. | This is an effect type behavior and starts out invisible. Use setVisible() to switch the outline on and off. Typically this is done in response to game events or by other behaviors managing outline parameters. | ||
| Line 52: | Line 55: | ||
| 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. To use multiple instances use code like this in your subclass constructor: | ||
| < | < | ||
| - | class MyElement | + | class MultiInstanceClass |
| public var ECBehaviorComponent component | public var ECBehaviorComponent component | ||
| public var ECBehaviorCollider collider | public var ECBehaviorCollider collider | ||
| | | ||
| - | public func new() | + | public func new() super(" |
| component = ECBehaviorComponent.new(this) | component = ECBehaviorComponent.new(this) | ||
| collider = ECBehaviorCollider.new(this, | collider = ECBehaviorCollider.new(this, | ||
| Line 67: | Line 70: | ||
| ====== Element Class Properties ====== | ====== Element Class Properties ====== | ||
| - | Element class properties have the prefix **outline{(id)}.**. | + | Element class properties have the prefix **outline.** or **outline(id).** |
| ===== skin ===== | ===== skin ===== | ||
| Path to skin to use to render the outline. | Path to skin to use to render the outline. | ||
| - | * Full name: " | + | * Full name: " |
| - | * Type ECPSkin | + | * Type skin path |
| * Default Value "/ | * Default Value "/ | ||
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| Line 78: | Line 81: | ||
| ===== 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: " | + | * Full name: " |
| - | * Type ECPModel | + | * Type model path |
| * Default value //null// | * Default value //null// | ||
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| Line 85: | Line 88: | ||
| ===== 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: " | + | * Full name: " |
| - | * Type ECPRig | + | * Type rig path |
| * Default value //null// | * Default value //null// | ||
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| Line 92: | Line 95: | ||
| ===== color ===== | ===== color ===== | ||
| Color of the outline. For this property to have any effect the used skin requires to have a renderable named " | Color of the outline. For this property to have any effect the used skin requires to have a renderable named " | ||
| - | * Full name: " | + | * Full name: " |
| - | * Type ECPColor | + | * Type color |
| - | * Default value //white (1, 1, 1)// | + | * Default value //black (0, 0, 0)// |
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| ===== intensity ===== | ===== intensity ===== | ||
| Emissivity intensity of the outline. For this property to have any effect the used skin requires to have a renderable named " | Emissivity intensity of the outline. For this property to have any effect the used skin requires to have a renderable named " | ||
| - | * Full name: " | + | * Full name: " |
| - | * Type ECPFloat | + | * Type floating point |
| * Minimum Value 0 | * Minimum Value 0 | ||
| * Default value 0 | * Default value 0 | ||
| Line 107: | Line 110: | ||
| ===== 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 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 " | ||
| - | * Full name: " | + | * Full name: " |
| - | * Type ECPFloat | + | * Type floating point |
| * Minimum Value 0 | * Minimum Value 0 | ||
| * Default value 0.005 | * Default value 0.005 | ||
| Line 119: | Line 122: | ||
| ====== Optional Behaviors ====== | ====== Optional Behaviors ====== | ||
| - | Thie behavior does not support optional behaviors. | + | This behavior does not support optional behaviors. |
| ====== Persistency ====== | ====== Persistency ====== | ||
| Line 127: | Line 130: | ||
| ====== API Documentation ====== | ====== API Documentation ====== | ||
| - | [[https:// | + | # |
| - | Since API 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 ====== | ||
| + | |||
| + | < | ||
| + | class ExampleElementClass extends BehaviorElementClass | ||
| + | | ||
| + | | ||
| + | | ||
| + | |||
| + | | ||
| + | // add required behaviors component and collider | ||
| + | | ||
| + | | ||
| + | |||
| + | // create outline behavior and set parameters. the outline will be colored red | ||
| + | // and has a thickness of 0.0075 using a custom " | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | end | ||
| + | end | ||
| + | </ | ||
dragengine/modules/dragonscript/behavior_outline.1590282292.txt.gz · Last modified: 2020/05/24 01:04 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
