Sandbox.Game.Gui.MyHudNotificationBase Class Reference

Inheritance diagram for Sandbox.Game.Gui.MyHudNotificationBase:

Public Member Functions
	MyHudNotificationBase (int disapearTimeMs, string font=MyFontEnum.White, MyGuiDrawAlignEnum textAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, int priority=0, MyNotificationLevel level=MyNotificationLevel.Normal)
void	SetTextDirty ()
string	GetText ()
object[]	GetTextFormatArguments ()
void	SetTextFormatArguments (params object[] arguments)
void	AddAliveTime (int timeStep)
void	ResetAliveTime ()
virtual void	BeforeAdd ()
virtual void	BeforeRemove ()

Public Attributes
int	m_lifespanMs
MyNotificationLevel	Level = MyNotificationLevel.Normal
readonly int	Priority
string	Font

Static Public Attributes
static readonly int	INFINITE = 0

Protected Member Functions
abstract string	GetOriginalText ()

Properties
bool	IsControlsHint [get]
bool	Alive [get]

Detailed Description

Definition at line 29 of file MyHudNotification.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyHudNotificationBase.MyHudNotificationBase ( int  disapearTimeMs, string  font = MyFontEnum.White, MyGuiDrawAlignEnum  textAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, int  priority = 0, MyNotificationLevel  level = MyNotificationLevel.Normal  )

inline

Definition at line 58 of file MyHudNotification.cs.

Member Function Documentation

void Sandbox.Game.Gui.MyHudNotificationBase.AddAliveTime ( int  timeStep )

inline

Definition at line 114 of file MyHudNotification.cs.

virtual void Sandbox.Game.Gui.MyHudNotificationBase.BeforeAdd ( )

inlinevirtual

Reimplemented in Sandbox.Game.Gui.MyHudMissingComponentNotification.

Definition at line 154 of file MyHudNotification.cs.

virtual void Sandbox.Game.Gui.MyHudNotificationBase.BeforeRemove ( )

inlinevirtual

Reimplemented in Sandbox.Game.Gui.MyHudMissingComponentNotification.

Definition at line 157 of file MyHudNotification.cs.

abstract string Sandbox.Game.Gui.MyHudNotificationBase.GetOriginalText ( )

protectedpure virtual

Implemented in Sandbox.Game.Gui.MyHudMissingComponentNotification, Sandbox.Game.Gui.MyHudNotificationDebug, and Sandbox.Game.Gui.MyHudNotification.

string Sandbox.Game.Gui.MyHudNotificationBase.GetText ( )

inline

Definition at line 84 of file MyHudNotification.cs.

object [] Sandbox.Game.Gui.MyHudNotificationBase.GetTextFormatArguments ( )

inline

Definition at line 102 of file MyHudNotification.cs.

void Sandbox.Game.Gui.MyHudNotificationBase.ResetAliveTime ( )

inline

Definition at line 120 of file MyHudNotification.cs.

void Sandbox.Game.Gui.MyHudNotificationBase.SetTextDirty ( )

inline

Definition at line 79 of file MyHudNotification.cs.

void Sandbox.Game.Gui.MyHudNotificationBase.SetTextFormatArguments ( params object[]  arguments )

inline

Definition at line 107 of file MyHudNotification.cs.

Member Data Documentation

string Sandbox.Game.Gui.MyHudNotificationBase.Font

Definition at line 50 of file MyHudNotification.cs.

readonly int Sandbox.Game.Gui.MyHudNotificationBase.INFINITE = 0

static

Definition at line 31 of file MyHudNotification.cs.

MyNotificationLevel Sandbox.Game.Gui.MyHudNotificationBase.Level = MyNotificationLevel.Normal

Definition at line 44 of file MyHudNotification.cs.

int Sandbox.Game.Gui.MyHudNotificationBase.m_lifespanMs

Definition at line 42 of file MyHudNotification.cs.

readonly int Sandbox.Game.Gui.MyHudNotificationBase.Priority

Definition at line 48 of file MyHudNotification.cs.

Property Documentation

bool Sandbox.Game.Gui.MyHudNotificationBase.Alive

get

Definition at line 53 of file MyHudNotification.cs.

bool Sandbox.Game.Gui.MyHudNotificationBase.IsControlsHint

get

Definition at line 46 of file MyHudNotification.cs.

---

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

• Sources/Sandbox.Game/Game/GUI/MyHudNotification.cs