Sandbox.Game.Gui.MyHudWarnings Class Reference

This class represents HUD warnings for entities More...

Inheritance diagram for Sandbox.Game.Gui.MyHudWarnings:

Public Member Functions
override void	LoadData ()
override void	UpdateAfterSimulation ()
Public Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual bool	UpdatedBeforeInit ()
	MySessionComponentBase ()
void	SetUpdateOrder (MyUpdateOrder order)
virtual void	InitFromDefinition (MySessionComponentDefinition definition)
virtual void	Init (MyObjectBuilder_SessionComponent sessionComponent)
virtual MyObjectBuilder_SessionComponent	GetObjectBuilder ()
void	AfterLoadData ()
void	UnloadDataConditional ()
virtual void	SaveData ()
virtual void	BeforeStart ()
virtual void	UpdateBeforeSimulation ()
virtual void	Simulate ()
virtual void	UpdatingStopped ()
virtual void	Draw ()
virtual void	HandleInput ()
override string	ToString ()

Static Public Member Functions
static void	EnqueueSound (MyGuiSounds sound)
static void	RemoveSound (MyGuiSounds cueEnum)
static void	Add (MyHudWarningGroup hudWarningGroup)
	Register new HUD warning group for entity More...
static void	Remove (MyHudWarningGroup hudWarningGroup)
	Unregister HUD warning group for entity More...

Static Public Attributes
static readonly int	FRAMES_BETWEEN_UPDATE = 30

Protected Member Functions
override void	UnloadData ()

Additional Inherited Members
Public Attributes inherited from VRage.Game.Components.MySessionComponentBase
readonly string	DebugName
readonly int	Priority
readonly Type	ComponentType
IMySession	Session
Properties inherited from VRage.Game.Components.MySessionComponentBase
MyUpdateOrder	UpdateOrder [get]
MyObjectBuilderType	ObjectBuilderType [get]
bool	Loaded [get]
bool	Initialized [get]
MyDefinitionId	Definition [get, set]
virtual Type[]	Dependencies [get]
virtual bool	IsRequiredByGame [get]
	Indicates whether a session component should be used in current configuration. Example: MyDestructionData component returns true only when game uses Havok Destruction More...

Detailed Description

This class represents HUD warnings for entities

Definition at line 234 of file MyHudWarning.cs.

Member Function Documentation

static void Sandbox.Game.Gui.MyHudWarnings.Add ( MyHudWarningGroup  hudWarningGroup )

inlinestatic

Register new HUD warning group for entity

Parameters

entity	Entity
hudWarningGroup	HUD warning group

Definition at line 272 of file MyHudWarning.cs.

static void Sandbox.Game.Gui.MyHudWarnings.EnqueueSound ( MyGuiSounds  sound )

inlinestatic

Definition at line 244 of file MyHudWarning.cs.

override void Sandbox.Game.Gui.MyHudWarnings.LoadData ( )

inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 287 of file MyHudWarning.cs.

static void Sandbox.Game.Gui.MyHudWarnings.Remove ( MyHudWarningGroup  hudWarningGroup )

inlinestatic

Unregister HUD warning group for entity

Parameters

entity	Entity
hudWarningGroup	HUD warning group

Definition at line 282 of file MyHudWarning.cs.

static void Sandbox.Game.Gui.MyHudWarnings.RemoveSound ( MyGuiSounds  cueEnum )

inlinestatic

Definition at line 257 of file MyHudWarning.cs.

override void Sandbox.Game.Gui.MyHudWarnings.UnloadData ( )

inlineprotectedvirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 544 of file MyHudWarning.cs.

override void Sandbox.Game.Gui.MyHudWarnings.UpdateAfterSimulation ( )

inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 555 of file MyHudWarning.cs.

Member Data Documentation

readonly int Sandbox.Game.Gui.MyHudWarnings.FRAMES_BETWEEN_UPDATE = 30

static

Definition at line 236 of file MyHudWarning.cs.

---

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

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