{{tag>dragonscript behavior}}
<WRAP youarehere>
[[: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]] >> **ECBehaviorAvoidCollision**
</WRAP>

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

====== ECBehaviorAvoidCollision ======

Behavior adding support to actors to avoid collisions with [[behavior_avoidedbyactor|ECBehaviorAvoidedByActor]].

Behavior attaches to [[behavior_actormover|ECBehaviorActorMover]] to modify walking path while moving.

To use this behavior add it to the element class and make sure to call setShapesSphere() to set up the collision test shapes. The best time to do this is either in BehaviorElement.init() or inside BaseActorAction if you need to change them per action.

See also:
  * [[gamedev:colliders|Colliders]]
====== Instance Counts ======
This behavior can be used only once on an element.

====== Element Class Properties ======
Element class properties have the prefix ''avoidCollision.'' .

===== radius =====
Set avoid radius in meters.
  * Full name: ''avoidCollision.radius''
  * Type: float
  * Default Value: 0.4
  * Restriction: At least 0
  * Example (*.deeclass) <code xml><float name='avoidCollision.radius'>0.6</float></code>

====== Events ======
This behavior has no events.

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

  * [[behavior_actormover|ECBehaviorActorMover]]

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

  * [[behavior_rideon|ECBehaviorRideOn]]: Avoid while respecting ground movement.

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

This behavior does support element class to be persistable (setPersistable).

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

#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorAvoidCollision.html,ECBehaviorAvoidCollision~@#.

Since DragonScript Module Version ''1.0''

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

  * Make actor avoid elements supporting [[behavior_avoidedbyactor|ECBehaviorAvoidedByActor]].

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

This example defines an element which can avoid collisions.

<code>
class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorColliderAI colliderAI
  public var ECBehaviorLocomotion locomotion
  public var ECBehaviorNavigator navigator
  public var ECBehaviorProjectToGround projectToGround
  public var ECBehaviorRideOn rideOn
  public var ECBehaviorActorMover actorMover
  public var ECBehaviorAvoidCollision avoidCollision
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    colliderAI = ECBehaviorColliderAI.new(this, collider)
    locomotion = ECBehaviorLocomotion.new(this, colliderAI)
    navigator = ECBehaviorNavigator.new(this)
    projectToGround = ECBehaviorProjectToGround.new(this, colliderAI)
    rideOn = ECBehaviorRideOn.new(this, locomotion, projectToGround)
    actorMover = ECBehaviorActorMover.new(this, locomotion, navigator, rideOn)
    actorMover.setConversationActor(conversationActor)
    avoidCollision = ECBehaviorAvoidCollision.new(this, actorMover, rideOn)
  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='ECBehaviorColliderAI'/>
  <behavior type='ECBehaviorLocomotion'/>
  <behavior type='ECBehaviorNavigator'/>
  <behavior type='ECBehaviorProjectToGround'/>
  <behavior type='ECBehaviorRideOn'/>
  
  <behavior type='ECBehaviorAvoidCollision'>
    <!-- optional: set collision filter. default value '3:0 1 2 3' which means
                   category BaseGameApp.CollisionFilterBit.actorAI
                   filter BaseGameApp.CollisionFilterBit.geometry,
                          BaseGameApp.CollisionFilterBit.dynamic,
                          BaseGameApp.CollisionFilterBit.actorAI.
                   format is '', 'category' or 'category:filter' where category and filter
                   are a list of bits to set. -->
    <string name='collisionFilter'>3:0 1 2 3</string>
    
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <float name='.radius'>0.6</float>
  </behavior>
</elementClass>
</code>

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

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