FHUDHitBox Class Reference

#include <HUDHitBox.h>

Public Member Functions
ENGINE_API	FHUDHitBox (FVector2D InCoords, FVector2D InSize, const FName &InName, bool bInConsumesInput, int32 InPriority)
ENGINE_API bool	Contains (FVector2D InCoords) const
ENGINE_API void	Draw (class FCanvas *InCanvas, const FLinearColor &InColor) const
const FName &	GetName () const
const bool	ConsumesInput () const
const int32	GetPriority () const

Detailed Description

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

See also

AHud

AddHitBox(), ReceiveHitBoxClick(), ReceiveHitBoxRelease(), ReceiveHitBoxBeginCursorOver(), ReceiveHitBoxEndCursorOver()

NotifyHitBoxClick(), NotifyHitBoxRelease(), NotifyHitBoxBeginCursorOver(), NotifyHitBoxEndCursorOver()

GetHitBoxAtCoordinates(), GetHitBoxesAtCoordinates(), GetHitBoxWithName()

Constructor & Destructor Documentation

FHUDHitBox()

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

Constructor for a hitbox.

Parameters

InCoords	Coordinates of top left of hitbox.
InSize	Size of the box.

Member Function Documentation

ConsumesInput()

const bool FHUDHitBox::ConsumesInput ( ) const

inline

Should other boxes be processed if this box is clicked.

Contains()

bool FHUDHitBox::Contains

(

FVector2D

InCoords

)

const

Are the given coordinates within this hitbox.

Parameters

InCoords

Coordinates to check.

Returns

true if coordinates are within this hitbox.

Draw()

void FHUDHitBox::Draw	(	class FCanvas *	InCanvas,
		const FLinearColor &	InColor
	)		const

Debug render for this hitbox.

Parameters

InCanvas	Canvas on which to render.
InColor	Color to render the box.

GetName()

const FName & FHUDHitBox::GetName ( ) const

inline

Get the name of this hitbox.

GetPriority()

const int32 FHUDHitBox::GetPriority ( ) const

inline

Get the priority of this hitbox.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/GameFramework/HUDHitBox.h
• Engine/Source/Runtime/Engine/Private/GameFramework/HUDHitBox.cpp