ArtificialIntelligence

Object
- ArtificialIntelligence

```
public abstract class ArtificialIntelligence
extends Object
```
This class provides a collection of AI commands that don't fit in any of the subcategories.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Auto Syncs
All AI commands are executed locally on the computer of the host and the results (move, build, train, research, ...) are sent to the participating players.

See Also:

AoM AI Reference, AoT AI Reference

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cAge1` The Archaic Age.
`int`	`cAge2` The Classical Age.
`int`	`cAge3` The Heroic Age.
`int`	`cAge4` The Mythic Age.
`int`	`cAge5` The fifth age, better known as Titan Age.
`int`	`cCivAtlantean` A random Atlantean Major God.
`int`	`cCivEgyptian` A random Egyptian Major God.
`int`	`cCivGaia` The Major God Gaia.
`int`	`cCivGreek` A random Greek Major God
`int`	`cCivHades` The Major God Hades.
`int`	`cCivIsis` The Major God Isis.
`int`	`cCivKronos` The Major God Kronos.
`int`	`cCivLoki` The Major God Loki.
`int`	`cCivNature` The Major God Nature representing Mother Nature.
`int`	`cCivNorse` A random Norse Major God.
`int`	`cCivOdin` The Major God Odin.
`int`	`cCivOuranos` The Major God Ouranos.
`int`	`cCivPoseidon` The Major God Poseidon.
`int`	`cCivRa` The Major God Ra.
`int`	`cCivRandom` A random Major God.
`int`	`cCivSet` The Major God Set.
`int`	`cCivThor` The Major God Thor.
`int`	`cCivZeus` The Major God Zeus.
`int`	`cCultureAtlantean` The Atlantean Culture.
`int`	`cCultureEgyptian` The Egyptian Culture.
`int`	`cCultureGreek` The Greek Culture.
`int`	`cCultureNature` The Nature Culture.
`int`	`cCultureNorse` The Norse Culture.
`int`	`cDifficultyEasy` The easiest difficulty.
`int`	`cDifficultyHard` The hard difficulty.
`int`	`cDifficultyModerate` A moderate difficulty.
`int`	`cDifficultyNightmare` The Hardest difficulty, in AoT better known as "Titan".
`string`	`cFilename` The filename of the current XS script.
`int`	`cGameModeConquest`
`int`	`cGameModeDeathmatch`
`int`	`cGameModeLightning`
`int`	`cGameModeSupremacy`
`vector`	`cInvalidVector` The invalid vector.
`int`	`cMovementTypeAir`
`int`	`cMovementTypeLand`
`int`	`cMovementTypeNone`
`int`	`cMovementTypeNonSolid`
`int`	`cMovementTypeWater`
`int`	`cMyCiv` The civilization ID.
`int`	`cMyCulture` The culture ID.
`int`	`cMyID` The playerID of the player when the game started.
`string`	`cMyName` The nickname of the AI player.
`int`	`cNumberPlayers` The number of players, mother nature included.
`vector`	`cOriginVector` The origin vector.
`int`	`cPlayerRelationAlly`
`int`	`cPlayerRelationAny`
`int`	`cPlayerRelationEnemy`
`int`	`cPlayerRelationSelf`
`string`	`cRandomMapName` The filename of the RMS script (without ".xs"/".xml") associated with the current map.
`int`	`cUnitStanceAggressive` The aggressive unit stance.
`int`	`cUnitStanceDefensive` The defensive unit stance.
`int`	`cUnitStancePassive` The passive stance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`aiAttemptResign()` Asks the player if its ok to resign
`void`	`aiAutoSavegame(string filename)` Saves the auto, debugging savegames.
`void`	`aiBreakpointGo(int playerID)` Deprecated.
`void`	`aiBreakpointSet(int playerID, string filename, int lineNumber, bool on)` Deprecated.
`void`	`aiEcho(string echoString)` CP AI echo.
`void`	`aiErrorMessage(string errorString)` CP AI error.
`bool`	`aiGetAllowBuildings()` Returns allow buildings on/off.
`bool`	`aiGetAutosaveOn()` Returns whether or not its cool to turn AI autosaves on.
`int`	`aiGetCaptainPlayerID(int playerID)` Returns the captain for the given player's team.
`float`	`aiGetExploreDangerThreshold()` Gets the ai's Explore Danger Threshold value.
`int`	`aiGetGameMode()` Returns the game mode.
`int`	`aiGetMaxLOSProtoUnitLimit()` Gets the limit for how many LOS Protounits (e.g.
`bool`	`aiGetPauseAllAgeUpgrades()` Gets the pause all age upgrades flag from the AI.
`string`	`aiGetPersonality()` Gets the player's personality.
`int`	`aiGetPopNeeds()` Gets the current Pop needs of all the plans.
`int`	`aiGetWorldDifficulty()` Returns the world difficulty level.
`string`	`aiGetWorldDifficultyName(int level)` Returns the name of the level.
`int`	`aiGoalGetIDByIndex(int goalType, int goalState, bool active, int index)` Returns the ID of matching goal.
`int`	`aiGoalGetNumber(int goalType, int goalState, bool active)` Returns the number of matching goals.
`bool`	`aiIsMultiplayer()` Returns true, if this is a multiplayer game.
`int`	`aiNumberUnassignedUnits(int typeID)` Returns the number of unassigned units of the given type.
`int`	`aiNumberUnassignedUnitsByGoal(int goalID)` Returns the number of unassigned units based on the goal's unit type(s).
`void`	`aiQueueAutoSavegame(int saveNumber)` Queues the auto savegame.
`int`	`aiRandInt(int max)` Returns a random number (mod'ed by max if provided).
`vector`	`aiRandLocation()` Returns a random location guaranteed to be on the map.
`void`	`aiRandSetSeed(int seed)` Sets the seed of the random number generator.
`void`	`aiResign()` Reigns the current player..
`void`	`aiSet(string filename, int playerID)` Deprecated.
`void`	`aiSetAllowBuildings(bool v)` Sets allow buildings on/off.
`void`	`aiSetDefaultStance(int defaultStance)` Sets your default stance for all of your units.
`bool`	`aiSetExploreDangerThreshold(float value)` Sets the ai's Explore Danger Threshold value.
`void`	`aiSetMaxLOSProtoUnitLimit(int limit)` Sets the limit for how many LOS Protounits (e.g.
`void`	`aiSetPauseAllAgeUpgrades(bool v)` Sets the pause all age upgrades flag in the AI.
`bool`	`aiSetPersonality(string name)` Sets the player's personality.
`void`	`aiSetRandomMap(bool v)` Sets the RM bool in the AI.
`bool`	`aiSetWaterMap()` Tells us if the AI thinks this is a water map or not.
`void`	`aiSetWaterMap(bool v)` Tells the AI if this is a water map or not.
`void`	`aiSetWorldDifficulty(int v)` Sets the world difficulty level.
`void`	`aiSwitchMainBase(int newBaseID, bool force)` Switch the newBaseID to be the main base.
`int`	`aiUnitCreateCheat(int playerID, int protoUnitID, vector position, string name, int numberUnits, int angle)` Creates unit(s) with the given parms.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - cInvalidVector
```
public final vector cInvalidVector
```
    The invalid vector. Equals vector(-1.0, -1.0, -1.0).
  - cOriginVector
```
public final vector cOriginVector
```
    The origin vector. Equals vector(0.0, 0.0, 0.0), the south corner of the map.
  - cNumberPlayers
```
public final int cNumberPlayers
```
    The number of players, mother nature included.
  - cFilename
```
public final string cFilename
```
    The filename of the current XS script.
  - cMyID
```
public final int cMyID
```
    The playerID of the player when the game started. Does not change with xsSetContextPlayer().
  - cMyName
```
public final string cMyName
```
    The nickname of the AI player.
  - cMyCulture
```
public final int cMyCulture
```
    The culture ID.
    
    See Also:
    
    cCultureGreek, cCultureEgyptian, cCultureNorse, cCultureAtlantean, cCultureNature
  - cMyCiv
```
public final int cMyCiv
```
    The civilization ID.
    
    See Also:
    
    cCivZeus, cCivHades, cCivPoseidon, cCivIsis, cCivRa, cCivSet, cCivLoki, cCivThor, cCivOdin, cCivGaia, cCivKronos, cCivOuranos, cCivGreek, cCivNorse, cCivEgyptian, cCivAtlantean, cCivRandom, cCivNature
  - cRandomMapName
```
public final string cRandomMapName
```
    The filename of the RMS script (without ".xs"/".xml") associated with the current map.
  - cCivZeus
```
public final int cCivZeus
```
    The Major God Zeus.
    
    See Also:
    
    Constant Field Values
  - cCivPoseidon
```
public final int cCivPoseidon
```
    The Major God Poseidon.
    
    See Also:
    
    Constant Field Values
  - cCivHades
```
public final int cCivHades
```
    The Major God Hades.
    
    See Also:
    
    Constant Field Values
  - cCivIsis
```
public final int cCivIsis
```
    The Major God Isis.
    
    See Also:
    
    Constant Field Values
  - cCivRa
```
public final int cCivRa
```
    The Major God Ra.
    
    See Also:
    
    Constant Field Values
  - cCivSet
```
public final int cCivSet
```
    The Major God Set.
    
    See Also:
    
    Constant Field Values
  - cCivOdin
```
public final int cCivOdin
```
    The Major God Odin.
    
    See Also:
    
    Constant Field Values
  - cCivThor
```
public final int cCivThor
```
    The Major God Thor.
    
    See Also:
    
    Constant Field Values
  - cCivLoki
```
public final int cCivLoki
```
    The Major God Loki.
    
    See Also:
    
    Constant Field Values
  - cCivKronos
```
public final int cCivKronos
```
    The Major God Kronos.
    
    See Also:
    
    Constant Field Values
  - cCivOuranos
```
public final int cCivOuranos
```
    The Major God Ouranos.
    
    See Also:
    
    Constant Field Values
  - cCivGaia
```
public final int cCivGaia
```
    The Major God Gaia.
    
    See Also:
    
    Constant Field Values
  - cCivRandom
```
public final int cCivRandom
```
    A random Major God.
    
    See Also:
    
    Constant Field Values
  - cCivGreek
```
public final int cCivGreek
```
    A random Greek Major God
    
    See Also:
    
    Constant Field Values
  - cCivNorse
```
public final int cCivNorse
```
    A random Norse Major God.
    
    See Also:
    
    Constant Field Values
  - cCivEgyptian
```
public final int cCivEgyptian
```
    A random Egyptian Major God.
    
    See Also:
    
    Constant Field Values
  - cCivAtlantean
```
public final int cCivAtlantean
```
    A random Atlantean Major God.
    
    See Also:
    
    Constant Field Values
  - cCivNature
```
public final int cCivNature
```
    The Major God Nature representing Mother Nature.
    
    See Also:
    
    Constant Field Values
  - cCultureGreek
```
public final int cCultureGreek
```
    The Greek Culture.
    
    See Also:
    
    Constant Field Values
  - cCultureEgyptian
```
public final int cCultureEgyptian
```
    The Egyptian Culture.
    
    See Also:
    
    Constant Field Values
  - cCultureNorse
```
public final int cCultureNorse
```
    The Norse Culture.
    
    See Also:
    
    Constant Field Values
  - cCultureAtlantean
```
public final int cCultureAtlantean
```
    The Atlantean Culture.
    
    See Also:
    
    Constant Field Values
  - cCultureNature
```
public final int cCultureNature
```
    The Nature Culture.
    
    See Also:
    
    Constant Field Values
  - cUnitStanceAggressive
```
public final int cUnitStanceAggressive
```
    The aggressive unit stance. In this stance units attack any enemy unit that comes into sight.
    
    See Also:
    
    aiSetDefaultStance(int), Constant Field Values
  - cUnitStanceDefensive
```
public final int cUnitStanceDefensive
```
    The defensive unit stance. In this stance units will not leave the area they are defending, even if under attack.
    
    See Also:
    
    aiSetDefaultStance(int), Military.aiSetAttackResponseDistance(float), Constant Field Values
  - cUnitStancePassive
```
public final int cUnitStancePassive
```
    The passive stance. In this stance a unit will not leave his spot, even if under attack. In this stance Economic units will continue doing their task even if under attack.
    
    See Also:
    
    aiSetDefaultStance(int), UnitType.Economic, Constant Field Values
  - cGameModeSupremacy
```
public final int cGameModeSupremacy
```
    See Also:
    
    Constant Field Values
  - cGameModeConquest
```
public final int cGameModeConquest
```
    See Also:
    
    Constant Field Values
  - cGameModeLightning
```
public final int cGameModeLightning
```
    See Also:
    
    Constant Field Values
  - cGameModeDeathmatch
```
public final int cGameModeDeathmatch
```
    See Also:
    
    Constant Field Values
  - cDifficultyEasy
```
public final int cDifficultyEasy
```
    The easiest difficulty.
    
    See Also:
    
    Constant Field Values
  - cDifficultyModerate
```
public final int cDifficultyModerate
```
    A moderate difficulty.
    
    See Also:
    
    Constant Field Values
  - cDifficultyHard
```
public final int cDifficultyHard
```
    The hard difficulty.
    
    See Also:
    
    Constant Field Values
  - cDifficultyNightmare
```
public final int cDifficultyNightmare
```
    The Hardest difficulty, in AoT better known as "Titan".
    
    See Also:
    
    Constant Field Values
  - cAge1
```
public final int cAge1
```
    The Archaic Age.
    
    See Also:
    
    Constant Field Values
  - cAge2
```
public final int cAge2
```
    The Classical Age.
    
    See Also:
    
    Constant Field Values
  - cAge3
```
public final int cAge3
```
    The Heroic Age.
    
    See Also:
    
    Constant Field Values
  - cAge4
```
public final int cAge4
```
    The Mythic Age.
    
    See Also:
    
    Constant Field Values
  - cAge5
```
public final int cAge5
```
    The fifth age, better known as Titan Age.
    
    Since:
    
    AoT
    
    See Also:
    
    Constant Field Values
  - cPlayerRelationAny
```
public final int cPlayerRelationAny
```
    See Also:
    
    Constant Field Values
  - cPlayerRelationSelf
```
public final int cPlayerRelationSelf
```
    See Also:
    
    Constant Field Values
  - cPlayerRelationEnemy
```
public final int cPlayerRelationEnemy
```
    See Also:
    
    Constant Field Values
  - cPlayerRelationAlly
```
public final int cPlayerRelationAlly
```
    See Also:
    
    Constant Field Values
  - cMovementTypeNone
```
public final int cMovementTypeNone
```
    See Also:
    
    Constant Field Values
  - cMovementTypeLand
```
public final int cMovementTypeLand
```
    See Also:
    
    Constant Field Values
  - cMovementTypeWater
```
public final int cMovementTypeWater
```
    See Also:
    
    Constant Field Values
  - cMovementTypeAir
```
public final int cMovementTypeAir
```
    See Also:
    
    Constant Field Values
  - cMovementTypeNonSolid
```
public final int cMovementTypeNonSolid
```
    See Also:
    
    Constant Field Values
- Method Detail
  - aiEcho
```
public void aiEcho(string echoString)
```
    CP AI echo.
  - aiErrorMessage
```
public void aiErrorMessage(string errorString)
```
    CP AI error.
  - aiRandSetSeed
```
public void aiRandSetSeed(int seed)
```
    Sets the seed of the random number generator.
  - aiRandInt
```
public int aiRandInt(int max)
```
    Returns a random number (mod'ed by max if provided).
  - aiRandLocation
```
public vector aiRandLocation()
```
    Returns a random location guaranteed to be on the map.
  - aiSet
```
public void aiSet(string filename,
                  int playerID)
```
    Deprecated.
    
    Sets playerID's AI to the given filename.
  - aiBreakpointSet
```
public void aiBreakpointSet(int playerID,
                            string filename,
                            int lineNumber,
                            bool on)
```
    Deprecated.
    
    Sets a breakpoint.
  - aiBreakpointGo
```
public void aiBreakpointGo(int playerID)
```
    Deprecated.
    
    Restart XS execution after the current breakpoint.
  - aiGetPersonality
```
public string aiGetPersonality()
```
    Gets the player's personality.
  - aiSetPersonality
```
public bool aiSetPersonality(string name)
```
    Sets the player's personality.
  - aiGoalGetNumber
```
public int aiGoalGetNumber(int goalType,
                           int goalState,
                           bool active)
```
    Returns the number of matching goals.
  - aiGoalGetIDByIndex
```
public int aiGoalGetIDByIndex(int goalType,
                              int goalState,
                              bool active,
                              int index)
```
    Returns the ID of matching goal.
  - aiGetAllowBuildings
```
public bool aiGetAllowBuildings()
```
    Returns allow buildings on/off.
  - aiSetAllowBuildings
```
public void aiSetAllowBuildings(bool v)
```
    Sets allow buildings on/off.
  - aiNumberUnassignedUnits
```
public int aiNumberUnassignedUnits(int typeID)
```
    Returns the number of unassigned units of the given type.
  - aiNumberUnassignedUnitsByGoal
```
public int aiNumberUnassignedUnitsByGoal(int goalID)
```
    Returns the number of unassigned units based on the goal's unit type(s).
  - aiUnitCreateCheat
```
public int aiUnitCreateCheat(int playerID,
                             int protoUnitID,
                             vector position,
                             string name,
                             int numberUnits,
                             int angle)
```
    Creates unit(s) with the given parms.
  - aiGetWorldDifficulty
```
public int aiGetWorldDifficulty()
```
    Returns the world difficulty level.
  - aiSetWorldDifficulty
```
public void aiSetWorldDifficulty(int v)
```
    Sets the world difficulty level.
  - aiGetWorldDifficultyName
```
public string aiGetWorldDifficultyName(int level)
```
    Returns the name of the level.
  - aiGetGameMode
```
public int aiGetGameMode()
```
    Returns the game mode.
  - aiGetCaptainPlayerID
```
public int aiGetCaptainPlayerID(int playerID)
```
    Returns the captain for the given player's team.
  - aiAutoSavegame
```
public void aiAutoSavegame(string filename)
```
    Saves the auto, debugging savegames. Does not work.
  - aiGetAutosaveOn
```
public bool aiGetAutosaveOn()
```
    Returns whether or not its cool to turn AI autosaves on.
  - aiSetExploreDangerThreshold
```
public bool aiSetExploreDangerThreshold(float value)
```
    Sets the ai's Explore Danger Threshold value.
  - aiGetExploreDangerThreshold
```
public float aiGetExploreDangerThreshold()
```
    Gets the ai's Explore Danger Threshold value.
  - aiSetRandomMap
```
public void aiSetRandomMap(bool v)
```
    Sets the RM bool in the AI.
  - aiSetPauseAllAgeUpgrades
```
public void aiSetPauseAllAgeUpgrades(bool v)
```
    Sets the pause all age upgrades flag in the AI.
  - aiGetPauseAllAgeUpgrades
```
public bool aiGetPauseAllAgeUpgrades()
```
    Gets the pause all age upgrades flag from the AI.
  - aiResign
```
public void aiResign()
```
    Reigns the current player..
  - aiAttemptResign
```
public void aiAttemptResign()
```
    Asks the player if its ok to resign
  - aiSetMaxLOSProtoUnitLimit
```
public void aiSetMaxLOSProtoUnitLimit(int limit)
```
    Sets the limit for how many LOS Protounits (e.g. obelisks) the AI can build
  - aiGetMaxLOSProtoUnitLimit
```
public int aiGetMaxLOSProtoUnitLimit()
```
    Gets the limit for how many LOS Protounits (e.g. obelisks) the AI can build
  - aiGetPopNeeds
```
public int aiGetPopNeeds()
```
    Gets the current Pop needs of all the plans.
  - aiSwitchMainBase
```
public void aiSwitchMainBase(int newBaseID,
                             bool force)
```
    Switch the newBaseID to be the main base.
  - aiSetDefaultStance
```
public void aiSetDefaultStance(int defaultStance)
```
    Sets your default stance for all of your units.
  - aiSetWaterMap
```
public void aiSetWaterMap(bool v)
```
    Tells the AI if this is a water map or not.
  - aiSetWaterMap
```
public bool aiSetWaterMap()
```
    Tells us if the AI thinks this is a water map or not.
  - aiQueueAutoSavegame
```
public void aiQueueAutoSavegame(int saveNumber)
```
    Queues the auto savegame.
  - aiIsMultiplayer
```
public bool aiIsMultiplayer()
```
    Returns true, if this is a multiplayer game.

Class ArtificialIntelligence

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cInvalidVector

cOriginVector

cNumberPlayers

cFilename

cMyID

cMyName

cMyCulture

cMyCiv

cRandomMapName

cCivZeus

cCivPoseidon

cCivHades

cCivIsis

cCivRa

cCivSet

cCivOdin

cCivThor

cCivLoki

cCivKronos

cCivOuranos

cCivGaia

cCivRandom

cCivGreek

cCivNorse

cCivEgyptian

cCivAtlantean

cCivNature

cCultureGreek

cCultureEgyptian

cCultureNorse

cCultureAtlantean

cCultureNature

cUnitStanceAggressive

cUnitStanceDefensive

cUnitStancePassive

cGameModeSupremacy

cGameModeConquest

cGameModeLightning

cGameModeDeathmatch

cDifficultyEasy

cDifficultyModerate

cDifficultyHard

cDifficultyNightmare

cAge1

cAge2

cAge3

cAge4

cAge5

cPlayerRelationAny

cPlayerRelationSelf

cPlayerRelationEnemy

cPlayerRelationAlly

cMovementTypeNone

cMovementTypeLand

cMovementTypeWater

cMovementTypeAir

cMovementTypeNonSolid

Method Detail

aiEcho

aiErrorMessage

aiRandSetSeed

aiRandInt

aiRandLocation

aiSet

aiBreakpointSet

aiBreakpointGo

aiGetPersonality

aiSetPersonality

aiGoalGetNumber

aiGoalGetIDByIndex

aiGetAllowBuildings

aiSetAllowBuildings

aiNumberUnassignedUnits

aiNumberUnassignedUnitsByGoal

aiUnitCreateCheat