guiHealthTextCtrl -- Display your health and energy as text!

Download Code File

EDIT 5/14/05: Added examples datablocks.
EDIT 5/15/05: Fixed minor syntax error. Re-uploaded .ZIP file with altered files
EDIT 5/19/05: It appears the resource has been approved!
EDIT 5/28/05: The GUI control no longer uses a hard coded value of 100.
EDIT 5/31/05: New field (displayMaximum).
EDIT 6/08/05: Fixed a nasty bug that caused the engine to crash, >.<

To use this GUI Control, just download the .ZIP file and extract it to your engine/gui folder if you are using 1.3 or below or extract it to engine/gui/game if you are using 1.3.1 or above. If you are using 1.3.1 or above, make sure you read below where is says Required Changes for TGE 1.3.1+.

After you have made sure the file has been extracted correctly, you should add it to your makefile or project, whichever method is appropriate, and then compile. Most people suggest a Clean Rebuild, to make sure everything is rebuilt, but I will leave that up to you. NOTE: If you are having compile errors (and you don't know what to do), try a Clean Rebuild if you chose not to do so.

REQUIRED CHANGES FOR ANY VERSION OF TGE
In game/shapeBase.h:
Below:

F32  getDamageValue();

Add:

F32  getMaxDamage();F32  getMaxEnergy();

In game/shapeBase.cc:
Below:

F32 ShapeBase::getDamageValue()
{
   // Return a 0-1 damage value.
   return mDamage / mDataBlock->maxDamage;
}

Add:

F32 ShapeBase::getMaxDamage()
{
   return mDataBlock->maxDamage;
}

F32 ShapeBase::getMaxEnergy()
{
   return mDataBlock->maxEnergy;
}

OPTIONAL
Below:

ConsoleMethod( ShapeBase, getDamageLevel, F32, 2, 2, "")
{
   return object->getDamageLevel();
}

Add:

ConsoleMethod( ShapeBase, getMaxDamage, F32, 2, 2, "")
{
   return object->getMaxDamage();
}

ConsoleMethod( ShapeBase, getMaxEnergy, F32, 2, 2, "")
{
   return object->getMaxEnergy();
}

REQUIRED CHANGES FOR TGE 1.3.1+
To use this GUI control with TGE 1.3.1 or above, you must make some minor changes.
In guiHealthTextCtrl.cc:
Change:

#include "gui/guiHealthTextCtrl.h"

To:

#include "gui/game/guiHealthTextCtrl.h"

Change:

GameConnection* conn = GameConnection::getServerConnection();

To:

GameConnection* conn = GameConnection::getConnectionToServer();

In guiHealthTextCtrl.h:
Change:

#include "gui/guiTypes.h"

To:

#include "gui/core/guiTypes.h"

Change:

#include "gui/guiTypes.h"

To:

#include "gui/core/guiTypes.h"

I should not be forgetting anything related to TGE 1.3.1+ changes.


To use this control, you just add it in through the WYSIWYG editor in TGE or you can use a text editor to manually place it in a file (client/ui/playGui.gui being the best choice with default configuration).
An important thing to note is that this GUI control functions like guiHealthBarHud. In other words, a dynamic variable called "displayEnergy" set in the datablock decides whether the text displayed is the avatars health or energy.

For example: In the project I am working on, it is used to display health like this:

new GuiHealthTextCtrl(Health) {
      profile = "HudTextProfile";
      horizSizing = "relative";
      vertSizing = "relative";
      position = "16 368";
      extent = "16 28";
      minExtent = "8 8";
      visible = "1";
      displayEnergy = "0";
         helpTag = "0";
   };

It is used to display energy like this:

new GuiHealthTextCtrl(Energy) {
      profile = "HudTextProfile";
      horizSizing = "relative";
      vertSizing = "relative";
      position = "48 368";
      extent = "20 28";
      minExtent = "8 8";
      visible = "1";
      displayEnergy = "1";
         helpTag = "0";
   };

As you will notice, the example for health has the "displayEnergy" variable set to "0", meaning it doesn't display the energy. Also, the second example, the example for energy has the "displayEnergy" variable set to "1", meaning it does display energy.

Also, I did not create a brand new GUI profile for this. In my uses, I used the "HudTextProfile" which gives it a light green that is easily viewable on the colored bars (if they are colored in your uses).

I hope you all enjoy this GUI control. I will be watching for a while to provide support and fix any bugs, :).

Robert Pierce
Lead Programmer
Uber Real Games