ForgeDocs
Documentation for the forge framework
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Forge.Networking.Chat.ChatManager Class Reference

Contains the core APIS for sending and receiving chat messages. More...

Public Member Functions

 ChatManager (NetworkContext context)
 Construct a new ChatManager using the given networking context and the given object for mapping network players to a directed player relation graph. More...
 
void Dispose ()
 Cleans up the ChatManager from the NetworkContext it was constructed with. More...
 
void SendMessage (string message, List< Player > receivers)
 Send a chat message to all players that have the given relationship with the sending player. More...
 
void SendMessage (string message)
 Sends a chat message to every player. More...
 

Properties

List< ReceivedChatMessageDisplayableMessages [get]
 All of the chat messages that have been received that should be displayed. More...
 
List< ReceivedChatMessageAllMessages [get]
 All received chat messages. More...
 

Detailed Description

Contains the core APIS for sending and receiving chat messages.

Constructor & Destructor Documentation

Forge.Networking.Chat.ChatManager.ChatManager ( NetworkContext  context)

Construct a new ChatManager using the given networking context and the given object for mapping network players to a directed player relation graph.

Parameters
contextThe networking context.

Member Function Documentation

void Forge.Networking.Chat.ChatManager.Dispose ( )

Cleans up the ChatManager from the NetworkContext it was constructed with.

void Forge.Networking.Chat.ChatManager.SendMessage ( string  message,
List< Player receivers 
)

Send a chat message to all players that have the given relationship with the sending player.

Parameters
messageThe message to send.
receiversThe players that should receive the message.
void Forge.Networking.Chat.ChatManager.SendMessage ( string  message)

Sends a chat message to every player.

Parameters
messageThe message to send.

Property Documentation

List<ReceivedChatMessage> Forge.Networking.Chat.ChatManager.AllMessages
get

All received chat messages.

List<ReceivedChatMessage> Forge.Networking.Chat.ChatManager.DisplayableMessages
get

All of the chat messages that have been received that should be displayed.


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