Skip to content

AMRISubjectController::SetDisplayText

Class: AMRISubjectController

Overloads

Overload 1

void AMRISubjectController::SetDisplayText(const FString &text, double duration=2.0, EDisplayedPromptType displayedPromptType=EDisplayedPromptType::Unknown, EDisplayTextColor color=EDisplayTextColor::White)

Sets the on-screen display text, its color, and how long it should remain visible.

Parameters

Parameter Type Description
text const FString & Text string to display on screen.
duration double Time in seconds to show the text; use -1 to display indefinitely.
displayedPromptType EDisplayedPromptType Semantic type of the prompt (for logging purposes).
color EDisplayTextColor Color in which to render the text.

Remarks

This base class manages the countdown timer; subclasses do not need to clear the text. text Text string to display on screen. duration Time in seconds to show the text; use -1 to display indefinitely. displayedPromptType Semantic type of the prompt (for logging purposes). color Color in which to render the text.

Overload 2

void AMRISubjectController::SetDisplayText(const FString &text, EDisplayedPromptType displayedPromptType=EDisplayedPromptType::Unknown, double duration=2.0, EDisplayTextColor color=EDisplayTextColor::White)

Overload to let you put in different things without specifying all the parameters.

Parameters

Parameter Type Description
text const FString & Text string to display on screen.
displayedPromptType EDisplayedPromptType Semantic type of the prompt (for logging purposes).
duration double Time in seconds to show the text; use -1 to display indefinitely.
color EDisplayTextColor Color in which to render the text.

Remarks

Delegates to the primary overload. text Text string to display on screen. displayedPromptType Semantic type of the prompt (for logging purposes). duration Time in seconds to show the text; use -1 to display indefinitely. color Color in which to render the text.