Drag[en]gine Script Module DragonScript Script API  1.0
TSTriggerExpressionComponent Class Reference

Component in trigger expression. More...

Inheritance diagram for TSTriggerExpressionComponent:

Public Member Functions

bool containsTarget (TSTriggerTarget target)
 Expression component contains target. More...
 
bool evaluate ()
 Evaluate expression component. More...
 
TSTriggerExpressionComponent getChild1 ()
 First child expression or null if not set. More...
 
TSTriggerExpressionComponent getChild2 ()
 Cecond child expression or null if not set. 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...
 
void linkTriggerTargets (TSTriggerTable triggerTable, TSTriggerListener listener)
 Link trigger targets using trigger table. More...
 
TSTriggerExpressionComponent new ()
 Create trigger expression component. More...
 
void setChild1 (TSTriggerExpressionComponent child)
 Set first child expression or null if not set. More...
 
void setChild2 (TSTriggerExpressionComponent child)
 Set second child expression or null if not set. 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.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ containsTarget()

bool containsTarget ( TSTriggerTarget  target)

Expression component contains target.

§ evaluate()

bool evaluate ( )

Evaluate expression component.

§ getChild1()

First child expression or null if not set.

§ getChild2()

Cecond child expression or null if not set.

§ getChildrenOr()

bool getChildrenOr ( )

Use OR instead of AND for testing child expressions.

§ getCurState()

bool getCurState ( )

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

§ getNegate()

bool getNegate ( )

Negate result.

§ getTarget()

TSTriggerTarget getTarget ( )

Trigger target or null if not set.

§ getTargetName()

StringID getTargetName ( )

Trigger name or null if not set.

§ linkTriggerTargets()

void linkTriggerTargets ( TSTriggerTable  triggerTable,
TSTriggerListener  listener 
)

Link trigger targets using trigger table.

If trigger table is null all trigger targets are unlinked.

§ new()

Create trigger expression component.

§ setChild1()

void setChild1 ( TSTriggerExpressionComponent  child)

Set first child expression or null if not set.

§ setChild2()

void setChild2 ( TSTriggerExpressionComponent  child)

Set second child expression or null if not set.

§ setChildrenOr()

void setChildrenOr ( bool  childrenOr)

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

§ setCurState()

void setCurState ( bool  curState)

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

§ setNegate()

void setNegate ( bool  negate)

Set if result is negated.

§ setTarget()

void setTarget ( TSTriggerTarget  target)

Set trigger target or null if not set.

§ setTargetName()

void setTargetName ( StringID  name)

Set trigger target name or null if not set.


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