This is a Chat Info Display / Chat HUD. More...

Inheritance diagram for SCR_ChatHud:

Public Member Functions
override void	DisplayUpdate (IEntity owner, float timeSlice)

override void	DisplayStartDraw (IEntity owner)

override void	OnSettingsChanged ()

void	OnChatOpen ()
	When the chat is open, increase it's priority to make it easier to read through the chat.

void	OnChatClose ()
	When chat is closed reset it's priority back to default.

override void	DisplayStopDraw (IEntity owner)

Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)

override void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler	GetHandler (TypeName handlerType)

SCR_InfoDisplayInvoker	GetOnStart ()

SCR_InfoDisplayInvoker	GetOnStop ()

IEntity	GetOwnerEntity ()

Widget	GetContentWidget ()

string	GetContentWidgetName ()

void	SetRootWidget (notnull Widget root)

void	SetContentWidget (notnull Widget content)

void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

bool	IsShown ()

Widget	GetRootWidget ()

bool	GetDimensions (out float width, out float height, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

void	RegisterToHudManager ()

Public Member Functions inherited from GroupInfoDisplay
proto external int	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)

Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent	FindComponentInParentContainer (TypeName typeName)

Protected Member Functions
void	OnSlotUIResize ()
	Calculate how many Chat line widgets can be shown when HUD resizes.

void	CloseAllChatPanels ()

void	Callback_OnToggleAction ()
	Called when Enter key is pressed.

Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)

void	DisplayStartDraw (IEntity owner)

void	DisplayStopDraw (IEntity owner)

void	DisplayInit (IEntity owner)

void	DisplayUpdate (IEntity owner, float timeSlice)

void	DisplayControlledEntityChanged (IEntity from, IEntity to)

void	DisplayConsciousnessChanged (bool conscious, bool init=false)

void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

void	DisplayOnResumed ()

void	InitializeInterfaceSettings ()

void	OnSettingsChanged ()

Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)

override void	OnStartDraw (IEntity owner)

void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

override void	OnStopDraw (IEntity owner)

override void	UpdateValues (IEntity owner, float timeSlice)

override void	OnInit (IEntity owner)

void	OnInit (IEntity owner)

void	UpdateValues (IEntity owner, float timeSlice)

void	OnStartDraw (IEntity owner)

void	OnStopDraw (IEntity owner)

Protected Attributes
SCR_ChatPanel	m_ChatPanel

SCR_InfoDisplaySlotHandler	m_slotHandler

SCR_HUDSlotUIComponent	m_HUDSlotComponent

InputManager	m_InputManager

int	m_iHUDPriorityDefault

Protected Attributes inherited from SCR_InfoDisplayExtended
bool	m_bIsEnabled

string	m_sInterfaceSettingName

SCR_PlayerController	m_PlayerController

SCR_CharacterControllerComponent	m_CharacterController

SCR_CharacterCameraHandlerComponent	m_CameraHandler

MenuManager	m_MenuManager

EventHandlerManagerComponent	m_EventHandlerManager

SCR_EditorManagerEntity	m_EditorManager

bool	m_bAttachedToPlayerController

bool	m_bInThirdPerson

bool	m_bInADS

bool	m_bIsUnconscious

bool	m_bInPauseMenu

bool	m_bInEditor

bool	m_bCanShow

bool	m_bIsEnabledInSettings = true

bool	m_bShowInAllCameras = true

Protected Attributes inherited from SCR_InfoDisplay
string	m_sParentSlot

string	m_sContentWidget

int	m_iContentWidthAdjustment

int	m_iContentHeightAdjustment

string	m_sAdaptiveOpacityWidgetName

ref array< ref SCR_InfoDisplayHandler >	m_aHandlers

bool	m_bShown

Widget	m_wRoot

Widget	m_wContent

Widget	m_wSlot

SCR_HUDManagerComponent	m_HUDManager

int	m_iChildDisplays = 0

ref array< BaseInfoDisplay >	m_aChildDisplays = new array<BaseInfoDisplay>

SCR_InfoDisplay	m_pParentDisplay

bool	m_bRegistered = false

IEntity	m_OwnerEntity

ref array< ref SCR_InfoDisplayHandler >	m_aUpdatableHandlers = {}

ref SCR_InfoDisplayInvoker	m_OnStart = new SCR_InfoDisplayInvoker()

ref SCR_InfoDisplayInvoker	m_OnStop = new SCR_InfoDisplayInvoker()

Static Protected Attributes
static const string	CHAT_INPUT_ACTION = "ChatToggle"

const int	HEIGHT_DIVIDER = 50

const int	INPUTFIELD_HEIGHT = 2

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Detailed Description

This is a Chat Info Display / Chat HUD.

There is a Chat Panel prefab Inside the layout. The Chat HUD opens the chat on a button press, and doesn't do anything more interesting.

Member Function Documentation

◆ Callback_OnToggleAction()

void SCR_ChatHud.Callback_OnToggleAction ( )

protected

Called when Enter key is pressed.

◆ CloseAllChatPanels()

void SCR_ChatHud.CloseAllChatPanels ( )

protected

◆ DisplayStartDraw()

override void SCR_ChatHud.DisplayStartDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayStopDraw()

override void SCR_ChatHud.DisplayStopDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayUpdate()

override void SCR_ChatHud.DisplayUpdate	(	IEntity	owner,
		float	timeSlice
	)

Implements SCR_InfoDisplayExtended.

◆ OnChatClose()

void SCR_ChatHud.OnChatClose ( )

When chat is closed reset it's priority back to default.

◆ OnChatOpen()

void SCR_ChatHud.OnChatOpen ( )

When the chat is open, increase it's priority to make it easier to read through the chat.

◆ OnSettingsChanged()

override void SCR_ChatHud.OnSettingsChanged ( )

Implements SCR_InfoDisplayExtended.

◆ OnSlotUIResize()

void SCR_ChatHud.OnSlotUIResize ( )

protected

Calculate how many Chat line widgets can be shown when HUD resizes.

Member Data Documentation

◆ CHAT_INPUT_ACTION

const string SCR_ChatHud.CHAT_INPUT_ACTION = "ChatToggle"

staticprotected

◆ HEIGHT_DIVIDER

const int SCR_ChatHud.HEIGHT_DIVIDER = 50

staticprotected

◆ INPUTFIELD_HEIGHT

const int SCR_ChatHud.INPUTFIELD_HEIGHT = 2

staticprotected

◆ m_ChatPanel

SCR_ChatPanel SCR_ChatHud.m_ChatPanel

protected

◆ m_HUDSlotComponent

SCR_HUDSlotUIComponent SCR_ChatHud.m_HUDSlotComponent

protected

◆ m_iHUDPriorityDefault

int SCR_ChatHud.m_iHUDPriorityDefault

protected

◆ m_InputManager

InputManager SCR_ChatHud.m_InputManager

protected

◆ m_slotHandler

SCR_InfoDisplaySlotHandler SCR_ChatHud.m_slotHandler

protected

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

Game/UI/Chat/SCR_ChatHud.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Callback_OnToggleAction()

◆ CloseAllChatPanels()

◆ DisplayStartDraw()

◆ DisplayStopDraw()

◆ DisplayUpdate()

◆ OnChatClose()

◆ OnChatOpen()

◆ OnSettingsChanged()

◆ OnSlotUIResize()

Member Data Documentation

◆ CHAT_INPUT_ACTION

◆ HEIGHT_DIVIDER

◆ INPUTFIELD_HEIGHT

◆ m_ChatPanel

◆ m_HUDSlotComponent

◆ m_iHUDPriorityDefault

◆ m_InputManager

◆ m_slotHandler