HudTextManager Class Reference

This class is used to set and clear the main hud text, the message shown on a player's heads up display. The text can optionally be accompanied by a marker icon. Setting the text replaces any text that is already displayed. More...

Public Member Functions
void	SetGlobalMainText (Context instigator, string hudText)
	Sets the main hud text for every player, without a marker icon.
void	SetGlobalMainText (Context instigator, string hudText, int marker, UnityEngine.Color color)
	Sets the main hud text for every player, with a marker icon shown next to it.
void	SetMainTextForPlayer (Context instigator, Context player, string hudText)
	Sets the main hud text for a single player, without a marker icon.
void	SetMainTextForPlayer (Context instigator, Context player, string hudText, int marker, UnityEngine.Color color)
	Sets the main hud text for a single player, with a marker icon shown next to it.
void	ClearGlobalMainText (Context instigator)
	Clears the main hud text for every player.
void	ClearMainTextForPlayer (Context instigator, Context player)
	Clears the main hud text for a single player.

Detailed Description

This class is used to set and clear the main hud text, the message shown on a player's heads up display. The text can optionally be accompanied by a marker icon. Setting the text replaces any text that is already displayed.

Member Function Documentation

ClearGlobalMainText()

void ClearGlobalMainText

(

Context

instigator

)

Clears the main hud text for every player.

Parameters

instigator

The source context of this change

ClearMainTextForPlayer()

void ClearMainTextForPlayer	(	Context	instigator,
		Context	player )

Clears the main hud text for a single player.

Parameters

instigator	The source context of this change
player	The context of the player to clear the text for.

SetGlobalMainText() [1/2]

void SetGlobalMainText	(	Context	instigator,
		string	hudText )

Sets the main hud text for every player, without a marker icon.

Parameters

instigator	The source context of this change
hudText	The text to display.

SetGlobalMainText() [2/2]

void SetGlobalMainText	(	Context	instigator,
		string	hudText,
		int	marker,
		UnityEngine.Color	color )

Sets the main hud text for every player, with a marker icon shown next to it.

Parameters

instigator	The source context of this change
hudText	The text to display.
marker	The type of marker icon to display with the text as MarkerType. Use None to display no icon.
color	The color of the marker icon.

SetMainTextForPlayer() [1/2]

void SetMainTextForPlayer	(	Context	instigator,
		Context	player,
		string	hudText )

Sets the main hud text for a single player, without a marker icon.

Parameters

instigator	The source context of this change
player	The context of the player to display the text for.
hudText	The text to display.

SetMainTextForPlayer() [2/2]

void SetMainTextForPlayer	(	Context	instigator,
		Context	player,
		string	hudText,
		int	marker,
		UnityEngine.Color	color )

Sets the main hud text for a single player, with a marker icon shown next to it.

Parameters

instigator	The source context of this change
player	The context of the player to display the text for.
hudText	The text to display.
marker	The type of marker icon to display with the text as MarkerType. Use None to display no icon.
color	The color of the marker icon.