HUDMutator Class Reference

HUD Mutator Class. More...

List of all members.

Public Member Functions
simulated void	PostRender (Canvas Canvas)
	PostRender call.
simulated bool	MutReceiveMessage (out String message, Name N, PlayerReplicationInfo PRI)
	A message is received.
simulated bool	MutConsoleReceiveMessage (out String message, Name N, PlayerReplicationInfo PRI)
	A message is received.
simulated bool	MutDrawHealth (Canvas Canvas, int X, int Y)
	Draw health.
simulated bool	MutDrawIdentifyInfo (canvas Canvas, float PosX, float PosY, Pawn IdentifyTarget)
	Draw identify info.
simulated bool	MutDrawPlayerInformation (Canvas Canvas, int i, int UseLoopCount, float XOffset, Template_EScoreBoard Calling)
	Draw a scoreboard name.
simulated bool	MutDrawScoreboardHeader (Canvas Canvas, Template_EScoreBoard Calling)
	Draw scoreboard header.
simulated bool	MutDrawScoreboardTrailer (Canvas Canvas, Template_EScoreBoard Calling)
	Draw scoreboard trailer.
simulated bool	MutDrawAmmo (Canvas Canvas, int X, int Y)
	Draw ammo.
simulated bool	MutDrawArmor (Canvas Canvas, int X, int Y, bool bDrawOne)
	Draw armor.
simulated bool	MutDrawInventory (Canvas Canvas, int X, int Y, bool bDrawOne)
	Draw inventory.
simulated function bool	MutDrawFragCount (Canvas Canvas, int X, int Y)
	Draw frag count.
simulated bool	MutUpdateRankAndSpread ()
	Modify the rank and spread.
simulated bool	MutDrawRankAndSpread (Canvas Canvas)
	Draw rank and spread.
simulated bool	MutDrawGraph (Canvas Canvas)
	Draw the Lag/FPS graph.
simulated bool	MutDrawTeamGameSynopsis (Canvas Canvas)
	Draw team game synopsis.
simulated	NotifyLevelChange ()
	Level change.
Public Attributes
HUDMutator	NextMutator
	Next mutator.
bool	bRegistered
	Register signal.
Template_EHUD	OwnerHUD
	Owner's HUD.
String	WindowTitle
	Custom window title.
class< EDMCustomMutatorWindow >	WindowClass
	Custom window class.

---

Detailed Description

Class that is used to mutate the client's HUD. To make your own, simply subclass this and override the functions that you find appropriate. Don't forget to put your HUD mutator class as the HUDMutateClass on your EDMMut.

See also:

EDMMut

EDMMut.HUDMutateClass

EDMMut.bHUDMutator

---

Member Function Documentation

simulated void PostRender

(

Canvas

Canvas

)

PostRender, called from the HUD.

Parameters:

Canvas

The canvas to use for drawing

Remarks:

ALWAYS call Super.PostRender(), otherwise you will break the mutator chain!

simulated bool MutReceiveMessage	(	out String	message,
		Name	N,
		PlayerReplicationInfo	PRI
	)

Called when the HUD has received a message.

Parameters:

	message	The message that was received
	N	The type of message
	PRI	The PlayerReplicationInfo of the person who sent this message, if any

Returns:

True if the message should be displayed by the HUD, false if not

Remarks:

Because message is an out variable, if it is modified and true is returned, the modified message will be used

simulated bool MutConsoleReceiveMessage	(	out String	message,
		Name	N,
		PlayerReplicationInfo	PRI
	)

Called when the console has received a message.

Parameters:

	message	The message that was received
	N	The type of message
	PRI	The PlayerReplicationInfo of the person who sent this message, if any

Returns:

True if this message should be displayed in the console, false if not

Remarks:

Because message is an out variable, if it is modified and true is returned, the modified message will be used

simulated bool MutDrawHealth	(	Canvas	Canvas,
		int	X,
		int	Y
	)

Draw the health for this player.

Parameters:

	Canvas	The Canvas to draw with
	X	The X coordinate
	Y	The Y coordinate

Returns:

True if the mutator is going to draw this, or false if the HUD should draw it

simulated bool MutDrawIdentifyInfo	(	canvas	Canvas,
		float	PosX,
		float	PosY,
		Pawn	IdentifyTarget
	)

Draw information about a target when your crosshair is pointing at them.

Parameters:

	Canvas	The Canvas to draw with
	PosX	The X coordinate to draw at
	PosY	The Y coordinate to draw at
	IdentifyTarget	The target that is being pointed at

Returns:

True if the mutator is going to draw this, or false if the HUD should draw it

simulated bool MutDrawPlayerInformation	(	Canvas	Canvas,
		int	i,
		int	UseLoopCount,
		float	XOffset,
		Template_EScoreBoard	Calling
	)

Draw someone's name on the scoreboard.

Parameters:

	Canvas	The Canvas to draw with
	i	The player's index in the client's list of players
	UseLoopCount	The index of the player from the highest player position on the screen
	XOffset	The X offset of the player's name
	Calling	The Template_EScoreBoard that is drawing the name

Returns:

True if the mutator is going to draw this, or false if the scoreboard should draw it

simulated bool MutDrawScoreboardHeader	(	Canvas	Canvas,
		Template_EScoreBoard	Calling
	)

Draw the header on top of the scoreboard.

Parameters:

	Canvas	The Canvas to draw with
	Calling	The Template_EScoreBoard that is drawing the header

Returns:

True if the mutator is going to draw this, or false if the scoreboard should draw it

simulated bool MutDrawScoreboardTrailer	(	Canvas	Canvas,
		Template_EScoreBoard	Calling
	)

Draw the trailer beneath the scoreboard.

Parameters:

	Canvas	The Canvas to draw with
	Calling	The Template_EScoreBoard that is drawing the trailer

Returns:

True if the mutator is going to draw this, or false if the scoreboard should draw it

simulated bool MutDrawAmmo	(	Canvas	Canvas,
		int	X,
		int	Y
	)

Draw the ammo for this player.

Parameters:

	Canvas	The Canvas to draw with
	X	The X coordinate
	Y	The Y coordinate

Returns:

True if the mutator will draw this, or false if the HUD should draw it

simulated bool MutDrawArmor	(	Canvas	Canvas,
		int	X,
		int	Y,
		bool	bDrawOne
	)

Draw the armor for this player.

Parameters:

	Canvas	The Canvas to draw with
	X	The X coordinate
	Y	The Y coordinate
	bDrawOne	Whether to only draw one item

Returns:

True if the mutator will draw this, or false if the HUD should

simulated bool MutDrawInventory	(	Canvas	Canvas,
		int	X,
		int	Y,
		bool	bDrawOne
	)

Draw the inventory for this player.

Parameters:

	Canvas	The Canvas to draw with
	X	The X coordinate
	Y	The Y coordinate
	bDrawOne	Whether to only draw one item

Returns:

True if the mutator will draw this, or false if the HUD should

simulated function bool MutDrawFragCount	(	Canvas	Canvas,
		int	X,
		int	Y
	)

Draw the frag count for this player.

Parameters:

	Canvas	The Canvas to draw with
	X	The X coordinate
	Y	The Y coordinate

Returns:

True if the mutator will draw this, or false if the HUD should

simulated bool MutUpdateRankAndSpread

(

)

Modify how the rank and spread are determined

Returns:

True if the mutator will handle this, or false if the HUD should

simulated bool MutDrawRankAndSpread

(

Canvas

Canvas

)

Draw the rank and spread for this player.

Parameters:

Canvas

The Canvas to draw with

Returns:

True if the mutator will draw this, or false if the HUD should

simulated bool MutDrawGraph

(

Canvas

Canvas

)

Draw the Lag/FPS graph for this player.

Parameters:

Canvas

The Canvas to draw with

Returns:

True if the mutator will draw this, or false if the HUD should

simulated bool MutDrawTeamGameSynopsis

(

Canvas

Canvas

)

Draw the team game synopsis.

Parameters:

Canvas

The Canvas to draw with

Returns:

True if the mutator will draw this, or false if the HUD should

simulated NotifyLevelChange

(

)

This is called when the level has changed.

---

Member Data Documentation

HUDMutator NextMutator

The next HUD mutator in the chain.

bool bRegistered

True if this mutator has registered with the client's HUD, false if not.

Template_EHUD OwnerHUD

The HUD of the player.

String WindowTitle

The title of the mutator window that will be created in the console, if there is one.

class<EDMCustomMutatorWindow> WindowClass

The class of this HUD mutator's custom window, if any.