Public Member Functions | Public Attributes

VIAgents.AgentStatus Class Reference

Makes the agent aware of it's environment and own state. More...

List of all members.

Public Member Functions

 AgentStatus (InstitutionalAgent inParentAgent)
 The default constructor.
void SetState (String inNewState)
 Set the state of the agent (currently integrates goal + plan).
String GetState ()
 Get the state of the agent (currently integrates goal + plan).
void SetObjectUsed (String inObject, String inObjectUseType)
 Set the active object of the agent and the type of its use.
void SetNoObjectsUsed ()
 Called from outside when the agent doesn't actively use any objects. Will set to use "clothes" with type "wear" as the active object.
List< String > GetObjectsUsed ()
 Get the name of the current object.
void SetCurrentScene (String inSceneName)
 Set the name of the scene the agent is currently playing in.
String GetCurrentScene ()
 Get the name of the scene the agent is currently playing in.
String FindRelativeObject (String inObjectType, int inObjectDirection)
 Get the list of objects relative to this agent's avatar (i.e. on the left, right, east west, etc from it) Example: "Temple34;Ziggurate" = FindRelativeObject("house", kLeft).
override string ToString ()

Public Attributes

const String kEmptyStatus = "none"
const String kHoldObjectUseType = "hold"
const String kWearObjectUseType = "wear"
const String kSitObjectUseType = "sit"
const String kStandObjectUseType = "stand"
const int kLeft = 0
const int kRight = 1
const int kEast = 0
const int kWest = 1
int kVisibilityRadius = 30

Detailed Description

Makes the agent aware of it's environment and own state.


Constructor & Destructor Documentation

VIAgents.AgentStatus.AgentStatus ( InstitutionalAgent  inParentAgent  ) 

The default constructor.


Member Function Documentation

String VIAgents.AgentStatus.FindRelativeObject ( String  inObjectType,
int  inObjectDirection 
)

Get the list of objects relative to this agent's avatar (i.e. on the left, right, east west, etc from it) Example: "Temple34;Ziggurate" = FindRelativeObject("house", kLeft).

Parameters:
inObjectType The type of the object as a String
inObjectDirection The direction relative to the avatar (see direction constants above)
Returns:
The list of objects separated by ";" String
String VIAgents.AgentStatus.GetCurrentScene (  ) 

Get the name of the scene the agent is currently playing in.

Returns:
The name of the scene as a String
List<String> VIAgents.AgentStatus.GetObjectsUsed (  ) 

Get the name of the current object.

///

Returns:
The list of currently used objects List<String>
String VIAgents.AgentStatus.GetState (  ) 

Get the state of the agent (currently integrates goal + plan).

Returns:
The current state as a String
void VIAgents.AgentStatus.SetCurrentScene ( String  inSceneName  ) 

Set the name of the scene the agent is currently playing in.

Parameters:
inSceneName The scene name as a String
void VIAgents.AgentStatus.SetNoObjectsUsed (  ) 

Called from outside when the agent doesn't actively use any objects. Will set to use "clothes" with type "wear" as the active object.

void VIAgents.AgentStatus.SetObjectUsed ( String  inObject,
String  inObjectUseType 
)

Set the active object of the agent and the type of its use.

Parameters:
inObject The name of the object as a String
inObjectUseType The type of object use as a String Note that by default the agent is set to use clothes with type "wear"
void VIAgents.AgentStatus.SetState ( String  inNewState  ) 

Set the state of the agent (currently integrates goal + plan).

Parameters:
inNewState Text description of the new state String
override string VIAgents.AgentStatus.ToString (  ) 

Member Data Documentation

const String VIAgents.AgentStatus.kEmptyStatus = "none"

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