Skip to main content

77 docs tagged with "UI"

View All Tags

Objective Marker Attach To Player Or Object

Objective Marker Attach To Player Or Object sets the position of target Objective Marker to the position of an object or a player, for the local player. Marker will track target object or player until position is set again. If a tracked player leaves the room, the marker will remain at the last tracked position.

Objective Marker Constant

Objective Marker Constant defines the default appearance of an Objective Marker. Use with Objective Marker Set Enabled, Objective Marker Set Position, and the other Objective Marker chips.

Objective Marker Get Current Distance

Objective Marker Get Current Distance returns the current distance of the local player from the target Objective Marker, regardless of whether the distance indicator is enabled.

Objective Marker Get Enabled

Objective Marker Get Enabled returns whether or not the target Objective Marker is enabled for the local player.

Objective Marker Get Label

Objective Marker Get Label returns the current text label of target Objective Marker for the local player as a string.

Objective Marker Get Label Enabled

Objective Marker Get Label Is Enabled returns whether or not the target Objective Marker’s text label is visible for the local player.

Objective Marker Get Target Object

Objective Marker Get Target Object returns the object targeted by target Objective Marker, if it’s tracking an object. If target Objective Marker is not tracking an object, returns Invalid Object.

Objective Marker Get Target Player

Objective Marker Get Target Player returns the player targeted by target Objective Marker, if it’s tracking a player. If target Objective Marker is not tracking a player, returns Invalid Player.

Objective Marker Set Distance Enabled

Objective Marker Set Distance Enabled enables or disables the visibility of the target Objective Marker’s distance indicator for the local player.

Objective Marker Set Enabled

Objective Marker Set Enabled enables or disables the target Objective Marker for the local player. Use with Objective Marker constant.

Objective Marker Set Fade Threshold

Objective Marker Set Fade Threshold sets the fade threshold of the target Objective Marker for the local player. This threshold is the distance (in meters) at which the marker has fully faded from sight as a player approaches it. For finer control over the fade duration, configure the Objective Marker constant.

Objective Marker Set Label

Objective Marker Set Label sets the text label of target Objective Marker to the specified string for the local player.

Objective Marker Set Label Enabled

Objective Marker Set Label Enabled enables or disables the visibility of the target Objective Marker’s text label for the local player.

Objective Marker Set Position

Objective Marker Set Position sets the position of target Objective Marker to a position vector for the local player.

Player Prompt Multiple Choice

Sends a prompt to the specified player containing the prompt title and body, along with each of the answer choices on its own line. The player can choose a response and hit "ok," triggering the On Prompt Complete event. Since there is a delay between sending a prompt and receiving the response in which other responses may be received, the Player output can be used to disambiguate multiple responses. This prompt appears in the watch and can either bring the watch up automatically, or trigger a watch notification and show up when the player next opens their watch. To use a watch notification, disable the Immediate setting on the chip with the configure tool.

Player Prompt Text

Sends a prompt to the specified player where they can input text, which is then returned by this chip's output. This prompt appears in the watch and can either bring the watch up automatically, or trigger a watch notification and show up when the player next opens their watch. To use a watch notification, disable the Immediate setting on the chip with the configure tool.

Player Show Subtitle

Displays a subtitle for a specified duration. If there is already a subtitle showing, it will be replaced only if this subtitle has an equal or higher priority. If the string is more than 200 characters, it will be displayed in multiple subtitles, each lasting a fraction of the total duration. Escape characters are ignored.

Player World UI

Define a set of world-space UI elements that can appear above a player.

Prompt Local Player

Sends a watch notification to a player. The player which it sends a notification to depends on who's machine fires the exec pin. Once this watch notification is opened, the player can type responses into the text box and send back responses. You can define the prompt title and the prompt itself via inputs, and can also receive the player’s response via an output pin.

Room Level HUD

HUD elements including progress bars, wheels, and counters. Configure to customize a single element, then enable & modify with existing HUD chips. Can be configured to pull data from Room Progression if Progression is enabled in room settings.

Set Player Vignette

Apply a vignette of the given color to the given player. The vignette will be displayed at the given intensity for the given duration, and then fade out. The intensity must be between 0 and 1.

Show Reward Notification

Shows a player a notification about a single reward or a list of up to 4 rewards. Appearance can be customized in the config menu! Triggering this chip multiple times will queue the notifications up in order of execution, and each will play subsequently after the previous duration is reached.