Navigation
API > API/Runtime > API/Runtime/Engine
Hitbox used for clickable HUD elements. These are named regions that receive various events when clicked upon.
| Name | FHUDHitBox |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/GameFramework/HUDHitBox.h |
| Include Path | #include "GameFramework/HUDHitBox.h" |
Syntax
class FHUDHitBox
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FHUDHitBox
(
FVector2D InCoords, |
Constructor for a hitbox. | GameFramework/HUDHitBox.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bConsumesInput | bool | Wether or not this hitbox should prevent hit checks to other hitboxes. | GameFramework/HUDHitBox.h | |
| Coords | FVector2D | Coordinates of top left of hitbox. | GameFramework/HUDHitBox.h | |
| Name | FName | The name of this hitbox. | GameFramework/HUDHitBox.h | |
| Priority | int32 | The priority of this hitbox. Higher boxes are given priority. | GameFramework/HUDHitBox.h | |
| Size | FVector2D | Size of this hitbox. | GameFramework/HUDHitBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const bool ConsumesInput() |
Should other boxes be processed if this box is clicked. | GameFramework/HUDHitBox.h | |
bool Contains
(
FVector2D InCoords |
Are the given coordinates within this hitbox. | GameFramework/HUDHitBox.h | |
void Draw
(
FCanvas* InCanvas, |
Debug render for this hitbox. | GameFramework/HUDHitBox.h | |
const FName & GetName() |
Get the name of this hitbox. | GameFramework/HUDHitBox.h | |
const int32 GetPriority() |
Get the priority of this hitbox. | GameFramework/HUDHitBox.h |
See Also
-
AHud
-
AddHitBox()
-
ReceiveHitBoxClick()
-
ReceiveHitBoxRelease()
-
ReceiveHitBoxBeginCursorOver()
-
ReceiveHitBoxEndCursorOver()
-
NotifyHitBoxClick()
-
NotifyHitBoxRelease()
-
NotifyHitBoxBeginCursorOver()
-
NotifyHitBoxEndCursorOver()
-
GetHitBoxAtCoordinates()
-
GetHitBoxesAtCoordinates()
-
GetHitBoxWithName()