SCR_ChatMessageLineComponent Class Reference

Inheritance diagram for SCR_ChatMessageLineComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
Color	GetTextColor (notnull SCR_ChatMessageStyle style, SCR_Faction senderFaction=null, int senderId=-1)
Color	GetBadgeColor (notnull SCR_ChatMessageStyle style, SCR_Faction senderFaction=null, SCR_Faction localFaction=null, int senderId=-1)
Color	GetBackgroundColor (notnull SCR_ChatMessageStyle style, SCR_Faction senderFaction=null, SCR_Faction localFaction=null, int senderId=-1)
void	SetMessage (notnull SCR_ChatMessage msg, notnull SCR_ChatMessageStyle style)
void	SetEmptyMessage ()
void	SetVisible (bool visible)
Widget	GetRootWidget ()

Protected Attributes
ref SCR_ChatMessageLineWidgets	m_Widgets = new SCR_ChatMessageLineWidgets()
ResourceName	CHAT_IMAGESET = "{1872FFA1133724A2}UI/Textures/Chat/chat.imageset"
Widget	m_wRoot

Detailed Description

Definition at line 1 of file SCR_ChatMessageLineComponent.c.

Member Function Documentation

GetBackgroundColor()

Color SCR_ChatMessageLineComponent::GetBackgroundColor ( notnull SCR_ChatMessageStyle style, SCR_Faction senderFaction = null, SCR_Faction localFaction = null, int senderId = -1 )

inlineprotected

Retrieves a copy of the color that should be used for the background of the message

Parameters

[in]	style
[in]	senderFaction
[in]	localFaction
[in]	senderId

Definition at line 71 of file SCR_ChatMessageLineComponent.c.

GetBadgeColor()

Color SCR_ChatMessageLineComponent::GetBadgeColor ( notnull SCR_ChatMessageStyle style, SCR_Faction senderFaction = null, SCR_Faction localFaction = null, int senderId = -1 )

inlineprotected

Retrieves a copy of the color that should be used for the badge of the message

Parameters

[in]	style
[in]	senderFaction
[in]	localFaction
[in]	senderId

Definition at line 39 of file SCR_ChatMessageLineComponent.c.

GetRootWidget()

Widget SCR_ChatMessageLineComponent::GetRootWidget ( )

inlineprotected

Returns

Definition at line 175 of file SCR_ChatMessageLineComponent.c.

GetTextColor()

Color SCR_ChatMessageLineComponent::GetTextColor ( notnull SCR_ChatMessageStyle style, SCR_Faction senderFaction = null, int senderId = -1 )

inlineprotected

Retrieves a copy of the color that should be used for the text of the message

Parameters

[in]	style
[in]	senderFaction
[in]	senderId

Definition at line 22 of file SCR_ChatMessageLineComponent.c.

HandlerAttached()

override void SCR_ChatMessageLineComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 10 of file SCR_ChatMessageLineComponent.c.

SetEmptyMessage()

void SCR_ChatMessageLineComponent::SetEmptyMessage ( )

inlineprotected

Definition at line 156 of file SCR_ChatMessageLineComponent.c.

SetMessage()

void SCR_ChatMessageLineComponent::SetMessage ( notnull SCR_ChatMessage msg, notnull SCR_ChatMessageStyle style )

inlineprotected

Parameters

[in]	msg
[in]	style

Definition at line 85 of file SCR_ChatMessageLineComponent.c.

SetVisible()

void SCR_ChatMessageLineComponent::SetVisible ( bool visible )

inlineprotected

Parameters

[in]

visible

Definition at line 168 of file SCR_ChatMessageLineComponent.c.

Member Data Documentation

CHAT_IMAGESET

ResourceName SCR_ChatMessageLineComponent::CHAT_IMAGESET = "{1872FFA1133724A2}UI/Textures/Chat/chat.imageset"

protected

Definition at line 5 of file SCR_ChatMessageLineComponent.c.

m_Widgets

ref SCR_ChatMessageLineWidgets SCR_ChatMessageLineComponent::m_Widgets = new SCR_ChatMessageLineWidgets()

protected

Definition at line 3 of file SCR_ChatMessageLineComponent.c.

m_wRoot

Widget SCR_ChatMessageLineComponent::m_wRoot

protected

Definition at line 7 of file SCR_ChatMessageLineComponent.c.

---

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

• scripts/Game/UI/Chat/SCR_ChatMessageLineComponent.c