Drag[en]gine Script Module DragonScript  1.23
Dragengine.TriggerSystem.TSTriggerExpressionComponent Class Reference

Component in trigger expression. More...

Inheritance diagram for Dragengine.TriggerSystem.TSTriggerExpressionComponent:

Public Member Functions

void addChild (TSTriggerExpressionComponent child)
 Add child. More...
 
bool containsTarget (TSTriggerTarget target)
 Expression component contains target. More...
 
void dispose ()
 Dispose of trigger expression. More...
 
void forEachChild (Block ablock)
 Visit children with block. More...
 
TSTriggerExpressionComponent getChildAt (int index)
 Child at index. More...
 
int getChildCount ()
 Number of children. More...
 
bool getChildrenOr ()
 Use OR instead of AND for testing child expressions. More...
 
bool getCurState ()
 Use current state instead of trigger having fired at least once. More...
 
bool getNegate ()
 Negate result. More...
 
TSTriggerTarget getTarget ()
 Trigger target or null if not set. More...
 
StringID getTargetName ()
 Trigger name or null if not set. More...
 
TSTriggerExpressionComponent new ()
 Create trigger expression component. More...
 
void removeAllChildren ()
 Remove all children disposing of them. More...
 
void setChildrenOr (bool childrenOr)
 Set if OR instead of AND is used for testing child expressions. More...
 
void setCurState (bool curState)
 Set if current state is used instead of trigger having fired at least once. More...
 
void setNegate (bool negate)
 Set if result is negated. More...
 
void setTarget (TSTriggerTarget target)
 Set trigger target or null if not set. More...
 
void setTargetName (StringID name)
 Set trigger target name or null if not set. More...
 

Detailed Description

Component in trigger expression.

A component composes of a set of parameters defining how the result is evaluated as well as either a trigger name or two child expressions. If the trigger name is set the matching trigger is evaluated. Otherwise the child expressions are evaluated and combined using a logical operator.

Member Function Documentation

◆ addChild()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.addChild ( TSTriggerExpressionComponent  child)

Add child.

◆ containsTarget()

bool Dragengine.TriggerSystem.TSTriggerExpressionComponent.containsTarget ( TSTriggerTarget  target)

Expression component contains target.

◆ dispose()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.dispose ( )

Dispose of trigger expression.

◆ forEachChild()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.forEachChild ( Block  ablock)

Visit children with block.

Block receives argument TSTriggerExpressionComponent.

◆ getChildAt()

TSTriggerExpressionComponent Dragengine.TriggerSystem.TSTriggerExpressionComponent.getChildAt ( int  index)

Child at index.

◆ getChildCount()

int Dragengine.TriggerSystem.TSTriggerExpressionComponent.getChildCount ( )

Number of children.

◆ getChildrenOr()

bool Dragengine.TriggerSystem.TSTriggerExpressionComponent.getChildrenOr ( )

Use OR instead of AND for testing child expressions.

◆ getCurState()

bool Dragengine.TriggerSystem.TSTriggerExpressionComponent.getCurState ( )

Use current state instead of trigger having fired at least once.

◆ getNegate()

bool Dragengine.TriggerSystem.TSTriggerExpressionComponent.getNegate ( )

Negate result.

◆ getTarget()

TSTriggerTarget Dragengine.TriggerSystem.TSTriggerExpressionComponent.getTarget ( )

Trigger target or null if not set.

◆ getTargetName()

StringID Dragengine.TriggerSystem.TSTriggerExpressionComponent.getTargetName ( )

Trigger name or null if not set.

◆ new()

TSTriggerExpressionComponent Dragengine.TriggerSystem.TSTriggerExpressionComponent.new ( )

Create trigger expression component.

◆ removeAllChildren()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.removeAllChildren ( )

Remove all children disposing of them.

◆ setChildrenOr()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.setChildrenOr ( bool  childrenOr)

Set if OR instead of AND is used for testing child expressions.

◆ setCurState()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.setCurState ( bool  curState)

Set if current state is used instead of trigger having fired at least once.

◆ setNegate()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.setNegate ( bool  negate)

Set if result is negated.

◆ setTarget()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.setTarget ( TSTriggerTarget  target)

Set trigger target or null if not set.

◆ setTargetName()

void Dragengine.TriggerSystem.TSTriggerExpressionComponent.setTargetName ( StringID  name)

Set trigger target name or null if not set.


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