Inheritance diagram for SCR_ChatPanelManager:

Protected Member Functions
void	OpenChatPanel (notnull SCR_ChatPanel panel)
	Opens the chat panel and ensures that all other panels are closed.
void	CloseChatPanel (notnull SCR_ChatPanel panel)
	Closes the chat panel.
void	ToggleChatPanel (notnull SCR_ChatPanel panel)
	Toggles the chat panel: opens if it's closed, closes if it's open.
void	OnMenuClosed ()
void	ShowAllChatPanels ()
void	ShowChatPanel (notnull SCR_ChatPanel panel)
void	HideAllChatPanels ()
void	CloseAllChatPanels ()
array< ref SCR_ChatMessage >	GetMessages ()
	Returns the array of messages. Array is not a copy, so be careful.
array< string >	GetAllRegisteredCommands ()
	Returns an array of all commands registered with GetCommandInvoker.
void	ShowHelpMessage (string msg)
ChatCommandInvoker	GetCommandInvoker (string name)
bool	GetAnyPanelFadedIn ()
	Returns true when there is any chat panel faded in.
void	Register (SCR_ChatPanel panel)
	Registration of chat panels. These are called when a chat panel is created and destroyed.
void	Unregister (SCR_ChatPanel panel)
void	OnNewMessagePrivate (string msg, int senderId, int receiverId)
	Handling of new messages. Called by SCR_ChatComponent.
void	OnNewMessageRadioProtocol (string msg, int frequency)
void	OnNewMessageGeneral (string msg, int channelId, int senderId)
void	OnNewMessage (string msg)
override void	OnGameStart ()
	Initializaiton.
override void	OnGameEnd ()
void	InitDefaultChatCommands ()
void	Internal_EnableAllChannels ()
	Enables all channels.
void	Internal_OnChatCommand (SCR_ChatPanel panel, string command, string otherData)
	OTHER.
void	OnNewMessage (SCR_ChatMessage msg)
void	OnMessageFiltered (SCR_ProfanityFilterRequestCallback callback, array< string > filteredTexts, SCR_ChatMessage originalMessage)

Static Protected Member Functions
static SCR_ChatPanelManager	GetInstance ()
	Returns SCR_ChatPanelManager instance.

Protected Attributes
const int	CHAT_HISTORY_SIZE = 256
const string	CHAT_COMMAND_CHARACTER = "/"
bool	m_bInitDone = false
ref array< ref SCR_ChatMessage >	m_aMessages = {}
ref array< SCR_ChatPanel >	m_aChatPanels = {}
ref array< ref SCR_ProfanityFilterRequestCallback >	m_aProfanityCallbacks = {}
ref map< string, ref ChatCommandInvoker >	m_mCommands = new map<string, ref ScriptInvokerBase<ChatCommandCallback>>
ScriptedChatEntity	m_ChatEntity

Detailed Description

Singleton object to which SCR_ChatPanels get registered/unregistered. It stores message history and receives messages from SCR_ChatComponent.

Definition at line 12 of file SCR_ChatPanelManager.c.

Member Function Documentation

◆ CloseAllChatPanels()

void SCR_ChatPanelManager::CloseAllChatPanels ( )

inlineprotected

Definition at line 115 of file SCR_ChatPanelManager.c.

◆ CloseChatPanel()

void SCR_ChatPanelManager::CloseChatPanel ( notnull SCR_ChatPanel panel )

inlineprotected

Closes the chat panel.

Definition at line 56 of file SCR_ChatPanelManager.c.

◆ GetAllRegisteredCommands()

array< string > SCR_ChatPanelManager::GetAllRegisteredCommands ( )

inlineprotected

Returns an array of all commands registered with GetCommandInvoker.

Definition at line 144 of file SCR_ChatPanelManager.c.

◆ GetAnyPanelFadedIn()

bool SCR_ChatPanelManager::GetAnyPanelFadedIn ( )

inlineprotected

Returns true when there is any chat panel faded in.

Definition at line 189 of file SCR_ChatPanelManager.c.

◆ GetCommandInvoker()

ChatCommandInvoker SCR_ChatPanelManager::GetCommandInvoker ( string name )

inlineprotected

Returns a script invoker for provided chat command, or creates a new one. This way other systems can create chat commands and subscribe to them.

Definition at line 165 of file SCR_ChatPanelManager.c.

◆ GetInstance()

SCR_ChatPanelManager SCR_ChatPanelManager::GetInstance ( )

inlinestaticprotected

Returns SCR_ChatPanelManager instance.

Definition at line 127 of file SCR_ChatPanelManager.c.

◆ GetMessages()

array< ref SCR_ChatMessage > SCR_ChatPanelManager::GetMessages ( )

inlineprotected

Returns the array of messages. Array is not a copy, so be careful.

Definition at line 135 of file SCR_ChatPanelManager.c.

◆ HideAllChatPanels()

void SCR_ChatPanelManager::HideAllChatPanels ( )

inlineprotected

Definition at line 106 of file SCR_ChatPanelManager.c.

◆ InitDefaultChatCommands()

void SCR_ChatPanelManager::InitDefaultChatCommands ( )

inlineprotected

Definition at line 309 of file SCR_ChatPanelManager.c.

◆ Internal_EnableAllChannels()

void SCR_ChatPanelManager::Internal_EnableAllChannels ( )

inlineprotected

Enables all channels.

Definition at line 315 of file SCR_ChatPanelManager.c.

◆ Internal_OnChatCommand()

void SCR_ChatPanelManager::Internal_OnChatCommand	(	SCR_ChatPanel	panel,
		string	command,
		string	otherData )

inlineprotected

OTHER.

Called from a chat pannel when it detects that user sends a chat command.

Definition at line 340 of file SCR_ChatPanelManager.c.

◆ OnGameEnd()

override void SCR_ChatPanelManager::OnGameEnd ( )

inlineprotected

Definition at line 303 of file SCR_ChatPanelManager.c.

◆ OnGameStart()

override void SCR_ChatPanelManager::OnGameStart ( )

inlineprotected

Initializaiton.

Definition at line 286 of file SCR_ChatPanelManager.c.

◆ OnMenuClosed()

void SCR_ChatPanelManager::OnMenuClosed ( )

inlineprotected

Definition at line 82 of file SCR_ChatPanelManager.c.

◆ OnMessageFiltered()

void SCR_ChatPanelManager::OnMessageFiltered	(	SCR_ProfanityFilterRequestCallback	callback,
		array< string >	filteredTexts,
		SCR_ChatMessage	originalMessage )

inlineprotected

Notify all registered chat panels

Definition at line 371 of file SCR_ChatPanelManager.c.

◆ OnNewMessage() [1/2]

void SCR_ChatPanelManager::OnNewMessage ( SCR_ChatMessage msg )

inlineprotected

Definition at line 357 of file SCR_ChatPanelManager.c.

◆ OnNewMessage() [2/2]

void SCR_ChatPanelManager::OnNewMessage ( string msg )

inlineprotected

Definition at line 271 of file SCR_ChatPanelManager.c.

◆ OnNewMessageGeneral()

void SCR_ChatPanelManager::OnNewMessageGeneral	(	string	msg,
		int	channelId,
		int	senderId )

inlineprotected

Definition at line 258 of file SCR_ChatPanelManager.c.

◆ OnNewMessagePrivate()

void SCR_ChatPanelManager::OnNewMessagePrivate	(	string	msg,
		int	senderId,
		int	receiverId )

inlineprotected

Handling of new messages. Called by SCR_ChatComponent.

Definition at line 226 of file SCR_ChatPanelManager.c.

◆ OnNewMessageRadioProtocol()

void SCR_ChatPanelManager::OnNewMessageRadioProtocol	(	string	msg,
		int	frequency )

inlineprotected

Definition at line 248 of file SCR_ChatPanelManager.c.

◆ OpenChatPanel()

void SCR_ChatPanelManager::OpenChatPanel ( notnull SCR_ChatPanel panel )

inlineprotected

Opens the chat panel and ensures that all other panels are closed.

Definition at line 41 of file SCR_ChatPanelManager.c.

◆ Register()

void SCR_ChatPanelManager::Register ( SCR_ChatPanel panel )

inlineprotected

Registration of chat panels. These are called when a chat panel is created and destroyed.

Definition at line 205 of file SCR_ChatPanelManager.c.

◆ ShowAllChatPanels()

void SCR_ChatPanelManager::ShowAllChatPanels ( )

inlineprotected

Definition at line 91 of file SCR_ChatPanelManager.c.

◆ ShowChatPanel()

void SCR_ChatPanelManager::ShowChatPanel ( notnull SCR_ChatPanel panel )

inlineprotected

Definition at line 100 of file SCR_ChatPanelManager.c.

◆ ShowHelpMessage()

void SCR_ChatPanelManager::ShowHelpMessage ( string msg )

inlineprotected

Definition at line 154 of file SCR_ChatPanelManager.c.

◆ ToggleChatPanel()

void SCR_ChatPanelManager::ToggleChatPanel ( notnull SCR_ChatPanel panel )

inlineprotected

Toggles the chat panel: opens if it's closed, closes if it's open.

Definition at line 65 of file SCR_ChatPanelManager.c.

◆ Unregister()

void SCR_ChatPanelManager::Unregister ( SCR_ChatPanel panel )

inlineprotected

Definition at line 214 of file SCR_ChatPanelManager.c.

Member Data Documentation

◆ CHAT_COMMAND_CHARACTER

const string SCR_ChatPanelManager::CHAT_COMMAND_CHARACTER = "/"

protected

Definition at line 21 of file SCR_ChatPanelManager.c.

◆ CHAT_HISTORY_SIZE

const int SCR_ChatPanelManager::CHAT_HISTORY_SIZE = 256

protected

Definition at line 17 of file SCR_ChatPanelManager.c.

◆ m_aChatPanels

ref array<SCR_ChatPanel> SCR_ChatPanelManager::m_aChatPanels = {}

protected

Definition at line 27 of file SCR_ChatPanelManager.c.

◆ m_aMessages

ref array<ref SCR_ChatMessage> SCR_ChatPanelManager::m_aMessages = {}

protected

Definition at line 26 of file SCR_ChatPanelManager.c.

◆ m_aProfanityCallbacks

ref array<ref SCR_ProfanityFilterRequestCallback> SCR_ChatPanelManager::m_aProfanityCallbacks = {}

protected

Definition at line 28 of file SCR_ChatPanelManager.c.

◆ m_bInitDone

bool SCR_ChatPanelManager::m_bInitDone = false

protected

Definition at line 24 of file SCR_ChatPanelManager.c.

◆ m_ChatEntity

ScriptedChatEntity SCR_ChatPanelManager::m_ChatEntity

protected

Definition at line 33 of file SCR_ChatPanelManager.c.

◆ m_mCommands

ref map<string, ref ChatCommandInvoker> SCR_ChatPanelManager::m_mCommands = new map<string, ref ScriptInvokerBase<ChatCommandCallback>>

protected

Definition at line 31 of file SCR_ChatPanelManager.c.

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

scripts/Game/UI/Chat/SCR_ChatPanelManager.c

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ CloseAllChatPanels()

◆ CloseChatPanel()

◆ GetAllRegisteredCommands()

◆ GetAnyPanelFadedIn()

◆ GetCommandInvoker()

◆ GetInstance()

◆ GetMessages()

◆ HideAllChatPanels()

◆ InitDefaultChatCommands()

◆ Internal_EnableAllChannels()

◆ Internal_OnChatCommand()

◆ OnGameEnd()

◆ OnGameStart()

◆ OnMenuClosed()

◆ OnMessageFiltered()

◆ OnNewMessage() [1/2]

◆ OnNewMessage() [2/2]

◆ OnNewMessageGeneral()

◆ OnNewMessagePrivate()

◆ OnNewMessageRadioProtocol()

◆ OpenChatPanel()

◆ Register()

◆ ShowAllChatPanels()

◆ ShowChatPanel()

◆ ShowHelpMessage()

◆ ToggleChatPanel()

◆ Unregister()

Member Data Documentation

◆ CHAT_COMMAND_CHARACTER

◆ CHAT_HISTORY_SIZE

◆ m_aChatPanels

◆ m_aMessages

◆ m_aProfanityCallbacks

◆ m_bInitDone

◆ m_ChatEntity

◆ m_mCommands