Health Canvas - SuedOnAIM/RF_CustomHUD_Edits GitHub Wiki

Health Canvas

image The HealthBarHUD has 5 game objects to it:

  • HealthBG is the black background. It can be altered/removed.
  • Red BG is the background color behind the player health bar. It appears when your health lowers. It can be altered/removed. Red BG should be the same size as Health.
  • RedFlash is a warning color that appears when your health is below half. It flashes by raising/lowering it's own transparency. Must edit CustomHUD_HealthBar.lua to remove RedFlash. Color can be changed without editing the script. RedFlash should be the same size as Health.
  • Health is the blue bar and displays your current player health. Color can be changed without editing the script.
  • Overheal is a compatibility feature from Enhanced Health System. When your current health is over 100, the Overheal bar will fill and overlay the health bar. Overheal's fill needs to be set to 0 for it to be compatible.

Health Mask Canvas

image
This canvas is an alternative health bar that uses a non-rectangular display and also includes a Numerical Health display.
To make this shape, you need an image with a mask component.
Then make the Health Bar and its game objects a child of the mask.

Numerical Health

image Numerical Health displays how much health the player has as a number.
The NumericalHealth object houses the script to display the current player health. It also includes a data container with a color change bool. Enabling the color change option makes the number turn red as player health lowers.
CurrentHealth is a text object.

Mutator Configuration

image
Configuration requires:
Bool id: healthBarVisibility