Skip to main content

Interaction Prompt UI

NAMESPACEMyDreamGameStudio.InteractAnything
MENU PATHInteraction System > UI > Interaction Prompt UI
COMPATIBILITYUnity 6.0+
DOC VERSION

The primary contextual prompt system. This component tracks the currently active focused Interactable and projects a single screen-space UI panel over its world position. It handles displaying dynamic prompt text (e.g., "Press [E] to Open") and visualizing Hold interaction progress.

You only need one of these in your scene. It automatically reads from the global InteractionModeSwitcher or the active interactor to figure out what the player is currently focusing on.


Editor Interface​

INTERACTION PROMPT UICONTEXTUAL PROMPTSCREEN-SPACEScreen-space contextual prompt panel and progress tracker targeting the active focusedinteractable.PROJECTION CAMERA✦ Auto-Link ReferencesSourceProjection CameraNone (Camera)UI ELEMENTS & OFFSETSUI ReferencesPanel (Root)PromptContainer (Rect Transform)Prompt Text (TMP)ActionText (Text Mesh Pro UGUI)OffsetScreen Pixel OffsetX0Y0

Fully Customizable Layouts​

The InteractionPromptUI is not a hard-coded prefab. It is a controller script that you attach to your own custom Canvas UI.

Because it simply looks for a RectTransform, a TextMeshProUGUI field, and an optional Image, you can design the prompt however you like. You can use minimalist floating text, a heavy sci-fi tech box, or a simple circular crosshair that fills up.

ELootFHack

Configuration Variables​

Projection Camera
CameraDef: Camera.main
The camera used to perform the World-To-Screen projection. If left empty, it will automatically search for the main camera.
Panel (Root)
RectTransform
The master container for the UI. This is the object that is physically moved across your Canvas to track the world object. It is hidden when nothing is focused.
Prompt Text
TextMeshProUGUI
The text element that displays the `Prompt Text` string configured on the targeted Interactable.
Screen Pixel Offset
Vector2Def: (0,0)
Shifts the panel away from the exact center of the UI Anchor. Use this to prevent the prompt from completely obscuring the object the player is trying to look at.
Progress Display Mode
UI Link
Reveals slots for either an Image (must be set to 'Filled' mode in Unity) or a standard UI Slider. The panel automatically maps the 0-1 `HoldProgress` variable to these visuals when the target interactable requires a hold input.