//==============================================================================
// GxHUD v1.11
//==============================================================================

//=================
Change Log:

6/24/11 -	Fixed a problem with drawing armor values. Now draws in correct
		font for all hudmodes.

6/23/11	-	Initial release!


//=================
Abstract:
	GxHUD is able to render a variable (configurable) number of messages and
allows for customization of message color, font and more. GxHUD allows for
customized rendering of information to the HUD.

//=================
Installation:
	The following files should be included with this README:
	-GxHUD.u		(Main file)
	-GxHUD.ini

Dependencies:
	Requires GxCoop.u.
	Requires VisualPersonalizationBlock.u.

	Place all files in your Unreal's system directory. Change the following
line in your GxCoop.ini file:

	HUDClass=GxHUD.GxHUD

	GxHUD will now automatically load with your server when running GxCoop.

	You must add GxHUD to serverpackages.

//=================
Help / Walkthrough:
	
	To configure GxScoreBoard you must use GxHUD.ini. The descriptions of the
variables found in the ini are below.

MessageTypeDrawing
	DrawingPosition -	Determines where the message will be rendered. Valid
				options are:
				EDP_Chat -	Appears in chat area.
				EDP_Center -	Appears in center of screen.
				EDP_Pickup -	Appears in pickup area.
	MessageType -		Tag of the message that this entry describes.
	DrawColor -		RGB coloring for the message that this entry describes.
	bDisplaySender -	If 1, the sender's name will be prepended to all messages
				of this type.
	bTriggerAvatars -	If 1, this message will trigger an avatar slide in event
				if the sending player has a VisualPersonalizationBlock.

bDisplayAvatars -	If true, avatars will be rendered in the chat area.

AvatarTimeoutTime -	Time in seconds that a newly displayed avatar will remain on screen.

ChatFont -	Font assigned to all messages in the chat area.

CenterFont -	Same as ChatFont for center area.

PickupFont -	Same as ChatFont for pickup area.

MaxChatMessages -	Max number of chat messages that the chat area will support.

MaxCenterMessages -	Same as MaXChatMessages for center area.

MaxPickupMessages -	Same as MaxChatMessages for pickup area.

bChatFadesOut -		If true, messages in the chat area will fade out with time.

bCenterFadesOut -	Same as bChatFadesOut for center area.

bPickupFadesOut -	Same as bChatFadesOut for pickup area.

	---

	GxHUD can support up to 16 different message types. Most often, you will want
to provide custom rendering settings for the types already provided in the default ini.

	One bug that is currently in GxHUD concerns the triggering of avatars. It seems
that avatars are triggered "a tick too late" and can be retriggered in mid slide... It's
easier to see this effect than to read about it - send a message immediately after another
client and watch as their slide in effect is aborted resulting in your avatar's slide
in effect taking place. This looks choppy and should be fixed.

	GxHUD is intended to be run on GxCoop. Other GameLogicHandler classes may not
correctly create the Controller object associated with this HUD, so use this HUD with
other GLHs at your own risk.

//=================
Conclusion:
	If you have any questions or comments, feel free to email me at 
	pravin_prabhu at hotmail.com.

You can also post on the UDHQ forums, found at 
	http://udhq.falconpunch.net/phpBB3/

Keep it Unreal!
-Pravin "Pcube" Prabhu
http://udhq.org

END





