SCR_InfoDisplayHandler Interface Reference

Inheritance diagram for SCR_InfoDisplayHandler:

Public Member Functions
void	SetEnabled (bool enabled)
bool	IsEnabled ()
void	Initialize (notnull SCR_InfoDisplay display)
	Called before OnStart and used for initializing this Handler.
void	OnStart (notnull SCR_InfoDisplay display)
	Called when the Owning Info Display of this handler is started.
void	OnStop (notnull SCR_InfoDisplay display)
	Called when the Owning Info Display of this handler is stopped.
void	OnUpdate (float timeSlice)
	Called every frame.

Public Attributes
bool	m_bCanUpdate

Protected Attributes
SCR_InfoDisplay	m_OwnerDisplay
	Info Display which owns this Info Dispaly Handler.
bool	m_bEnabled

Member Function Documentation

Initialize()

void SCR_InfoDisplayHandler.Initialize

(

notnull SCR_InfoDisplay

display

)

Called before OnStart and used for initializing this Handler.

Parameters

display

The Owner Info Display

IsEnabled()

bool SCR_InfoDisplayHandler.IsEnabled

(

)

OnStart()

void SCR_InfoDisplayHandler.OnStart

(

notnull SCR_InfoDisplay

display

)

Called when the Owning Info Display of this handler is started.

Parameters

display

The Owner Info Display

Implemented in SCR_InfoDisplayLayerHandler, and SCR_InfoDisplaySlotHandler.

OnStop()

void SCR_InfoDisplayHandler.OnStop

(

notnull SCR_InfoDisplay

display

)

Called when the Owning Info Display of this handler is stopped.

Parameters

display

The Owner Info Display

Implemented in SCR_InfoDisplaySlotHandler.

OnUpdate()

void SCR_InfoDisplayHandler.OnUpdate

(

float

timeSlice

)

Called every frame.

Implemented in SCR_InfoDisplaySlotHandler.

SetEnabled()

void SCR_InfoDisplayHandler.SetEnabled

(

bool

enabled

)

Member Data Documentation

m_bCanUpdate

bool SCR_InfoDisplayHandler.m_bCanUpdate

m_bEnabled

bool SCR_InfoDisplayHandler.m_bEnabled

protected

m_OwnerDisplay

SCR_InfoDisplay SCR_InfoDisplayHandler.m_OwnerDisplay

protected

Info Display which owns this Info Dispaly Handler.

---

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

• Game/UI/HUD/Handlers/InfoDisplay/SCR_InfoDisplayHandler.c