S2ENGINE HD 2023
User guide
×
Menu
Index

HUD

The Head Up Display (HUD) is a UI screen that contains all indicators player needs, such as energy bar, selected weapon, weapon bullets, armor, etc...
 
HOW IT WORKS?
As said, the Player has the control of the HUD elements. That means, for example, that if player receives a damage and his health value decreases, he directly updates the corresponding health progress bar and textual label on the HUD. But how the player can recognize what HUD element to update? He uses element names, in other words every element in the HUD controlled by the player must have a pre-defined name to make player to recognize it when he must update it.
If player doesn't find an element simply he doesn't update it.
In this way you can configure the HUD as you want, keeping certain elements and erasing others, the player will control only what he finds.
A good erxample of this mechanism are Templates provided with Easy Game pack installation, they offer different HUDs for different game types.
 
Following is a hypothetical full-featured HUD (in real applications usually only a subset of all elements is used), showed for exaplining all elements controlled by player, they are listed using names that they must have to be recognized by player.
There are other "decorative" elements and elements that contain other ones, they have been used for decorating or organizing the interface but they aren't managed by the player, you can organize the interface as you want by adding other container elements or decorative ones without affecting the HUD behaviour.
6.3.1.1. HUD
1

damageIndicator

1. damageIndicator
<TODO>: Insert description text here...
2

Target

2. Target
<TODO>: Insert description text here...
3

targetText

3. targetText
<TODO>: Insert description text here...
4

minimap

4. minimap
<TODO>: Insert description text here...
5

ammo

5. ammo
<TODO>: Insert description text here...
6

ammo_projs

6. ammo_projs
<TODO>: Insert description text here...
7

ammo_loads

7. ammo_loads
<TODO>: Insert description text here...
8

hand_weapon_slot0

8. hand_weapon_slot0
<TODO>: Insert description text here...
9

hande_weapon_slot1

9. hande_weapon_slot1
<TODO>: Insert description text here...
10

TargetCaption

10. TargetCaption
<TODO>: Insert description text here...
11

armor

11. armor
<TODO>: Insert description text here...
12

armor_val

12. armor_val
<TODO>: Insert description text here...
13

armor_max

13. armor_max
<TODO>: Insert description text here...
14

health

14. health
<TODO>: Insert description text here...
15

health_val

15. health_val
<TODO>: Insert description text here...
16

health_max

16. health_max
<TODO>: Insert description text here...
17

mission_notify

17. mission_notify
<TODO>: Insert description text here...
18

mission_report

18. mission_report
<TODO>: Insert description text here...
19

mission_completed_text

19. mission_completed_text
<TODO>: Insert description text here...
20

UseHandItemActionCommand

20. UseHandItemActionCommand
<TODO>: Insert description text here...
21

PrevHandItemCommand

21. PrevHandItemCommand
<TODO>: Insert description text here...
22

NextHandItemCommand

22. NextHandItemCommand
<TODO>: Insert description text here...
23

hand_Item_slot0

23. hand_Item_slot0
<TODO>: Insert description text here...
24

hand_item_slot_count0

24. hand_item_slot_count0
<TODO>: Insert description text here...
25

bullet_time_progress

25. bullet_time_progress
<TODO>: Insert description text here...
26

battery

26. battery
<TODO>: Insert description text here...