GuiMessageVectorCtrl
Engine/source/gui/game/guiMessageVectorCtrl.h
Render a MessageVector (chat HUD)
Classes:
Derived classes must keep this set of variables consistent if they use this classes onRender.
Private Types
Parent
Protected Attributes
bool
Public Functions
bool
attach(MessageVector * )
DECLARE_CATEGORY("Gui Game" )
DECLARE_DESCRIPTION("A chat HUD <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that displays messages from <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> MessageVector." )
bool
Protected Functions
createLineElement(LineElement & , LineWrapping & , SpecialMarkers & )
createLineWrapping(LineWrapping & , const char * )
createSpecialMarkers(SpecialMarkers & , const char * )
Called after any property of the object is changed in the world editor.
lineDeleted(const U32)
lineInserted(const U32)
bool
onAdd()
Called when this object is added to the scene.
onMouseDown(const GuiEvent & event)
bool
onWake()
Called when this object is asked to wake up returns true if it's actually awake at the end.
parentResized(const RectI & oldParentRect, const RectI & newParentRect)
Called when this objects parent is resized.
Public Static Functions
Detailed Description
Render a MessageVector (chat HUD)
This renders messages from a MessageVector; the important thing here is that the MessageVector holds all the messages we care about, while we can destroy and create these GUI controls as needed. (For instance, Tribes 2 used seperate GuiMessageVectorCtrl controls in the different HUD modes.)
Private Types
typedef GuiControl Parent
Protected Attributes
StringTableEntry mAllowedMatches [16]
U32 mLineContinuationIndent
Vector< LineElement > mLineElements
U32 mLineSpacingPixels
Vector< LineWrapping > mLineWrappings
U32 mMaxColorIndex
MessageVector * mMessageVector
U32 mMinSensibleWidth
bool mMouseDown
S32 mMouseSpecialLine
S32 mMouseSpecialRef
ColorI mSpecialColor
Vector< SpecialMarkers > mSpecialMarkers
Public Functions
GuiMessageVectorCtrl()
~GuiMessageVectorCtrl()
attach(MessageVector * )
callbackRouter(const MessageVector::MessageCode , const U32)
DECLARE_CATEGORY("Gui Game" )
DECLARE_CONOBJECT(GuiMessageVectorCtrl )
DECLARE_DESCRIPTION("A chat HUD <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that displays messages from <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> MessageVector." )
detach()
isAttached()
Protected Functions
createLineElement(LineElement & , LineWrapping & , SpecialMarkers & )
createLineWrapping(LineWrapping & , const char * )
createSpecialMarkers(SpecialMarkers & , const char * )
findSpecialFromCoord(const Point2I & , S32 * , S32 * )
inspectPostApply()
Reimplemented from: GuiControl
lineDeleted(const U32)
lineInserted(const U32)
onAdd()
Reimplemented from: GuiControl
onMouseDown(const GuiEvent & event)
Reimplemented from: GuiControl
onMouseUp(const GuiEvent & event)
Reimplemented from: GuiControl
onRemove()
Reimplemented from: GuiControl
onRender(Point2I offset, const RectI & updateRect)
Reimplemented from: GuiControl
onSleep()
Reimplemented from: GuiControl
onWake()
Reimplemented from: GuiControl
parentResized(const RectI & oldParentRect, const RectI & newParentRect)
Reimplemented from: GuiControl
vectorDeleted()