FHUDHitBox

Hitbox used for clickable HUD elements.

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()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback