RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======Button======
----

A **button** is a clickable [[widget]] element that can be configured to run a [[script]], close the parent [[widget]], craft a new [[item]] into a [[item_storage_slot|storage slot]] using any populated [[crafting_input_slot|input slots]], or craft a specific [[item]] using the player's [[inventory]].

=====Element Properties=====
^Icon^Property^Description^
|{{:wiki:tag_id.png?nolink|}}|Element ID|ID for the button. 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:button.png?nolink|}}|Button Type|Determines whether the button will have standard behavior or if it will behave as a toggle button (i.e. the button toggles between an "on" and "off" state each time it's pressed).|
|{{:wiki:play.png?nolink|}}|Button Action|Determines what action will be taken when the button is pressed (only applicable to the "Standard" button type). The available options are to run a [[script]], close the parent [[widget]], craft a new [[item]] into a [[item_storage_slot|storage slot]] using any populated [[crafting_input_slot|input slots]], or craft a specific [[item]] using the player's [[inventory]].|
|{{:wiki:script.png?nolink|}}|Script|[[Script]] that will be triggered when the button is clicked. This option is only available when the button type is "Toggle" or the button type is "Standard" with an action of "Run Script". In both cases, a local variable named **$widget** will be available to your [[script]] that references the [[widget]] in which the button is contained. The **self** keyword will reference the button element itself. For toggle buttons, a local variable named **$pressed** will also be available. It will have a value of either true or false according to the new state of the button (i.e. pressed or not pressed).|
|{{:wiki:item.png?nolink|}}|Item|[[Item]] that the game will attempt to craft using the player's [[inventory]] when the button is clicked. This option is only available when the button type is "Standard" with an action of "Craft Item by ID".|
|{{:wiki:image.png?nolink|}}|Image|[[Image]] that will be displayed on the button. If an [[image]] is specified, it will appear to the left of the button's text.|
|{{:wiki:text.png?nolink|}}|Text|Text that will be displayed on the button.|
|{{:wiki:text_align_center.png?nolink|}}|Text Alignment|Determines the horizontal alignment of the text. The available options are "Left", "Center", and "Right".|
|{{:wiki:font.png?nolink|}}|Font|[[Font]] that will be used for the button'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 button's text.|

=====Scripting=====
You can access and change certain properties of a button from within a [[script]] by simply referencing the parent [[widget]] and the button element by their unique IDs. See below for examples of changing the text, [[image]], and [[script]] of a button. In these cases, the [[widget]] has an ID of "test" and the button has an ID of "0001".

**Changing a button's text:**
<code bauxite>
widget["test"].element["0001"].text = "New Text";
</code>

**Changing a button's image:**
<code bauxite>
widget["test"].element["0001"].image = "new_image.png";
</code>

**Changing a button's script:**
<code bauxite>
widget["test"].element["0001"].script = "new_script_name";
</code>

~~NOTOC~~
RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation
