Public Member Functions | Public Attributes
RAIN.BehaviorTrees.BTYieldNode Class Reference

BTBreakNode is used to break execution of a behavior tree for improving performance and causing execution to pause and resume next frame. More...

Inheritance diagram for RAIN.BehaviorTrees.BTYieldNode:
RAIN.BehaviorTrees.BTNode RAIN.Action.Action

List of all members.

Public Member Functions

 BTYieldNode (string nodeName)
 Constructor.
override ActionResult Start (Agent agent, float deltaTime)
 Start Action handler.
override ActionResult Execute (Agent agent, float deltaTime)
 Execution causes RUNNING to be returned for a single frame.
override Action.Action.ActionResult Stop (Agent agent, float deltaTime)
 Stop Action handler.

Public Attributes

const string NODETYPE = "yield"
 Node type, used in xml parsing.

Detailed Description

BTBreakNode is used to break execution of a behavior tree for improving performance and causing execution to pause and resume next frame.


Constructor & Destructor Documentation

Constructor.

Parameters:
nodeNameThe name of the node to create

Member Function Documentation

override ActionResult RAIN.BehaviorTrees.BTYieldNode.Execute ( Agent  agent,
float  deltaTime 
) [virtual]

Execution causes RUNNING to be returned for a single frame.

Parameters:
agentAI Agent owner of the behavior tree
deltaTimetimestep in seconds
Returns:
ActionResult, SUCCESS if the expression evaluates to true, FAILURE otherwise

Reimplemented from RAIN.Action.Action.

override ActionResult RAIN.BehaviorTrees.BTYieldNode.Start ( Agent  agent,
float  deltaTime 
) [virtual]

Start Action handler.

Parameters:
agentAI Agent owner of the behavior tree
deltaTimetimestep in seconds
Returns:
ActionResult

Reimplemented from RAIN.Action.Action.

override Action.Action.ActionResult RAIN.BehaviorTrees.BTYieldNode.Stop ( Agent  agent,
float  deltaTime 
) [virtual]

Stop Action handler.

Parameters:
agentAI Agent owner of the behavior tree
deltaTimetimestep in seconds
Returns:
ActionResult

Reimplemented from RAIN.Action.Action.


Member Data Documentation

Node type, used in xml parsing.