aom.scripting.ui.console

Class Chat

Object

Chat

public class Chat
extends Object

This class provides a collection of Console commands concerning Chats.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	chat(string text, int player) Adds a line of chat text from the given player (current if not provided).
void	sendChatToAllies(string message) Sends chat to allies.
void	sendChatToEnemies(string message) Sends chat to enemies.
void	sendChatToEveryone(string message) Sends chat to everyone.
void	sendChatToPlayer(int player, string message) Sends chat to given player.
void	sendChatToTeam(int team, string message) Sends chat to a team.
void	uiChatScroll(int nbPagesBack) Navigates through chat history, resetting mode as needed.
void	uiSendIngameChat() Used by the chat input.
void	uiToggleChat() Toggles chat visibility.

Methods inherited from class Object

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

Method Detail

uiChatScroll

public void uiChatScroll(int nbPagesBack)

Navigates through chat history, resetting mode as needed.

Local Call

chat

public void chat(string text,
                 int player)

Adds a line of chat text from the given player (current if not provided).

Local Call

This text won't be transferred over the network to other players.

uiSendIngameChat

public void uiSendIngameChat()

Used by the chat input. Sends a message to the currently selected players. This only sends chats the players with the same (alive/defeated/game-over) state.

Auto Syncs

Transfers the chat message to all intended recipients.

sendChatToEveryone

public void sendChatToEveryone(string message)

Sends chat to everyone.

Auto Syncs

Transfers the chat message to every player.

sendChatToAllies

public void sendChatToAllies(string message)

Sends chat to allies.

Auto Syncs

Transfers the chat message to all allies.

sendChatToEnemies

public void sendChatToEnemies(string message)

Sends chat to enemies.

Auto Syncs

Transfers the chat message to all enemies.

sendChatToPlayer

public void sendChatToPlayer(int player,
                             string message)

Sends chat to given player.

Auto Syncs

Transfers the chat message to the given player.

sendChatToTeam

public void sendChatToTeam(int team,
                           string message)

Sends chat to a team.

Auto Syncs

Transfers the chat message to the given team.

uiToggleChat

public void uiToggleChat()

Toggles chat visibility.

Since:

AoM:EE