{{tag>dragonscript behavior}}
<WRAP youarehere>
[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorNavigationBlocker**
</WRAP>

  * [[behaviors_use_cases|Behaviors Explained: By Use-Case]]
  * [[behaviors_a_to_z|Behaviors Explained: From A to Z]]

====== ECBehaviorNavigationBlocker ======

Behavior element behavior adding navigation blocker support.

Behavior adds a NavigationBlocker resource to the the behavior element. This allow elements using Navigator resource to avoid moving into the blocked space. Actors have a navigator by default. Other elements can use [[behavior_navigator|ECBehaviorNavigator]] to interact with ECBehaviorNavigationBlocker.

If the [[behavior_collider|ECBehaviorCollider]] behavior is present in the behavior element before this behavior is added the light is attached. The light is attached to the named bone if defined otherwise it is attached statically.

See also:
  * [[gamedev:navigation|Navigation System]]
  * [[tools:blenderexportscripts|Blender3D Export Scripts]]
====== Instance Counts ======
This behavior can be added multiple times to an element. Each instance creates one navigation blocker attached to the element collider which can be individually modified. Use the behavior identifier to tell them apart.

====== Element Class Properties ======
Element class properties have the prefix ''navigationBlocker.'' or ''navigationBlocker({id}).'' if id is not empty.

===== layer =====
Set layer. Only spaces, blockers and navigators on the same layer affect each other.
  * Full name: ''navigationBlocker.layer'' or ''navigationBlocker({id}).layer''
  * Type: integer
  * Default Value: 0
  * Example (*.deeclass) <code xml><integer name='navigationBlocker.layer'>1</integer></code>

===== shape =====
Set blocker shape. Carves space inside shape out of touching navigation spaces.
  * Full name: ''navigationBlocker.shape'' or ''navigationBlocker({id}).shape''
  * Type: string (shape format). See "Shape List Encoding" in CodecPropertyString.
  * Default Value: empty string
  * Example (*.deeclass) <code xml><string name='navigationBlocker.shape'>box:position,0,0.5,0:extends,2,1,0.5</string></code>

===== priority =====
Set priority. Blockers only carve space out of navigation spaces with the same priority or lower as the blocker priority.
  * Full name: ''navigationBlocker.priority'' or ''navigationBlocker({id}).priority''
  * Type: integer
  * Default Value: 0
  * Example (*.deeclass) <code xml><integer name='navigationBlocker.priority'>1</integer></code>

===== position =====
Set position to attach resource to collider.
  * Full name: ''navigationBlocker.position'' or ''navigationBlocker({id}).position''
  * Type: 3-component float vector
  * Default Value: (0,0,0)
  * Example (*.deeclass) <code xml><vector name='navigationBlocker.position' x='0' y='0' z='0.1'/></code>

===== orientation =====
Set orientation to attach resource to collider in degrees.
  * Full name: ''navigationBlocker.orientation'' or ''navigationBlocker({id}).orientation''
  * Type: 3-component float vector
  * Default Value: (0,0,0)
  * Example (*.deeclass) <code xml><vector name='navigationBlocker.orientation' x='30' y='0' z='0'/></code>

===== bone =====
Set bone to attach resource to. If empty string attach to collider.
  * Full name: ''navigationBlocker.bone'' or ''navigationBlocker({id}).bone''
  * Type: string
  * Default Value: empty string
  * Example (*.deeclass) <code xml><string name='navigationBlocker.bone'>attach</string></code>

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

This behavior has no events.

====== Required Behaviors ======

This behavior requires no other behaviors.

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

  * [[behavior_collider|ECBehaviorCollider]]: Attach to collider.

====== Persistency ======

This behavior does not require the element class to be persistable (setPersistable).

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

#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorNavigationBlocker.html,ECBehaviorNavigationBlocker~@#.

Since DragonScript Module Version ''1.0''

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

  * Prevent navigators moving across space covered by blocker shape.

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

This example defines an element which contains a navigation blocker.

<code>
class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorNavigationBlocker navigationBlocker
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    navigationBlocker = ECBehaviorNavigationBlocker.new(this, collider)
    
    var ShapeList shape = ShapeList.new()
    shape.addBox(Vector.new(), Vector.new(0.6, 0.3, 0.3))
    navigationBlocker.getNavigationBlocker().getShape().setShape(shape)
  end
end
</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='ECBehaviorNavigationBlocker'>
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.shape'>box:position,0,0.5,0:extends,2,1,0.5</string>
  </behavior>
  
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorNavigationBlocker' id='second'/>
</elementClass>
</code>

====== Live Examples ======

  * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]