FHUDHitBox

Hitbox used for clickable HUD elements.

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/HUDHitBox.h

Include

#include "GameFramework/HUDHitBox.h"

Syntax

class FHUDHitBox

Remarks

Hitbox used for clickable HUD elements. These are named regions that receive various events when clicked upon.

Constructors

Name Description

Public function

FHUDHitBox

(
    FVector2D InCoords,
    FVector2D InSize,
    const FName& InName,
    bool bInConsumesInput,
    int32 InPriority
)

Constructor for a hitbox.

Functions

Name Description

Public function Const

const bool

 

ConsumesInput()

Should other boxes be processed if this box is clicked.

Public function Const

bool

 

Contains

(
    FVector2D InCoords
)

Are the given coordinates within this hitbox.

Public function Const

void

 

Draw

(
    FCanvas* InCanvas,
    const FLinearColor& InColor
)

Debug render for this hitbox.

Public function Const

const FName ...

 

GetName()

Get the name of this hitbox.

Public function Const

const int32

 

GetPriority()

Get the priority of this hitbox.

See Also

AHud

AddHitBox()

ReceiveHitBoxClick()

ReceiveHitBoxRelease()

ReceiveHitBoxBeginCursorOver()

ReceiveHitBoxEndCursorOver()

NotifyHitBoxClick()

NotifyHitBoxRelease()

NotifyHitBoxBeginCursorOver()

NotifyHitBoxEndCursorOver()

GetHitBoxAtCoordinates()

GetHitBoxesAtCoordinates()

GetHitBoxWithName()