Skip to content

Open Text Entry

Open Text Entry

Opens a text entry user interface that allows the player to type in text.

Properties

System

Name Explanation Type
Initial Value The initial text to populate the text entry field with. Variable or Value
Picture An image to display alongside the text entry. Sprite or Model
Prompt The prompt text to display to the player in the text entry. Variable or Value
Result The variable to store the entered text in when the text entry is closed. Variable or Value
Text Entry The text entry user interface to open. User Interface

Examples

Open a Text Entry User Interface

This opens the text entry identified by the given unique ID, storing the player's input in Global Variable 0.

$gv[0] = open_text_entry("a1b2c3d4-e5f6-7890-abcd-ef1234567890");

{"Data":{"InitialValue":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Picture":{"Name":""},"Prompt":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"TextEntryID":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.UserInterface.OpenTextEntryCommand"}

Open a Text Entry with a Prompt and Initial Value

This opens the text entry with the prompt 'Enter your name' and the initial value 'Hero', storing the result in Global Variable 0.

$gv[0] = open_text_entry("a1b2c3d4-e5f6-7890-abcd-ef1234567890", prompt: "Enter your name", initial_value: "Hero");

{"Data":{"InitialValue":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"Hero","VariableIndex":0,"Metadata":null},"Picture":{"Name":""},"Prompt":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"Enter your name","VariableIndex":0,"Metadata":null},"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"TextEntryID":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.UserInterface.OpenTextEntryCommand"}