IAIAction

C++
struct IAIAction {
  enum EActionEvent {
    ActionEnd = 0,
    ActionStart,
    ActionCancel,
    ActionAbort
  };
  struct IAIActionListener {
  };
};
File

IAIAction.h

Description

IAIAction references an Action Flow Graph - ordered sequence of elementary actions which will be executed to "use" a smart object

IAIAction::EActionEvent Enumeration
C++
enum EActionEvent {
  ActionEnd = 0,
  ActionStart,
  ActionCancel,
  ActionAbort
};
File

IAIAction.h

Description

Event names used to inform listeners of an action when the action's state changes

IAIAction::IAIActionListener Structure
C++
struct IAIActionListener {
};
File

IAIAction.h

IAIAction::IAIActionListener::~IAIActionListener Destructor
C++
virtual ~IAIActionListener();
IAIAction::IAIActionListener::OnActionEvent Method
C++
virtual void OnActionEvent(EActionEvent event) = 0;
IAIAction::~IAIAction Destructor
C++
virtual ~IAIAction();
IAIAction::AbortAction Method
C++
virtual bool AbortAction() = 0;
Description

aborts execution of this AI Action - will start clean up procedure

IAIAction::CancelAction Method
C++
virtual void CancelAction() = 0;
Description

cancels execution of this AI Action

IAIAction::EndAction Method
C++
virtual void EndAction() = 0;
Description

ends execution of this AI Action

IAIAction::GetAnimationDir Method
C++
virtual const Vec3& GetAnimationDir() const = 0;
IAIAction::GetAnimationName Method
C++
virtual const char* GetAnimationName() const = 0;
IAIAction::GetAnimationPos Method
C++
virtual const Vec3& GetAnimationPos() const = 0;
IAIAction::GetApproachPos Method
C++
virtual const Vec3& GetApproachPos() const = 0;
IAIAction::GetDirectionTolerance Method
C++
virtual float GetDirectionTolerance() const = 0;
IAIAction::GetFlowGraph Method
C++
virtual IFlowGraph* GetFlowGraph() const = 0;
Description

returns the Flow Graph associated to this AI Action

IAIAction::GetGoalPipe Method
C++
virtual IGoalPipe* GetGoalPipe() const = 0;
Description

returns the goal pipe which executes this AI Action

IAIAction::GetName Method
C++
virtual const char* GetName() const = 0;
Description

returns the unique name of this AI Action

IAIAction::GetObjectEntity Method
C++
virtual IEntity* GetObjectEntity() const = 0;
Description

returns the Object entity associated to this AI Action

IAIAction::GetStartArcAngle Method
C++
virtual float GetStartArcAngle() const = 0;
IAIAction::GetStartWidth Method
C++
virtual float GetStartWidth() const = 0;
IAIAction::GetUserEntity Method
C++
virtual IEntity* GetUserEntity() const = 0;
Description

returns the User entity associated to this AI Action

IAIAction::Invalidate Method
C++
virtual void Invalidate() = 0;
Description

marks this AI Action as modified

IAIAction::IsExactPositioning Method
C++
virtual bool IsExactPositioning() const = 0;
IAIAction::IsHighPriority Method
C++
virtual bool IsHighPriority() const;
Description

returns true if action is active and marked as high priority

IAIAction::IsSignaledAnimation Method
C++
virtual bool IsSignaledAnimation() const = 0;
IAIAction::IsUsingAutoAssetAlignment Method
C++
virtual bool IsUsingAutoAssetAlignment() const = 0;
IAIAction::RegisterListener Method
C++
virtual void RegisterListener(IAIActionListener* eventListener, const char* name) = 0;
IAIAction::TraverseAndValidateAction Method
C++
virtual bool TraverseAndValidateAction(EntityId idOfUser) const = 0;
Description

traverses all nodes of the underlying flow graph and checks for any nodes that are incompatible when being run in the context of an IAIAction

IAIAction::UnregisterListener Method
C++
virtual void UnregisterListener(IAIActionListener* eventListener) = 0;