Differences

This shows you the differences between two versions of the page.

--- text_field [2020/11/30 20:30] – justin
+++ text_field [2020/12/02 18:49] – justin
@@ Line 6: / Line 6: @@
 =====Element Properties=====
 ^Icon^Property^Description^
-(WIP)
+|{{:wiki:tag_id.png?nolink|}}|Element ID|ID for the text field. This ID must be unique amongst other elements within the same [[widget]]. It is currently auto-generated but will be editable in a future update.|
+|{{:wiki:text.png?nolink|}}|Text|Text that will be displayed in the text field.|
+|{{:wiki:eye.png?nolink|}}|Read-Only| |
+|{{:wiki:font.png?nolink|}}|Font|[[Font]] that will be used for the field's text. If the "Default" option is selected, your game's default dialogue [[font]] will be used.|
+|{{:wiki:font_size.png?nolink|}}|Font Size|[[Font]] size to use for the field's text.|
 =====Scripting=====
+You can access and change certain properties of a text field from within a [[script]] by simply referencing the parent [[widget]] and the element by their unique IDs. See below for examples of both changing the field's text and storing the field's text into a variable. In this case, the [[widget]] has an ID of "test" and the text field has an ID of "0001".
-(WIP - Accessing/changing properties of the element via scripts)
+**Changing a field's text:**
+<code bauxite>
+widget["test"].element["0001"].text = "New Text"
+</code>
+**Storing a field's text into a variable:**
+<code bauxite>
+$name = widget["test"].element["0001"].text;
+display_message("Hello, " + $name + "!")
+</code>
 ~~NOTOC~~

RPG in a BoxOfficial Documentation