This class represents HUD warning More...

Inheritance diagram for Sandbox.Game.Gui.MyHudWarning:

Public Member Functions
	MyHudWarning (MyWarningDetectionMethod detectionMethod, int priority, int repeatInterval=0, int soundDelay=0, int disappearTime=0)
	Creates new instance of HUD warning More...

bool	Update (bool isWarnedHigherPriority)
	Call it in each update More...

Public Member Functions inherited from 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)

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 ()

Public Attributes
int	RepeatInterval

Func< bool >	CanPlay

Action	Played

Public Attributes inherited from Sandbox.Game.Gui.MyHudNotificationBase
int	m_lifespanMs

MyNotificationLevel	Level = MyNotificationLevel.Normal

readonly int	Priority

string	Font

Properties
int	WarningPriority `[get]`
	Warning's priority More...

Properties inherited from Sandbox.Game.Gui.MyHudNotification
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
Static Public Attributes inherited from Sandbox.Game.Gui.MyHudNotificationBase
static readonly int	INFINITE = 0

Protected Member Functions inherited from Sandbox.Game.Gui.MyHudNotification
override string	GetOriginalText ()

Detailed Description

This class represents HUD warning

Definition at line 39 of file MyHudWarning.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyHudWarning.MyHudWarning	(	MyWarningDetectionMethod	detectionMethod,
		int	priority,
		int	repeatInterval = `0`,
		int	soundDelay = `0`,
		int	disappearTime = `0`
	)

inline

Creates new instance of HUD warning

Parameters

Definition at line 64 of file MyHudWarning.cs.

bool Sandbox.Game.Gui.MyHudWarning.Update ( bool isWarnedHigherPriority )

inline

Call it in each update

Parameters

isWarnedHigherPriority Indicated if warning with greater priority was signalized

Definition at line 79 of file MyHudWarning.cs.

Func<bool> Sandbox.Game.Gui.MyHudWarning.CanPlay

Definition at line 46 of file MyHudWarning.cs.

Action Sandbox.Game.Gui.MyHudWarning.Played

Definition at line 47 of file MyHudWarning.cs.

int Sandbox.Game.Gui.MyHudWarning.RepeatInterval

Definition at line 45 of file MyHudWarning.cs.

int Sandbox.Game.Gui.MyHudWarning.WarningPriority

get

Warning's priority

Definition at line 44 of file MyHudWarning.cs.

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