Skip to content

IAndromedaPromptableInterface

Kind: class Source: Source/Andromeda/Capabilities/AndromedaPromptableInterface.h

Public Static Methods

Member Type Summary
IsPromptable bool Returns whether an object implements the prompt capability contract.

Public Methods

Member Type Summary
CanShowPrompt bool Reports whether the prompt should currently be shown for the supplied pawn.
GetPromptText FText Returns the player-facing prompt text for this object.
GetPromptEvents UAndromedaCapabilityEventsComponent * Returns an optional event source for same-focus prompt refreshes.

Members

IsPromptable

static bool IAndromedaPromptableInterface::IsPromptable(const UObject *Object)

Returns whether an object implements the prompt capability contract.

Parameters:

Name Type Description
Object const UObject * Object to inspect.

Returns:

True when Object is non-null and implements UAndromedaPromptableInterface.

CanShowPrompt

bool IAndromedaPromptableInterface::CanShowPrompt(APawn *ViewingPawn) const

Reports whether the prompt should currently be shown for the supplied pawn.

This controls prompt display, not whether the object can hold focus. Implementations should include transient prompt availability.

Parameters:

Name Type Description
ViewingPawn APawn * Pawn whose focus would display the prompt.

Returns:

True when the HUD should request and display prompt text.

GetPromptText

FText IAndromedaPromptableInterface::GetPromptText(APawn *ViewingPawn) const

Returns the player-facing prompt text for this object.

Use FText and centralized text keys for player-facing copy.

Parameters:

Name Type Description
ViewingPawn APawn * Pawn whose focus is displaying the prompt.

Returns:

Prompt text to show, or empty text when no prompt should be shown.

GetPromptEvents

UAndromedaCapabilityEventsComponent * IAndromedaPromptableInterface::GetPromptEvents() const

Returns an optional event source for same-focus prompt refreshes.

Returns:

Event source for prompt changes, or nullptr when prompt state is stable while focused.