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

Public Member Functions

void Show ()
 Shows the notification on the HUD. More...
 
void Hide ()
 Hides the notification on the HUD even if it was supposed to show for longer. More...
 
void ResetAliveTime ()
 Reset the alive time for the text. This is called when setting AliveTime as well. More...
 

Properties

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...
 

Detailed Description

Definition at line 3 of file IMyHudNotification.cs.

Member Function Documentation

void VRage.Game.ModAPI.IMyHudNotification.Hide ( )

Hides the notification on the HUD even if it was supposed to show for longer.

void VRage.Game.ModAPI.IMyHudNotification.ResetAliveTime ( )

Reset the alive time for the text. This is called when setting AliveTime as well.

void VRage.Game.ModAPI.IMyHudNotification.Show ( )

Shows the notification on the HUD.

Property Documentation

int VRage.Game.ModAPI.IMyHudNotification.AliveTime
getset

Get or set the time for the notification to be shown, in miliseconds.

Definition at line 20 of file IMyHudNotification.cs.

string VRage.Game.ModAPI.IMyHudNotification.Font
getset

Get or set the font for this notification. Setting it will immediatly update it if the notification is shown.

Definition at line 15 of file IMyHudNotification.cs.

string VRage.Game.ModAPI.IMyHudNotification.Text
getset

Get or set the notification text. Setting the text will immediatly update it if the notification is shown.

Definition at line 9 of file IMyHudNotification.cs.


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