Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

TribesGUI.HUDMessagePane

Extends
HUDList

Core.Object
|   
+-- TribesGUI.HUDElement
   |   
   +-- TribesGUI.HUDContainer
      |   
      +-- TribesGUI.HUDList
         |   
         +-- TribesGUI.HUDMessagePane

Direct Known Subclasses:

HUDAnnouncerMessageWindow, HUDEventMessageWindow, HUDMessageWindow, HUDPersonalMessageWindow

Variables Summary
intFirstLineOffset
ObjectPoolMessagePool
HUDTextMessagePaddingMessage
intTotalLines
HUDMessagePane
boolbAlwaysVisible
boolbScrollable
intMaxDisplayableLines
intMaxMessages
floatMessageFadeDuration
floatMessageLifetime
StringMessageStyles[EMessageType.MAX_MESSAGE_TYPES]
floatMinimumLifetime
floatSecondsPerWord
StringTemplateMessageLabelName
Inherited Variables from TribesGUI.HUDList
bAutoHeight, columns, RowSpacing
Inherited Variables from TribesGUI.HUDContainer
children

Functions Summary
function AddMessage (HUDMessage newMessage))
function DoLayout (Canvas c))
functionint GetLineHeight (Canvas canvas))
function GetNewMessages (ClientSideCharacter c)
function InitElement ()))
function ScrollMessages (int ScrollDelta))
function UpdateData (ClientSideCharacter c))
function UpdateMessageVisibility ()))
Inherited Functions from TribesGUI.HUDList
ElementAdded, ElementRemoved, HasMultipleColumns, IsListEmpty
Inherited Functions from TribesGUI.HUDContainer
AddClonedElement, AddElement, AddExistingElement, ElementAdded, ElementRemoved, ForceNeedsLayout, HasElement, InitElementHeirachy, RemoveAll, RemoveElementAt, SetAlpha


Variables Detail

FirstLineOffset Source code

var int FirstLineOffset;

MessagePool Source code

var ObjectPool MessagePool;

PaddingMessage Source code

var HUDTextMessage PaddingMessage;

TotalLines Source code

var int TotalLines;

HUDMessagePane

bAlwaysVisible Source code

var(HUDMessagePane) config bool bAlwaysVisible;
Whether the message window is always visible

bScrollable Source code

var(HUDMessagePane) config bool bScrollable;
Whether the message window is scrollable

MaxDisplayableLines Source code

var(HUDMessagePane) config int MaxDisplayableLines;
Max number of actual text lines allowed in the display

MaxMessages Source code

var(HUDMessagePane) config int MaxMessages;
Max numer of messages to be displayed at once

MessageFadeDuration Source code

var(HUDMessagePane) config float MessageFadeDuration;
How long irrelevant messages should take to fade away

MessageLifetime Source code

var(HUDMessagePane) config float MessageLifetime;
Fixed lifetime for messages

MessageStyles[EMessageType.MAX_MESSAGE_TYPES] Source code

var(HUDMessagePane) config String MessageStyles[EMessageType.MAX_MESSAGE_TYPES];

MinimumLifetime Source code

var(HUDMessagePane) config float MinimumLifetime;
Lower bound on message lifetime

SecondsPerWord Source code

var(HUDMessagePane) config float SecondsPerWord;
Number of seconds per word

TemplateMessageLabelName Source code

var(HUDMessagePane) config String TemplateMessageLabelName;
Name of the template label properties


Functions Detail

AddMessage Source code

function AddMessage ( HUDMessage newMessage) )

DoLayout Source code

function DoLayout ( Canvas c) )

GetLineHeight Source code

function int GetLineHeight ( Canvas canvas) )

GetNewMessages Source code

function GetNewMessages ( ClientSideCharacter c )

InitElement Source code

function InitElement ( ) )

ScrollMessages Source code

function ScrollMessages ( int ScrollDelta) )

UpdateData Source code

function UpdateData ( ClientSideCharacter c) )

UpdateMessageVisibility Source code

function UpdateMessageVisibility ( ) )


Defaultproperties

defaultproperties
{
	MaxDisplayableLines=6
	MessageFadeDuration=0.7
	SecondsPerWord=0.75
	MinimumLifetime=5


	MessageStyles(0)="GlobalMessage"
	MessageStyles(1)="AllyMessage"
	MessageStyles(2)="EnemyMessage"
	MessageStyles(3)="SubtitleMessage"
	MessageStyles(4)="SystemMessage"
	MessageStyles(5)="StatHighMessage"
	MessageStyles(6)="StatMediumMessage"
	MessageStyles(7)="StatLowMessage"
	MessageStyles(8)="StatPenaltyMessage"
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: st 23.5.2018 00:10:31.035 - Created with UnCodeX