Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorHitScan Class Reference

Behavior adding hit-scan support to elements. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorHitScan:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

void dispose ()
 Dispose of behavior. More...
 
ECPString getBone ()
 Test bone. More...
 
ECBehaviorCollider getCollider ()
 Collider behavior or null. More...
 
ECComposeCollisionFilter getCollisionFilter ()
 Collision filter for AI collider. More...
 
ECBehaviorComponent getComponent ()
 Component behavior or null. More...
 
ECPVector getDirection ()
 Normalized test direction. More...
 
ECPFloat getOffset ()
 Test origin offset. More...
 
ECPVector getOrientation ()
 Test orientation. More...
 
ECPVector getOrigin ()
 Test origin. More...
 
ECPFloat getRange ()
 Test range. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorHitScan new (BehaviorElementClass eclass, ECBehaviorCollider collider, ECBehaviorComponent component)
 Create behavior element class. More...
 
ECBehaviorHitScan new (BehaviorElementClass eclass, ECBehaviorCollider collider, ECBehaviorComponent component, String id)
 
ECBehaviorHitScan new (BehaviorElementClass eclass, ECBehaviorCollider collider, ECBehaviorComponent component, String id, String prefix)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
String getBehaviorID ()
 Unique identifier of behavior. More...
 
String getID ()
 Identifier. More...
 
int getInstanceIndex ()
 Instance index. More...
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior. More...
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

static ECBehaviorHitScan getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Public Attributes

ECPString pBone
 
ECBehaviorCollider pCollider
 
ECComposeCollisionFilter pCollisionFilter
 
ECBehaviorComponent pComponent
 
ECPVector pDirection
 
ECPFloat pOffset
 
ECPVector pOrientation
 
ECPVector pOrigin
 
ECPFloat pRange
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior new (BehaviorElementClass eclass)
 Create default composeable behavior with empty identifier. More...
 
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
void setBehaviorID (String identifier)
 Set behavior identifier. More...
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>". More...
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More...
 

Detailed Description

Behavior adding hit-scan support to elements.

Behavior supports using one or more collider collision tests to do one or more hit scans for example to check for weapon projectile impacts. Hit scans are done once then the result can be examine. To use this behavior add ECBehaviorCollider then this behavior. The collider is used to carry the collision tests.

To start a series of hit-scans call one of the start() methods to set up the hit-scans. You can set up the hit-scans manually or use the convenience methods to set up hit-scans matching typical use cases. Starting hit scans has to be done during think() time.

After setting up hit scans during think() the physics module carries out the desired collision tests. The result can be evaluated during the following postThink() or the the next think() call.

A typical scenario is a projectile weapon triggered by the actor. The weapon element has the ECBehaviorHitScan. When the player triggers the weapon the hit-scan is started() in the think() phase and the hits evaluated in the postThink() phase.

// Weapon element befitted with hit-scan support
class MyWeaponClass extends BehaviorElementClass
public var ECBehaviorCollider collider
public var ECBehaviorHitScan hitScan
func new()
collider = ECBehaviorCollider.new(this, null)
hitScan = ECBehaviorHitScan.new(this, collider)
hitScan.getCollisionFilter().setCollisionFilter(...)
end
end
// Player actor action triggering the weapon
class MyPlayerAction extends BAAFirstPerson
func new()
end
public var bool doesFireWeapon
func void think(float elapsed)
super.think(elapsed)
if doesPlayerFireWeapon()
var BehaviorElement weapon = getPlayerWeapon()
ECBehaviorHitScan.getInstanceIn(weapon).start(...)
doesFireWeapon = true
end
end
func void postThink(float elapsed)
super.postThink(elapsed)
if doesFireWeapon
doesFireWeapon = false
var BehaviorElement weapon = getPlayerWeapon()
ECBehaviorHitScan.getInstanceIn(weapon).forEachHit(block ColliderCollisionTest test
// evaluate hits for example damaging first hit for each hit-scan if present
if test.hitCollider(0) != null
var BehaviorElement target = test.hitCollider(0).getOwner() cast BehaviorElement
// damage target
end
end)
end
end
end
ECBehaviorHitScan new(BehaviorElementClass eclass, ECBehaviorCollider collider, ECBehaviorComponent component)
Create behavior element class.
ECComposeCollisionFilter getCollisionFilter()
Collision filter for AI collider.

Another possibility is to create a behavior attached to the weapon element doing the same. This moves the weapon hit and damage logic to a behavior with the actor only triggering the behavior and having nothing to do with it.

Member Function Documentation

◆ dispose()

void Dragengine.Scenery.ECBehaviorHitScan.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getBehaviorIn()

static ECBehaviorHitScan Dragengine.Scenery.ECBehaviorHitScan.getBehaviorIn ( BehaviorElementClass  eclass)
static

Get behavior in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorCollider.

◆ getBone()

ECPString Dragengine.Scenery.ECBehaviorHitScan.getBone ( )

Test bone.

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.ECBehaviorHitScan.getCollider ( )

Collider behavior or null.

◆ getCollisionFilter()

ECComposeCollisionFilter Dragengine.Scenery.ECBehaviorHitScan.getCollisionFilter ( )

Collision filter for AI collider.

◆ getComponent()

ECBehaviorComponent Dragengine.Scenery.ECBehaviorHitScan.getComponent ( )

Component behavior or null.

◆ getDirection()

ECPVector Dragengine.Scenery.ECBehaviorHitScan.getDirection ( )

Normalized test direction.

◆ getOffset()

ECPFloat Dragengine.Scenery.ECBehaviorHitScan.getOffset ( )

Test origin offset.

Version
1.22

◆ getOrientation()

ECPVector Dragengine.Scenery.ECBehaviorHitScan.getOrientation ( )

Test orientation.

◆ getOrigin()

ECPVector Dragengine.Scenery.ECBehaviorHitScan.getOrigin ( )

Test origin.

◆ getRange()

ECPFloat Dragengine.Scenery.ECBehaviorHitScan.getRange ( )

Test range.

◆ instance()

Instance Dragengine.Scenery.ECBehaviorHitScan.instance ( BehaviorElement  element)

Get instance in element from owner element class.

◆ new() [1/3]

ECBehaviorHitScan Dragengine.Scenery.ECBehaviorHitScan.new ( BehaviorElementClass  eclass,
ECBehaviorCollider  collider,
ECBehaviorComponent  component 
)

Create behavior element class.

These values are optional and can be null: component.

◆ new() [2/3]

ECBehaviorHitScan Dragengine.Scenery.ECBehaviorHitScan.new ( BehaviorElementClass  eclass,
ECBehaviorCollider  collider,
ECBehaviorComponent  component,
String  id 
)

◆ new() [3/3]

ECBehaviorHitScan Dragengine.Scenery.ECBehaviorHitScan.new ( BehaviorElementClass  eclass,
ECBehaviorCollider  collider,
ECBehaviorComponent  component,
String  id,
String  prefix 
)

Member Data Documentation

◆ pBone

ECPString Dragengine.Scenery.ECBehaviorHitScan.pBone

◆ pCollider

ECBehaviorCollider Dragengine.Scenery.ECBehaviorHitScan.pCollider

◆ pCollisionFilter

ECComposeCollisionFilter Dragengine.Scenery.ECBehaviorHitScan.pCollisionFilter

◆ pComponent

ECBehaviorComponent Dragengine.Scenery.ECBehaviorHitScan.pComponent

◆ pDirection

ECPVector Dragengine.Scenery.ECBehaviorHitScan.pDirection

◆ pOffset

ECPFloat Dragengine.Scenery.ECBehaviorHitScan.pOffset

◆ pOrientation

ECPVector Dragengine.Scenery.ECBehaviorHitScan.pOrientation

◆ pOrigin

ECPVector Dragengine.Scenery.ECBehaviorHitScan.pOrigin

◆ pRange

ECPFloat Dragengine.Scenery.ECBehaviorHitScan.pRange

The documentation for this class was generated from the following file: