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

Composable force field for element class. More...

Inheritance diagram for Dragengine.Scenery.ECComposeForceField:

Public Member Functions

void collisionCategoryClearBit (int bit)
 Convience function clearing bit in collision category. More...
 
void collisionCategoryReplace (LayerMask layerMask)
 Convience function replacing collision category. More...
 
void collisionCategorySetBit (int bit)
 Convience function setting bit in collision category. More...
 
void collisionFilterClearBit (int bit)
 Convience function clearing bit in collision filter. More...
 
void collisionFilterSetBit (int bit)
 Convience function setting bit in collision filter. More...
 
ForceField createForceField (Element element, StubElement stub)
 Initialize force field for element from stub. More...
 
TSTriggerExpression createTriggerEnable (Element element, StubElement stub)
 Create activate force field trigger expression from stub or null if not used. More...
 
TSTriggerExpression createTriggerEnable (Element element, StubElement stub, String defaultValue)
 Create activate force field trigger expression from stub or null if not used. More...
 
ECPEnumeration getApplicationType ()
 Force application type. More...
 
CollisionFilter getCollisionFilter ()
 Collision filter. More...
 
ECPVector getDirection ()
 Force direction. More...
 
ECPBoolean getEnabled ()
 Initial force field enabled state. More...
 
ECPFloat getExponent ()
 Falloff exponent. More...
 
ECPEnumeration getFieldType ()
 Field type. More...
 
ECPFloat getFluctuationDirection ()
 Fluctuation of direction in degrees. More...
 
ECPFloat getFluctuationForce ()
 Fluctuation of force in newton. More...
 
ECPFloat getForce ()
 Force in newton. More...
 
ECPShapeList getInfluenceArea ()
 Influence area. More...
 
String getPrefix ()
 Property prefix. More...
 
ECPFloat getRadius ()
 Falloff radius. More...
 
ECPShapeList getShape ()
 Speaker shape. More...
 
ECComposeForceField new (ElementClass ownerClass)
 Create composable element class. More...
 
ECComposeForceField new (ElementClass ownerClass, String prefix)
 Create composable element class. More...
 
void setCollisionFilter (CollisionFilter collisionFilter)
 Set collision filter. More...
 

Detailed Description

Composable force field for element class.

Provides force field support to element class without subclassing from a specific class.

Member Function Documentation

◆ collisionCategoryClearBit()

void Dragengine.Scenery.ECComposeForceField.collisionCategoryClearBit ( int  bit)

Convience function clearing bit in collision category.

◆ collisionCategoryReplace()

void Dragengine.Scenery.ECComposeForceField.collisionCategoryReplace ( LayerMask  layerMask)

Convience function replacing collision category.

◆ collisionCategorySetBit()

void Dragengine.Scenery.ECComposeForceField.collisionCategorySetBit ( int  bit)

Convience function setting bit in collision category.

◆ collisionFilterClearBit()

void Dragengine.Scenery.ECComposeForceField.collisionFilterClearBit ( int  bit)

Convience function clearing bit in collision filter.

◆ collisionFilterSetBit()

void Dragengine.Scenery.ECComposeForceField.collisionFilterSetBit ( int  bit)

Convience function setting bit in collision filter.

◆ createForceField()

ForceField Dragengine.Scenery.ECComposeForceField.createForceField ( Element  element,
StubElement  stub 
)

Initialize force field for element from stub.

◆ createTriggerEnable() [1/2]

TSTriggerExpression Dragengine.Scenery.ECComposeForceField.createTriggerEnable ( Element  element,
StubElement  stub 
)

Create activate force field trigger expression from stub or null if not used.

◆ createTriggerEnable() [2/2]

TSTriggerExpression Dragengine.Scenery.ECComposeForceField.createTriggerEnable ( Element  element,
StubElement  stub,
String  defaultValue 
)

Create activate force field trigger expression from stub or null if not used.

◆ getApplicationType()

ECPEnumeration Dragengine.Scenery.ECComposeForceField.getApplicationType ( )

Force application type.

◆ getCollisionFilter()

CollisionFilter Dragengine.Scenery.ECComposeForceField.getCollisionFilter ( )

Collision filter.

◆ getDirection()

ECPVector Dragengine.Scenery.ECComposeForceField.getDirection ( )

Force direction.

◆ getEnabled()

ECPBoolean Dragengine.Scenery.ECComposeForceField.getEnabled ( )

Initial force field enabled state.

◆ getExponent()

ECPFloat Dragengine.Scenery.ECComposeForceField.getExponent ( )

Falloff exponent.

◆ getFieldType()

ECPEnumeration Dragengine.Scenery.ECComposeForceField.getFieldType ( )

Field type.

◆ getFluctuationDirection()

ECPFloat Dragengine.Scenery.ECComposeForceField.getFluctuationDirection ( )

Fluctuation of direction in degrees.

◆ getFluctuationForce()

ECPFloat Dragengine.Scenery.ECComposeForceField.getFluctuationForce ( )

Fluctuation of force in newton.

◆ getForce()

ECPFloat Dragengine.Scenery.ECComposeForceField.getForce ( )

Force in newton.

◆ getInfluenceArea()

ECPShapeList Dragengine.Scenery.ECComposeForceField.getInfluenceArea ( )

Influence area.

◆ getPrefix()

String Dragengine.Scenery.ECComposeForceField.getPrefix ( )

Property prefix.

◆ getRadius()

ECPFloat Dragengine.Scenery.ECComposeForceField.getRadius ( )

Falloff radius.

◆ getShape()

ECPShapeList Dragengine.Scenery.ECComposeForceField.getShape ( )

Speaker shape.

◆ new() [1/2]

ECComposeForceField Dragengine.Scenery.ECComposeForceField.new ( ElementClass  ownerClass)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [2/2]

ECComposeForceField Dragengine.Scenery.ECComposeForceField.new ( ElementClass  ownerClass,
String  prefix 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ setCollisionFilter()

void Dragengine.Scenery.ECComposeForceField.setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter.


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