Skip to main content

Overview

Use Show Text to display text overlays that guide learners with instructions, feedback, questions, and contextual information. Use Hide Text to remove text overlays when they are no longer needed. Both Title and Body support variable interpolation. Use {{variableName}} to insert a training variable’s value into the text. Create the variable and use Set Variable to set its value before Show Text runs.

Show Text

When to Use

  • Display step-by-step instructions
  • Show feedback on correct or incorrect answers
  • Display step titles or progress messages
  • Show congratulations or completion messages
  • Provide context-specific guidance

Parameters

Enter Body before using Edit in Scene to position the text. Expand Position to review its reference object, position, rotation, and scale after placement.
The browser Trainee App displays Show Text as a screen overlay. Its 3D placement and camera-follow settings are not applied there. Verify scene placement on the target device used for training.
Duration (ms) controls automatic hiding. Wait Until Complete controls when subsequent actions run. In the browser Trainee App, enabling Wait Until Complete with no duration keeps subsequent actions waiting until the trainee closes the text. A configured duration also ends the wait when it expires.

Example: Simple Instruction

A simple text overlay appears with the instruction.

Example: Show a Titled Message for Five Seconds

Add Show Text to the step’s On Entry actions:
The message automatically hides after five seconds unless it is closed or hidden sooner. Subsequent actions start immediately because Wait Until Complete is unchecked.

Example: With Variable Interpolation

Create two Number variables named score and total in the Variables pane. See Creating Variables for the setup steps. For this example, add these actions to a step’s On Entry list in this order:
  1. Set Variable: set score to 8.
  2. Set Variable: set total to 10.
  3. Show Text: enter You scored {{score}} out of {{total}}. in Body.
The displayed result is: You scored 8 out of 10. In an assessment, update score as the trainee completes tasks and use the recorded value in the results step. The fixed values above demonstrate how interpolation works.

Example: Feedback on Answer

Create String variables named userName and componentName. Before showing the feedback, use Set Variable to assign their values. For this example, set userName to "Alex" and componentName to "power switch".
The displayed result is: Correct! Alex, you identified the power switch correctly. These variable names are examples you define and populate in the training; Show Text does not automatically look up the learner’s name or the selected component.

Hide Text

When to Use

  • Remove instructions before the next step
  • Clear feedback messages to avoid confusion
  • Clean up text overlays during transitions
  • Reset UI state between states

Parameters

Example: Hide the Most Recent Text

The most recently shown text is hidden. Other text overlays retain their existing visibility.

Example: Hide Specific Text

In Hide Text, select the Show Text action that displays the step’s instructions under Target Show Text Action. The text displayed by that action is hidden. Other text overlays retain their existing visibility. To hide several text overlays, add a separate Hide Text action for each corresponding Show Text action and select it explicitly.

Best Practices

1

Show text in onEntry

Use Show Text in the onEntry actions of a state to display instructions or prompts.
2

Hide text in onExit

Use Hide Text in the onExit actions and select the corresponding Target Show Text Action to remove the intended text before transitioning.
3

Use variable interpolation

Insert values from your training variables using {{variableName}}. Match each variable’s name exactly and set its value before showing the text.
4

Keep text concise

Use short, clear messages. Long paragraphs are hard to read on small screens.
5

Test on the target device

Check readability, display duration, and any scene placement in the Trainee App used by your trainees.
  • Show Panel — More complex UI with buttons, input fields, and media
  • Show Image — Display diagrams or reference photos alongside text