UI_HUD

Classes
class	BaseHUDComponentClass
class	BaseInfoDisplay
class	GroupInfoDisplay
class	HUDManagerComponentClass

Functions
BaseHUDComponentClass GameComponentClass	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)
proto external void	RegisterInfoDisplay (BaseInfoDisplay infoDisplay)
proto external void	UnregisterInfoDisplay (BaseInfoDisplay infoDisplay)
HUDManagerComponentClass SCR_BaseHUDComponentClass	IsHUDEnabled ()
proto external bool	EnableHUD (bool state)
proto external bool	StartDrawing (BaseInfoDisplay display)
proto external void	StopDrawing (BaseInfoDisplay display)
proto external int	GetInfoDisplaysDrawn (out notnull array< BaseInfoDisplay > outInfoDisplays, bool getAllShown=false)
void	OnInit (IEntity owner)
void	OnUpdate (IEntity owner)
void	OnControlledEntityChanged (IEntity from, IEntity to)
	Runs every time the controlled entity has been changed.

Detailed Description

Function Documentation

EnableHUD()

proto external bool EnableHUD

(

bool

state

)

GetInfoDisplays()

BaseHUDComponentClass GameComponentClass GetInfoDisplays

(

out notnull array< BaseInfoDisplay >

outInfoDisplays

)

GetInfoDisplaysDrawn()

proto external int GetInfoDisplaysDrawn	(	out notnull array< BaseInfoDisplay >	outInfoDisplays,
		bool	getAllShown = false )

IsHUDEnabled()

HUDManagerComponentClass SCR_BaseHUDComponentClass IsHUDEnabled

(

)

OnControlledEntityChanged()

void OnControlledEntityChanged ( IEntity from, IEntity to )

protected

Runs every time the controlled entity has been changed.

Definition at line 174 of file SCR_ItemPlacementComponent.c.

OnInit()

void OnInit ( IEntity owner )

protected

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Definition at line 493 of file SCR_CharacterCommandHandler_Tests.c.

OnUpdate()

void OnUpdate ( IEntity owner )

protected

RegisterInfoDisplay()

proto external void RegisterInfoDisplay

(

BaseInfoDisplay

infoDisplay

)

StartDrawing()

proto external bool StartDrawing

(

BaseInfoDisplay

display

)

StopDrawing()

proto external void StopDrawing

(

BaseInfoDisplay

display

)

UnregisterInfoDisplay()

proto external void UnregisterInfoDisplay

(

BaseInfoDisplay

infoDisplay

)