Inheritance diagram for SCR_ChatPanel:

Protected Member Functions
void	OnUpdateChat (float timeSlice)
	This must be called for chat to work. Typically it should be called from HUD Manager or from Menu.
void	OnHUDResize (int newMessageLineCount)
	Adjust the amount of messages shown when the size of the HUD changes.
bool	IsOpen ()
bool	GetFadeOut ()
	True when fading in or when has faded in already.
bool	GetFadeIn ()
	True when fading out or has faded out already.
void	Internal_Open ()
	Don't call it yourself, use SCR_ChatPanelManager instead.
void	Internal_Close ()
	Don't call it yourself, use SCR_ChatPanelManager instead.
void	Internal_OnNewMessage (SCR_ChatMessage msg)
notnull Widget	GetWidget ()
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	UpdateChatMessages ()
void	SendMessage ()
void	CycleChannels (bool next)
	next: true - cycle up, false - cycle down
void	ShowChannelWarning (BaseChatChannel Chatchannel=null, string message="")
string	GetCommand (string s)
string	Internal_GetChannelListHelpMessage ()
	Returns string with help message about available channels.
BaseChatChannel	FindChannelByPrefix (string prefix)
int	GetPlayerIdByName (string name)
void	SetActiveChannel (notnull BaseChatChannel channel, string ReceiverName=string.Empty)
	Switches channels and replaces the channel tag.
void	VerifyChannelStyles ()
SCR_ChatMessageStyle	GetChannelStyle (BaseChatChannel channel)
	Returns style of this channel. If not resolved, returns system style.
SCR_ChatMessageStyle	GetMessageStyle (notnull SCR_ChatMessage msg)
SCR_ChatComponent	GetChatComponent ()
int	GetChannelId (notnull BaseChatChannel channel)
ScriptInvoker	GetOnChatOpen ()
ScriptInvoker	GetOnChatClosed ()
SCR_FadeInOutAnimator	GetFadeInOutAnimator ()
void	Callback_OnPressSpaceAfterCommand ()
	Called by space bar when we change channel by tag.
void	Callback_OnCloseAction ()
	Called when Esc is pressed.
void	Callback_OnSendMessageAction ()
	Called when chat toggle key is pressed.
void	Callback_OnGamepadConfirmAction ()
void	Callback_OnHistoryAction (float value)
	History scrolling.
void	Callback_OnSwitchChannelAction (float value, EActionTrigger reason)
	Channel switching.
void	Callback_OnEditBoxChange ()
	Called when text in the edit box changes.

Protected Attributes
const string	STR_AVAILABLE_CHANNELS = "#AR-Chat_AvailableChannels"
const string	STR_CHANNEL_DISABLED = "#AR-Chat_ChannelDisabled"
const string	STR_CHANNEL_UNKNOWN = "#AR-Chat_ChannelUnknown"
const string	STR_MESSAGE_LIMIT_REACHED = "#AR-Chat_LimitReached"
ref ScriptInvoker	m_OnChatOpen
ref ScriptInvoker	m_OnChatClosed
ref SCR_ChatMessageStyle	m_SystemChannelStyle
ref SCR_ChatMessageStyle	m_RadioProtocolStyle
ref SCR_ChatMessageStyle	m_GlobalChannelStyle
ref SCR_ChatMessageStyle	m_GroupChannelStyle
ref SCR_ChatMessageStyle	m_FactionChannelStyle
ref SCR_ChatMessageStyle	m_VehicleChannelStyle
ref SCR_ChatMessageStyle	m_LocalChannelStyle
ref SCR_ChatMessageStyle	m_DirectChannelStyle
int	m_iMessageLineCount
float	m_fFadeOutThreshold_s
bool	m_bAlwaysVisible
ResourceName	m_sChatMessageLineLayout
int	m_iHistoryId = 0
int	m_iHistoryIdLowestMessage = 0
bool	m_bHistoryMode = false
ref array< SCR_ChatMessageLineComponent >	m_aMessageLines = {}
bool	m_bOpen = false
ScriptedChatEntity	m_ChatEntity
BaseChatChannel	m_ActiveChannel
ref SCR_FadeInOutAnimator	m_MessageHistoryAnimator
Widget	m_wRoot
ref SCR_ChatPanelWidgets	m_Widgets = new SCR_ChatPanelWidgets()
EditBoxFilterComponent	m_MessageEditBoxComponent

Detailed Description

Component which must be attached to chat layout. Use public API to open the chat. It will not open itself. However it will close itself automatically when a message is sent.

Definition at line 6 of file SCR_ChatPanel.c.

Member Function Documentation

◆ Callback_OnCloseAction()

void SCR_ChatPanel::Callback_OnCloseAction ( )

inlineprotected

Called when Esc is pressed.

Definition at line 950 of file SCR_ChatPanel.c.

◆ Callback_OnEditBoxChange()

void SCR_ChatPanel::Callback_OnEditBoxChange ( )

inlineprotected

Called when text in the edit box changes.

Definition at line 1078 of file SCR_ChatPanel.c.

◆ Callback_OnGamepadConfirmAction()

void SCR_ChatPanel::Callback_OnGamepadConfirmAction ( )

inlineprotected

When chat is opened while using gamepad, we don't set focus on edit box, so that player can change channel. Instead focus is set when player uses the ChatConfirm action. Should be mapped only to gamepad.

Definition at line 975 of file SCR_ChatPanel.c.

◆ Callback_OnHistoryAction()

void SCR_ChatPanel::Callback_OnHistoryAction ( float value )

inlineprotected

History scrolling.

Definition at line 991 of file SCR_ChatPanel.c.

◆ Callback_OnPressSpaceAfterCommand()

void SCR_ChatPanel::Callback_OnPressSpaceAfterCommand ( )

inlineprotected

Called by space bar when we change channel by tag.

Definition at line 901 of file SCR_ChatPanel.c.

◆ Callback_OnSendMessageAction()

void SCR_ChatPanel::Callback_OnSendMessageAction ( )

inlineprotected

Called when chat toggle key is pressed.

Definition at line 958 of file SCR_ChatPanel.c.

◆ Callback_OnSwitchChannelAction()

void SCR_ChatPanel::Callback_OnSwitchChannelAction	(	float	value,
		EActionTrigger	reason )

inlineprotected

Channel switching.

Definition at line 1064 of file SCR_ChatPanel.c.

◆ CycleChannels()

void SCR_ChatPanel::CycleChannels ( bool next )

inlineprotected

next: true - cycle up, false - cycle down

Definition at line 512 of file SCR_ChatPanel.c.

◆ FindChannelByPrefix()

BaseChatChannel SCR_ChatPanel::FindChannelByPrefix ( string prefix )

inlineprotected

Definition at line 640 of file SCR_ChatPanel.c.

◆ GetChannelId()

int SCR_ChatPanel::GetChannelId ( notnull BaseChatChannel channel )

inlineprotected

Definition at line 861 of file SCR_ChatPanel.c.

◆ GetChannelStyle()

SCR_ChatMessageStyle SCR_ChatPanel::GetChannelStyle ( BaseChatChannel channel )

inlineprotected

Returns style of this channel. If not resolved, returns system style.

Definition at line 785 of file SCR_ChatPanel.c.

◆ GetChatComponent()

SCR_ChatComponent SCR_ChatPanel::GetChatComponent ( )

inlineprotected

Definition at line 849 of file SCR_ChatPanel.c.

◆ GetCommand()

string SCR_ChatPanel::GetCommand ( string s )

inlineprotected

Returns command from this message string, if it has a command. Otherwise returns empty string. Returned string is always lowercase

Definition at line 575 of file SCR_ChatPanel.c.

◆ GetFadeIn()

bool SCR_ChatPanel::GetFadeIn ( )

inlineprotected

True when fading out or has faded out already.

Definition at line 160 of file SCR_ChatPanel.c.

◆ GetFadeInOutAnimator()

SCR_FadeInOutAnimator SCR_ChatPanel::GetFadeInOutAnimator ( )

inlineprotected

Definition at line 886 of file SCR_ChatPanel.c.

◆ GetFadeOut()

bool SCR_ChatPanel::GetFadeOut ( )

inlineprotected

True when fading in or when has faded in already.

Definition at line 152 of file SCR_ChatPanel.c.

◆ GetMessageStyle()

SCR_ChatMessageStyle SCR_ChatPanel::GetMessageStyle ( notnull SCR_ChatMessage msg )

inlineprotected

Definition at line 826 of file SCR_ChatPanel.c.

◆ GetOnChatClosed()

ScriptInvoker SCR_ChatPanel::GetOnChatClosed ( )

inlineprotected

Definition at line 878 of file SCR_ChatPanel.c.

◆ GetOnChatOpen()

ScriptInvoker SCR_ChatPanel::GetOnChatOpen ( )

inlineprotected

Definition at line 870 of file SCR_ChatPanel.c.

◆ GetPlayerIdByName()

int SCR_ChatPanel::GetPlayerIdByName ( string name )

inlineprotected

Definition at line 667 of file SCR_ChatPanel.c.

◆ GetWidget()

notnull Widget SCR_ChatPanel::GetWidget ( )

inlineprotected

Definition at line 280 of file SCR_ChatPanel.c.

◆ HandlerAttached()

override void SCR_ChatPanel::HandlerAttached ( Widget w )

inlineprotected

Definition at line 286 of file SCR_ChatPanel.c.

◆ HandlerDeattached()

override void SCR_ChatPanel::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 364 of file SCR_ChatPanel.c.

◆ Internal_Close()

void SCR_ChatPanel::Internal_Close ( )

inlineprotected

Don't call it yourself, use SCR_ChatPanelManager instead.

Definition at line 232 of file SCR_ChatPanel.c.

◆ Internal_GetChannelListHelpMessage()

string SCR_ChatPanel::Internal_GetChannelListHelpMessage ( )

inlineprotected

Returns string with help message about available channels.

Definition at line 596 of file SCR_ChatPanel.c.

◆ Internal_OnNewMessage()

void SCR_ChatPanel::Internal_OnNewMessage ( SCR_ChatMessage msg )

inlineprotected

Definition at line 266 of file SCR_ChatPanel.c.

◆ Internal_Open()

void SCR_ChatPanel::Internal_Open ( )

inlineprotected

Don't call it yourself, use SCR_ChatPanelManager instead.

Definition at line 173 of file SCR_ChatPanel.c.

◆ IsOpen()

bool SCR_ChatPanel::IsOpen ( )

inlineprotected

Definition at line 145 of file SCR_ChatPanel.c.

◆ OnHUDResize()

void SCR_ChatPanel::OnHUDResize ( int newMessageLineCount )

inlineprotected

Adjust the amount of messages shown when the size of the HUD changes.

Definition at line 108 of file SCR_ChatPanel.c.

◆ OnUpdateChat()

void SCR_ChatPanel::OnUpdateChat ( float timeSlice )

inlineprotected

This must be called for chat to work. Typically it should be called from HUD Manager or from Menu.

Definition at line 83 of file SCR_ChatPanel.c.

◆ SendMessage()

void SCR_ChatPanel::SendMessage ( )

inlineprotected

Definition at line 448 of file SCR_ChatPanel.c.

◆ SetActiveChannel()

void SCR_ChatPanel::SetActiveChannel	(	notnull BaseChatChannel	channel,
		string	ReceiverName = string.Empty )

inlineprotected

Switches channels and replaces the channel tag.

Definition at line 690 of file SCR_ChatPanel.c.

◆ ShowChannelWarning()

void SCR_ChatPanel::ShowChannelWarning	(	BaseChatChannel	Chatchannel = null,
		string	message = "" )

inlineprotected

Definition at line 560 of file SCR_ChatPanel.c.

◆ UpdateChatMessages()

void SCR_ChatPanel::UpdateChatMessages ( )

inlineprotected

Definition at line 389 of file SCR_ChatPanel.c.

◆ VerifyChannelStyles()

void SCR_ChatPanel::VerifyChannelStyles ( )

inlineprotected

Definition at line 746 of file SCR_ChatPanel.c.

Member Data Documentation

◆ m_ActiveChannel

BaseChatChannel SCR_ChatPanel::m_ActiveChannel

protected

Definition at line 68 of file SCR_ChatPanel.c.

◆ m_aMessageLines

ref array<SCR_ChatMessageLineComponent> SCR_ChatPanel::m_aMessageLines = {}

protected

Definition at line 63 of file SCR_ChatPanel.c.

◆ m_bAlwaysVisible

bool SCR_ChatPanel::m_bAlwaysVisible

protected

Definition at line 54 of file SCR_ChatPanel.c.

◆ m_bHistoryMode

bool SCR_ChatPanel::m_bHistoryMode = false

protected

Definition at line 62 of file SCR_ChatPanel.c.

◆ m_bOpen

bool SCR_ChatPanel::m_bOpen = false

protected

Definition at line 64 of file SCR_ChatPanel.c.

◆ m_ChatEntity

ScriptedChatEntity SCR_ChatPanel::m_ChatEntity

protected

Definition at line 67 of file SCR_ChatPanel.c.

◆ m_DirectChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_DirectChannelStyle

protected

Definition at line 43 of file SCR_ChatPanel.c.

◆ m_FactionChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_FactionChannelStyle

protected

Definition at line 34 of file SCR_ChatPanel.c.

◆ m_fFadeOutThreshold_s

float SCR_ChatPanel::m_fFadeOutThreshold_s

protected

Definition at line 51 of file SCR_ChatPanel.c.

◆ m_GlobalChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_GlobalChannelStyle

protected

Definition at line 28 of file SCR_ChatPanel.c.

◆ m_GroupChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_GroupChannelStyle

protected

Definition at line 31 of file SCR_ChatPanel.c.

◆ m_iHistoryId

int SCR_ChatPanel::m_iHistoryId = 0

protected

Definition at line 60 of file SCR_ChatPanel.c.

◆ m_iHistoryIdLowestMessage

int SCR_ChatPanel::m_iHistoryIdLowestMessage = 0

protected

Definition at line 61 of file SCR_ChatPanel.c.

◆ m_iMessageLineCount

int SCR_ChatPanel::m_iMessageLineCount

protected

Definition at line 48 of file SCR_ChatPanel.c.

◆ m_LocalChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_LocalChannelStyle

protected

Definition at line 40 of file SCR_ChatPanel.c.

◆ m_MessageEditBoxComponent

EditBoxFilterComponent SCR_ChatPanel::m_MessageEditBoxComponent

protected

Definition at line 76 of file SCR_ChatPanel.c.

◆ m_MessageHistoryAnimator

ref SCR_FadeInOutAnimator SCR_ChatPanel::m_MessageHistoryAnimator

protected

Definition at line 71 of file SCR_ChatPanel.c.

◆ m_OnChatClosed

ref ScriptInvoker SCR_ChatPanel::m_OnChatClosed

protected

Definition at line 17 of file SCR_ChatPanel.c.

◆ m_OnChatOpen

ref ScriptInvoker SCR_ChatPanel::m_OnChatOpen

protected

Definition at line 16 of file SCR_ChatPanel.c.

◆ m_RadioProtocolStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_RadioProtocolStyle

protected

Definition at line 25 of file SCR_ChatPanel.c.

◆ m_sChatMessageLineLayout

ResourceName SCR_ChatPanel::m_sChatMessageLineLayout

protected

Definition at line 57 of file SCR_ChatPanel.c.

◆ m_SystemChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_SystemChannelStyle

protected

Definition at line 22 of file SCR_ChatPanel.c.

◆ m_VehicleChannelStyle

ref SCR_ChatMessageStyle SCR_ChatPanel::m_VehicleChannelStyle

protected

Definition at line 37 of file SCR_ChatPanel.c.

◆ m_Widgets

ref SCR_ChatPanelWidgets SCR_ChatPanel::m_Widgets = new SCR_ChatPanelWidgets()

protected

Definition at line 75 of file SCR_ChatPanel.c.

◆ m_wRoot

Widget SCR_ChatPanel::m_wRoot

protected

Definition at line 74 of file SCR_ChatPanel.c.

◆ STR_AVAILABLE_CHANNELS

const string SCR_ChatPanel::STR_AVAILABLE_CHANNELS = "#AR-Chat_AvailableChannels"

protected

Definition at line 10 of file SCR_ChatPanel.c.

◆ STR_CHANNEL_DISABLED

const string SCR_ChatPanel::STR_CHANNEL_DISABLED = "#AR-Chat_ChannelDisabled"

protected

Definition at line 11 of file SCR_ChatPanel.c.

◆ STR_CHANNEL_UNKNOWN

const string SCR_ChatPanel::STR_CHANNEL_UNKNOWN = "#AR-Chat_ChannelUnknown"

protected

Definition at line 12 of file SCR_ChatPanel.c.

◆ STR_MESSAGE_LIMIT_REACHED

const string SCR_ChatPanel::STR_MESSAGE_LIMIT_REACHED = "#AR-Chat_LimitReached"

protected

Definition at line 13 of file SCR_ChatPanel.c.

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

scripts/Game/UI/Chat/SCR_ChatPanel.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ Callback_OnCloseAction()

◆ Callback_OnEditBoxChange()

◆ Callback_OnGamepadConfirmAction()

◆ Callback_OnHistoryAction()

◆ Callback_OnPressSpaceAfterCommand()

◆ Callback_OnSendMessageAction()

◆ Callback_OnSwitchChannelAction()

◆ CycleChannels()

◆ FindChannelByPrefix()

◆ GetChannelId()

◆ GetChannelStyle()

◆ GetChatComponent()

◆ GetCommand()

◆ GetFadeIn()

◆ GetFadeInOutAnimator()

◆ GetFadeOut()

◆ GetMessageStyle()

◆ GetOnChatClosed()

◆ GetOnChatOpen()

◆ GetPlayerIdByName()

◆ GetWidget()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ Internal_Close()

◆ Internal_GetChannelListHelpMessage()

◆ Internal_OnNewMessage()

◆ Internal_Open()

◆ IsOpen()

◆ OnHUDResize()

◆ OnUpdateChat()

◆ SendMessage()

◆ SetActiveChannel()

◆ ShowChannelWarning()

◆ UpdateChatMessages()

◆ VerifyChannelStyles()

Member Data Documentation

◆ m_ActiveChannel

◆ m_aMessageLines

◆ m_bAlwaysVisible

◆ m_bHistoryMode

◆ m_bOpen

◆ m_ChatEntity

◆ m_DirectChannelStyle

◆ m_FactionChannelStyle

◆ m_fFadeOutThreshold_s

◆ m_GlobalChannelStyle

◆ m_GroupChannelStyle

◆ m_iHistoryId

◆ m_iHistoryIdLowestMessage

◆ m_iMessageLineCount

◆ m_LocalChannelStyle

◆ m_MessageEditBoxComponent

◆ m_MessageHistoryAnimator

◆ m_OnChatClosed

◆ m_OnChatOpen

◆ m_RadioProtocolStyle

◆ m_sChatMessageLineLayout

◆ m_SystemChannelStyle

◆ m_VehicleChannelStyle

◆ m_Widgets

◆ m_wRoot

◆ STR_AVAILABLE_CHANNELS

◆ STR_CHANNEL_DISABLED

◆ STR_CHANNEL_UNKNOWN

◆ STR_MESSAGE_LIMIT_REACHED