aom.scripting.xs.ai

Class Communication

Object

Communication

public class Communication
extends Object

This class provides a collection of AI commands concerning Communication. An AI can not send a random chat message to human players, only predefined messages. It can communicate with other AIs using a strict protocol.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cAICommPromptAIAttack
int	cAICommPromptAIAttackHere
int	cAICommPromptAIBuildSettlement
int	cAICommPromptAILosingAgeRace
int	cAICommPromptAILostLastSettlement
int	cAICommPromptAILostSettlement
int	cAICommPromptAIResignActiveEnemies
int	cAICommPromptAIResignGatherers
int	cAICommPromptAIResignSettlements
int	cAICommPromptAIRetreat
int	cAICommPromptAITakeWater
int	cAICommPromptAIWinningAgeRace
int	cAICommPromptAIWonderDestroyed
int	cAICommPromptEconomicGodPower
int	cAICommPromptEnemyBuildSettlement
int	cAICommPromptEnemyLostLastSettlement
int	cAICommPromptEnemyLostSettlement
int	cAICommPromptGenericGodPower
int	cAICommPromptHelpHere
int	cAICommPromptHelpHome
int	cAICommPromptIntro
int	cAICommPromptNone
int	cAICommPromptOffensiveGodPower
int	cAICommPromptPlayerBuildingWalls
int	cAICommPromptPlayerWonderDestroyed
int	cAICommPromptResignQuestion
int	cAICommPromptTakingAllyRelic
int	cAICommPromptTakingEnemyRelic
int	cAICommRecordOrder
int	cAICommRecordPrompt
int	cAICommRecordStatement
int	cAICommResponseIncomingOrder
int	cAICommResponseNo
int	cAICommResponseNoneRequired
int	cAICommResponseWaiting
int	cAICommResponseYes

Method Summary

Modifier and Type	Method and Description
void	aiChat(int playerID, string chatString) Deprecated.
long	aiCommsGetRecordData(int id) Get the data of a given record.
long	aiCommsGetRecordPlayerID(int id) Get the player ID of a given record.
vector	aiCommsGetRecordPosition(int id) Get the position of a given record.
long	aiCommsGetRecordPromptType(int id) Get the prompt type of a given record.
long	aiCommsGetRecordResponse(int id) Get the response type of a given record.
long	aiCommsGetRecordType(int id) Get the type of a given record.
long	aiCommsGetResponseData(int id) Get the response data of a given record.
int	aiCommsSendOrder(int targetPlayerID, int promptType, int data1) Sends an order to the designated player.
int	aiCommsSendOrderWithVector(int targetPlayerID, int promptType, int data1, vector position) Sends an order to the designated player.
int	aiCommsSendPrompt(int targetPlayerID, int promptType, int textVariant, float timeout, int yesOrderType, int noOrderType, int data1) Sends a prompt to the designated player and sets up a response.
int	aiCommsSendPromptWithVector(int targetPlayerID, int promptType, int textVariant, float timeout, int yesOrderType, int noOrderType, int data1, vector position) Sends a prompt to the designated player and sets up a response.
int	aiCommsSendStatement(int targetPlayerID, int promptType, int textVariant) Sends a statement to the designated player.
int	aiCommsSendStatementWithVector(int targetPlayerID, int promptType, int textVariant, vector v) Sends a statement to the designated player.
bool	aiCommsSetEventHandler(string handlerFunctionName) Sets the handler for the communications system (invalid name unsets the handler).
bool	aiCommsSetSpecificEventHandler(long recordID, string handlerFunctionName) Sets the handler for a specific chat record in the comms system (invalid name unsets the handler).
void	aiSendChatToAllies(string chatString) Deprecated.
void	aiSendChatToEnemies(string chatString) Deprecated.
void	aiSendChatToEveryone(string chatString) Deprecated.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cAICommPromptNone

public final int cAICommPromptNone

See Also:

Constant Field Values

cAICommPromptAIBuildSettlement

public final int cAICommPromptAIBuildSettlement

See Also:

Constant Field Values

cAICommPromptAIResignGatherers

public final int cAICommPromptAIResignGatherers

See Also:

Constant Field Values

cAICommPromptAIResignSettlements

public final int cAICommPromptAIResignSettlements

See Also:

Constant Field Values

cAICommPromptAIResignActiveEnemies

public final int cAICommPromptAIResignActiveEnemies

See Also:

Constant Field Values

cAICommPromptIntro

public final int cAICommPromptIntro

See Also:

Constant Field Values

cAICommPromptGenericGodPower

public final int cAICommPromptGenericGodPower

See Also:

Constant Field Values

cAICommPromptOffensiveGodPower

public final int cAICommPromptOffensiveGodPower

See Also:

Constant Field Values

cAICommPromptEconomicGodPower

public final int cAICommPromptEconomicGodPower

See Also:

Constant Field Values

cAICommPromptAILostSettlement

public final int cAICommPromptAILostSettlement

See Also:

Constant Field Values

cAICommPromptAILostLastSettlement

public final int cAICommPromptAILostLastSettlement

See Also:

Constant Field Values

cAICommPromptEnemyBuildSettlement

public final int cAICommPromptEnemyBuildSettlement

See Also:

Constant Field Values

cAICommPromptEnemyLostSettlement

public final int cAICommPromptEnemyLostSettlement

See Also:

Constant Field Values

cAICommPromptEnemyLostLastSettlement

public final int cAICommPromptEnemyLostLastSettlement

See Also:

Constant Field Values

cAICommPromptAIWinningAgeRace

public final int cAICommPromptAIWinningAgeRace

See Also:

Constant Field Values

cAICommPromptAILosingAgeRace

public final int cAICommPromptAILosingAgeRace

See Also:

Constant Field Values

cAICommPromptAIWonderDestroyed

public final int cAICommPromptAIWonderDestroyed

See Also:

Constant Field Values

cAICommPromptPlayerWonderDestroyed

public final int cAICommPromptPlayerWonderDestroyed

See Also:

Constant Field Values

cAICommPromptPlayerBuildingWalls

public final int cAICommPromptPlayerBuildingWalls

See Also:

Constant Field Values

cAICommPromptAIAttack

public final int cAICommPromptAIAttack

See Also:

Constant Field Values

cAICommPromptAIAttackHere

public final int cAICommPromptAIAttackHere

See Also:

Constant Field Values

cAICommPromptAIRetreat

public final int cAICommPromptAIRetreat

See Also:

Constant Field Values

cAICommPromptHelpHere

public final int cAICommPromptHelpHere

See Also:

Constant Field Values

cAICommPromptHelpHome

public final int cAICommPromptHelpHome

See Also:

Constant Field Values

cAICommPromptAITakeWater

public final int cAICommPromptAITakeWater

See Also:

Constant Field Values

cAICommPromptTakingEnemyRelic

public final int cAICommPromptTakingEnemyRelic

See Also:

Constant Field Values

cAICommPromptTakingAllyRelic

public final int cAICommPromptTakingAllyRelic

See Also:

Constant Field Values

cAICommPromptResignQuestion

public final int cAICommPromptResignQuestion

See Also:

Constant Field Values

cAICommRecordPrompt

public final int cAICommRecordPrompt

See Also:

Constant Field Values

cAICommRecordOrder

public final int cAICommRecordOrder

See Also:

Constant Field Values

cAICommRecordStatement

public final int cAICommRecordStatement

See Also:

Constant Field Values

cAICommResponseNoneRequired

public final int cAICommResponseNoneRequired

See Also:

Constant Field Values

cAICommResponseWaiting

public final int cAICommResponseWaiting

See Also:

Constant Field Values

cAICommResponseYes

public final int cAICommResponseYes

See Also:

Constant Field Values

cAICommResponseNo

public final int cAICommResponseNo

See Also:

Constant Field Values

cAICommResponseIncomingOrder

public final int cAICommResponseIncomingOrder

See Also:

Constant Field Values

Method Detail

aiCommsGetRecordType

public long aiCommsGetRecordType(int id)

Get the type of a given record.

aiCommsGetRecordPromptType

public long aiCommsGetRecordPromptType(int id)

Get the prompt type of a given record.

aiCommsGetRecordPlayerID

public long aiCommsGetRecordPlayerID(int id)

Get the player ID of a given record.

aiCommsGetRecordResponse

public long aiCommsGetRecordResponse(int id)

Get the response type of a given record.

aiCommsGetResponseData

public long aiCommsGetResponseData(int id)

Get the response data of a given record.

aiCommsGetRecordData

public long aiCommsGetRecordData(int id)

Get the data of a given record.

aiCommsGetRecordPosition

public vector aiCommsGetRecordPosition(int id)

Get the position of a given record.

aiCommsSendPromptWithVector

public int aiCommsSendPromptWithVector(int targetPlayerID,
                                       int promptType,
                                       int textVariant,
                                       float timeout,
                                       int yesOrderType,
                                       int noOrderType,
                                       int data1,
                                       vector position)

Sends a prompt to the designated player and sets up a response.

aiCommsSendPrompt

public int aiCommsSendPrompt(int targetPlayerID,
                             int promptType,
                             int textVariant,
                             float timeout,
                             int yesOrderType,
                             int noOrderType,
                             int data1)

Sends a prompt to the designated player and sets up a response.

aiCommsSendOrderWithVector

public int aiCommsSendOrderWithVector(int targetPlayerID,
                                      int promptType,
                                      int data1,
                                      vector position)

Sends an order to the designated player.

aiCommsSendOrder

public int aiCommsSendOrder(int targetPlayerID,
                            int promptType,
                            int data1)

Sends an order to the designated player.

aiCommsSendStatement

public int aiCommsSendStatement(int targetPlayerID,
                                int promptType,
                                int textVariant)

Sends a statement to the designated player.

aiCommsSendStatementWithVector

public int aiCommsSendStatementWithVector(int targetPlayerID,
                                          int promptType,
                                          int textVariant,
                                          vector v)

Sends a statement to the designated player. Adds a location flare.

aiCommsSetEventHandler

public bool aiCommsSetEventHandler(string handlerFunctionName)

Sets the handler for the communications system (invalid name unsets the handler).

aiCommsSetSpecificEventHandler

public bool aiCommsSetSpecificEventHandler(long recordID,
                                           string handlerFunctionName)

Sets the handler for a specific chat record in the comms system (invalid name unsets the handler).

aiChat

public void aiChat(int playerID,
                   string chatString)

Deprecated.

CP AI chat to playerID.

aiSendChatToEveryone

public void aiSendChatToEveryone(string chatString)

Deprecated.

CP AI chat to everyone.

aiSendChatToAllies

public void aiSendChatToAllies(string chatString)

Deprecated.

CP AI chat to allies.

aiSendChatToEnemies

public void aiSendChatToEnemies(string chatString)

Deprecated.

CP AI chat to enemies.