Agent python
From WiCWiki
|
Agent
The building wraps a building for use from Python.
Members
Heading
- Type
- float
- Description
- The direction the Agent is facing.
LosDisabled
- Type
- bool
- Description
- This flag can make a unit invisible by disabling it's LOS.
Owner
- Type
- Player
- Description
- The player who currently owns the building. Can be None.
Methods
GetAgentID
- Syntax
import wic wic.game.Agent.GetAgentID()
- Description
- Returns the Id of this Agent.
- Exceptions
- -
- See also
- -
GetHealth
- Syntax
import wic wic.game.Agent.GetHealth()
- Description
- Returns the current health of this Agent.
- Exceptions
- -
- See also
- -
GetName
- Syntax
import wic wic.game.Agent.GetName()
- Description
- Returns the hashed name of this Agent.
- Exceptions
- -
- See also
- -
GetHeading
- Syntax
import wic wic.game.Agent.GetHeading()
- Description
- Returns the current #Heading of this Agent.
- Exceptions
- -
- See also
- -
IsLosDisabled
- Syntax
import wic wic.game.Agent.IsLosDisabled()
- Description
- Tells whether this Agent is invisible or not.
- Exceptions
- -
- See also
- -
IsAlly
- Syntax
import wic wic.game.Agent.IsAlly( anAlly )
- Description
- Returns True if anAlly is an ally of this Agent.
- Exceptions
- TypeError
- anAlly isn't an Agent, a Team (int) or a Player.
- See also
- #IsEnemy
IsEnemy
- Syntax
import wic wic.game.Agent.IsEnemy( anEnemy )
- Description
- Returns True if anEnemy is an enemy of this Agent
- Exceptions
- TypeError
- aEnemy is not an Agent nor a Player.
- See also
- #IsAlly
IsNeutral
- Syntax
- Description
- Returns True if this Agent is neutral.
- Exceptions
- -
Track
- Syntax
import wic wic.game.Agent.Track( someTrackingFlags )
- Description
- Tells the Agent to report extra events to Python. These events are very verbose and unnecessary tracking can cause severe performance issues.
- Exceptions
- TypeError
- someTrackingFlags isn't Tracking Flags
- See also
- -
Untrack
- Syntax
import wic wic.game.Agent.UnTrack( someTrackingFlags )
- Description
- Tells the agent to stop reporting some verbose events to Python. Remember to UnTrack events that you do not have scripts depending on to keep up the performance of the game.
- Exceptions
- TypeError
- someTrackingFlags isn't Tracking Flags.
- See also
- -
Files
- /wic/ex_game/wicg_mpycagent.h
- /wic/ex_game/wicg_mpycagent.cpp