Planeshift
PerceptOperation Class Reference

Send a custon perception from a behavior script. More...

#include <npcoperations.h>

Classes

class  DelayedPerceptOperationGameEvent
 

Public Member Functions

virtual bool CheckCondition (NPC *npc)
 
virtual bool Load (iDocumentNode *node)
 
virtual ScriptOperationMakeCopy ()
 
 PerceptOperation ()
 
virtual OperationResult Run (NPC *npc, bool interrupted)
 
virtual ~PerceptOperation ()
 
- Public Member Functions inherited from ScriptOperation
void AddRandomRange (csVector3 &dest, float radius, float margin=0.0)
 Move a point somwhere random within radius of the orignial point. More...
 
virtual OperationResult Advance (float timedelta, NPC *npc)
 
virtual bool AtInterruptedAngle (const csVector3 &pos, const iSector *sector, float angle)
 
virtual bool AtInterruptedAngle (NPC *npc)
 
virtual bool AtInterruptedPosition (const csVector3 &pos, const iSector *sector)
 
virtual bool AtInterruptedPosition (NPC *npc)
 
virtual bool CheckEndPointOk (NPC *npc, const csVector3 &myPos, iSector *mySector, const csVector3 &endPos, iSector *endSector)
 Check if the end point where ok. More...
 
virtual bool CheckMoveOk (NPC *npc, csVector3 oldPos, iSector *oldSector, const csVector3 &newPos, iSector *newSector, int resultFromExtrapolate)
 Check if the move where ok. More...
 
void CopyCheckMoveOk (ScriptOperation *source)
 Copy CheckMoveOk paramters from the source script. More...
 
virtual void Failure (NPC *npc)
 Called when the run operation return OPERATION_FAILED. More...
 
virtual float GetAngularVelocity (NPC *npc)
 
virtual const csString & GetCollisionPerception (NPC *npc)
 Return the Collision perception event name. More...
 
virtual const csString & GetFallingPerception (NPC *npc)
 Return the Falling perception event name. More...
 
virtual const csString & GetInBoundsPerception (NPC *npc)
 Return the In Bounds perception event name. More...
 
virtual const char * GetName () const
 
virtual const csString & GetOutOfBoundsPerception (NPC *npc)
 Return the Out of Bounds perception event name. More...
 
virtual State GetState () const
 
virtual float GetVelocity (NPC *npc)
 Return the velocity for the npc. More...
 
virtual void InterruptOperation (NPC *npc)
 
bool LoadCheckMoveOk (iDocumentNode *node)
 Load attributes for the CheckMoveOk check. More...
 
bool LoadVelocity (iDocumentNode *node)
 
 ScriptOperation (const char *sciptName)
 
 ScriptOperation (const ScriptOperation *other)
 
void SetAnimation (NPC *npc, const char *name)
 This function will set an animation for the NPC, the animation will play once. More...
 
void SetParent (Behavior *behavior)
 Set the parent behavior for this operation. More...
 
virtual void SetState (State state)
 
virtual ~ScriptOperation ()
 

Static Public Member Functions

static void TriggerEvent (NPC *npc, Perception &pcpt, TargetType target, float maxRange)
 

Protected Types

enum  TargetType { SELF, ALL, TRIBE, TARGET }
 

Protected Attributes

MathScriptcalcCondition
 This is the particular calculation for condition. More...
 
csString condition
 A condition for when the perception should be fired. More...
 
csString delayed
 If set this perception should be delayed. More...
 
csString failedPerception
 A perception to fire if the condition fails. More...
 
float maxRange
 Is there a max range for this, 0.0 is without limit. More...
 
csString perception
 The perception name to send. More...
 
TargetType target
 Hold the target for the perception, default SELF. More...
 
csString type
 The type value of the perception. More...
 
- Protected Attributes inherited from ScriptOperation
float ang_vel
 Shared angular velocity, used by all that rotates. More...
 
bool checkTribeHome
 Set to true if the tribe home should be checked by CheckMoveOk. More...
 
csString collision
 Perception names to use for collision detected by CheckMoveOk. More...
 
int consecCollisions
 Shared by move functions. Used by CheckMoveOk to detect collisions. More...
 
csString failurePerception
 The Perception to fire when a operation return OPERATION_FAILED. More...
 
csString falling
 Perception names to use for fall detected by CheckMoveOk. More...
 
csString inBounds
 Perception names to use for in bounds detected by CheckMoveOk. More...
 
float interrupted_angle
 
csVector3 interrupted_position
 
iSector * interrupted_sector
 
csString name
 
csString outOfBounds
 Perception names to use for out of bounds detected by CheckMoveOk. More...
 
Behaviorparent
 
State state
 
float vel
 Shared linear velocity, used by all that moves. More...
 
VelSource velSource
 Source used for velocity. More...
 

Additional Inherited Members

- Public Types inherited from ScriptOperation
enum  OperationResult { OPERATION_NOT_COMPLETED, OPERATION_COMPLETED, OPERATION_FAILED }
 
enum  State { READY_TO_RUN, RUNNING, INTERRUPTED, COMPLETED }
 
enum  VelSource { VEL_DEFAULT, VEL_USER, VEL_WALK, VEL_RUN }
 
- Protected Member Functions inherited from ScriptOperation
int StartMoveTo (NPC *npc, const csVector3 &dest, iSector *sector, float vel, const char *action, float &angle)
 This function is used by MoveTo AND Navigate operations. More...
 
void TurnTo (NPC *npc, const csVector3 &dest, iSector *destsect, csVector3 &forward, float &angle)
 
- Static Protected Member Functions inherited from ScriptOperation
static void StopMovement (NPC *npc)
 Utility function used by many operation to stop movement of an NPC. More...
 

Detailed Description

Send a custon perception from a behavior script.

Will send the custom perception at the given time in the script.

Definition at line 1224 of file npcoperations.h.

Member Enumeration Documentation

Enumerator
SELF 
ALL 
TRIBE 
TARGET 

Definition at line 1227 of file npcoperations.h.

Constructor & Destructor Documentation

PerceptOperation::PerceptOperation ( )
inline

Definition at line 1260 of file npcoperations.h.

virtual PerceptOperation::~PerceptOperation ( )
inlinevirtual

Definition at line 1267 of file npcoperations.h.

Member Function Documentation

virtual bool PerceptOperation::CheckCondition ( NPC npc)
virtual
virtual bool PerceptOperation::Load ( iDocumentNode *  node)
virtual

Reimplemented from ScriptOperation.

virtual ScriptOperation* PerceptOperation::MakeCopy ( )
virtual

Implements ScriptOperation.

virtual OperationResult PerceptOperation::Run ( NPC npc,
bool  interrupted 
)
virtual

Implements ScriptOperation.

static void PerceptOperation::TriggerEvent ( NPC npc,
Perception pcpt,
TargetType  target,
float  maxRange 
)
static

Member Data Documentation

MathScript* PerceptOperation::calcCondition
protected

This is the particular calculation for condition.

Definition at line 1257 of file npcoperations.h.

csString PerceptOperation::condition
protected

A condition for when the perception should be fired.

Definition at line 1253 of file npcoperations.h.

csString PerceptOperation::delayed
protected

If set this perception should be delayed.

Definition at line 1255 of file npcoperations.h.

csString PerceptOperation::failedPerception
protected

A perception to fire if the condition fails.

Definition at line 1254 of file npcoperations.h.

float PerceptOperation::maxRange
protected

Is there a max range for this, 0.0 is without limit.

Definition at line 1252 of file npcoperations.h.

csString PerceptOperation::perception
protected

The perception name to send.

Definition at line 1249 of file npcoperations.h.

TargetType PerceptOperation::target
protected

Hold the target for the perception, default SELF.

Definition at line 1251 of file npcoperations.h.

csString PerceptOperation::type
protected

The type value of the perception.

Definition at line 1250 of file npcoperations.h.


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