Space Engineers
Public Member Functions | Protected Member Functions | Properties | List of all members
Sandbox.Game.Gui.MyHudNotification Class Reference
Inheritance diagram for Sandbox.Game.Gui.MyHudNotification:
VRage.Game.ModAPI.IMyHudNotification Sandbox.Game.Gui.MyHudNotificationBase Sandbox.Game.Gui.MyHudWarning

Public Member Functions

 MyHudNotification (MyStringId text=default(MyStringId), int disappearTimeMs=2500, string font=MyFontEnum.White, MyGuiDrawAlignEnum textAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, int priority=0, MyNotificationLevel level=MyNotificationLevel.Normal)
 
- Public Member Functions inherited from 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)
 
void SetTextDirty ()
 
string GetText ()
 
object[] GetTextFormatArguments ()
 
void SetTextFormatArguments (params object[] arguments)
 
void AddAliveTime (int timeStep)
 
void ResetAliveTime ()
 
virtual void BeforeAdd ()
 
virtual void BeforeRemove ()
 

Protected Member Functions

override string GetOriginalText ()
 

Properties

MyStringId Text [get, set]
 
- Properties inherited from VRage.Game.ModAPI.IMyHudNotification
string Text [get, set]
 Get or set the notification text. Setting the text will immediatly update it if the notification is shown. More...
 
string Font [get, set]
 Get or set the font for this notification. Setting it will immediatly update it if the notification is shown. More...
 
int AliveTime [get, set]
 Get or set the time for the notification to be shown, in miliseconds. More...
 
- Properties inherited from Sandbox.Game.Gui.MyHudNotificationBase
bool IsControlsHint [get]
 
bool Alive [get]
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Game.Gui.MyHudNotificationBase
int m_lifespanMs
 
MyNotificationLevel Level = MyNotificationLevel.Normal
 
readonly int Priority
 
string Font
 
- Static Public Attributes inherited from Sandbox.Game.Gui.MyHudNotificationBase
static readonly int INFINITE = 0
 

Detailed Description

Definition at line 161 of file MyHudNotification.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyHudNotification.MyHudNotification ( MyStringId  text = default(MyStringId),
int  disappearTimeMs = 2500,
string  font = MyFontEnum.White,
MyGuiDrawAlignEnum  textAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER,
int  priority = 0,
MyNotificationLevel  level = MyNotificationLevel.Normal 
)
inline

Definition at line 182 of file MyHudNotification.cs.

Member Function Documentation

override string Sandbox.Game.Gui.MyHudNotification.GetOriginalText ( )
inlineprotectedvirtual

Implements Sandbox.Game.Gui.MyHudNotificationBase.

Definition at line 195 of file MyHudNotification.cs.

Property Documentation

MyStringId Sandbox.Game.Gui.MyHudNotification.Text
getset

Definition at line 167 of file MyHudNotification.cs.


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