User Tools

Site Tools


widget_editor

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
widget_editor [2020/12/01 11:18] justinwidget_editor [2023/02/06 22:05] (current) justin
Line 5: Line 5:
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-Custom [[widget|widgets]] can be displayed in-game using the [[Show Widget]] scripting function. You can also add them to the [[management screen]] by adding their IDs to the comma-separated list of [[widget|widgets]] in the "Experimental" section of your [[Game Configuration]].+Custom [[widget|widgets]] can be displayed in-game using the [[Show Widget]] scripting function. You can also add them to the [[management screen]] by going to the "Screens" tab of the UI Editor and adding their IDs to the comma-separated list of custom [[widget|widgets]].
 </WRAP> </WRAP>
 +
 +=====Creating a Widget=====
 +
 +To create a new [[widget]], click the "Add" button ({{:wiki:add.png?nolink|}}) on the main toolbar and then provide a unique ID that will be assigned to it. Once created, the width and height of the [[widget]] can be adjusted from the "Widget Properties" panel on the left-hand side of the editor. Elements (item slots, text fields, buttons, etc.) can be dragged and dropped from the "Widget Tools" panel onto the grid layout of the [[widget]].
 +
 +Elements that have been placed can be resized by selecting the element and then dragging the handles of the selection box. To delete an element, select it and press the Delete key or drag and drop it outside of the [[widget]].
 +
 +See the "Elements" section below for a description of each element type that can be added to a [[widget]].
  
 =====Main Toolbar===== =====Main Toolbar=====
Line 26: Line 34:
 |{{:wiki:widget_width.png?nolink|}}|Grid Width (Columns)|Width of the [[widget]], or number of columns in the grid. Elements placed into the [[widget]] are aligned to this grid.| |{{:wiki:widget_width.png?nolink|}}|Grid Width (Columns)|Width of the [[widget]], or number of columns in the grid. Elements placed into the [[widget]] are aligned to this grid.|
 |{{:wiki:widget_height.png?nolink|}}|Grid Height (Rows)|Height of the [[widget]], or number of rows in the grid. Elements placed into the [[widget]] are aligned to this grid.| |{{:wiki:widget_height.png?nolink|}}|Grid Height (Rows)|Height of the [[widget]], or number of rows in the grid. Elements placed into the [[widget]] are aligned to this grid.|
 +|{{:wiki:ui.png?nolink|}}|Initial Position|Determines where the [[widget]] will be initially positioned on the screen. This is particularly useful for [[widget|widgets]] that are fixed (i.e. not draggable).|
 |{{:wiki:window_frame_show.png?nolink|}}|Show Frame|Determines whether or not the frame graphic (i.e. the borders and background) is visible for this [[widget]]. Currently this graphic is inherited from the [[item container]] window style in your game's default [[theme_editor|theme]].| |{{:wiki:window_frame_show.png?nolink|}}|Show Frame|Determines whether or not the frame graphic (i.e. the borders and background) is visible for this [[widget]]. Currently this graphic is inherited from the [[item container]] window style in your game's default [[theme_editor|theme]].|
 |{{:wiki:window_free.png?nolink|}}|Draggable|Determines whether or not the player can move the [[widget]] around by clicking and dragging the titlebar or empty area of the window. The "Show Frame" property must be enabled for this option to be available.| |{{:wiki:window_free.png?nolink|}}|Draggable|Determines whether or not the player can move the [[widget]] around by clicking and dragging the titlebar or empty area of the window. The "Show Frame" property must be enabled for this option to be available.|
Line 32: Line 41:
  
 =====Elements===== =====Elements=====
-Various elements can be added to a [[widget]] using the "Widget Tools" panel on the left-hand side of the editor. A brief description of each type is provided below. You can click on the name of a particular element for more information on that element and any properties that can be edited.+Various elements can be added to a [[widget]] using the "Widget Tools" panel on the left-hand side of the editor. A brief description of each type is provided below. You can click on the name of a particular element for more information about that element and any properties that can edited once added to a [[widget]].
 ^Icon^Type^Description^ ^Icon^Type^Description^
 |{{:wiki:chest.png?nolink|}}|[[Item Storage Slot]]|Slot for storing an [[item]] or stack of [[item|items]]. This is useful for [[inventory]] windows, [[item container]] windows, or other [[widget|widgets]] that are meant for storing [[item|items]] into for later retrieval and usage.| |{{:wiki:chest.png?nolink|}}|[[Item Storage Slot]]|Slot for storing an [[item]] or stack of [[item|items]]. This is useful for [[inventory]] windows, [[item container]] windows, or other [[widget|widgets]] that are meant for storing [[item|items]] into for later retrieval and usage.|
 |{{:wiki:potion.png?nolink|}}|[[Item Quick Slot]]|Slot for assigning an [[item]] to that the player currently possesses (for example, a health potion). This type of slot acts as a shortcut and allows the player to easily access the [[item]] during gameplay instead of being required to open their [[inventory]].| |{{:wiki:potion.png?nolink|}}|[[Item Quick Slot]]|Slot for assigning an [[item]] to that the player currently possesses (for example, a health potion). This type of slot acts as a shortcut and allows the player to easily access the [[item]] during gameplay instead of being required to open their [[inventory]].|
 |{{:wiki:sword.png?nolink|}}|[[Equipment Slot]]|Slot for equipping an [[item]] to (for example, a sword or shield). The player can equip an [[item]] to the slot if the [[item]] has been configured as equippable in the [[Item Editor]] and it includes a tag matching the slot ID assigned to the equipment slot.| |{{:wiki:sword.png?nolink|}}|[[Equipment Slot]]|Slot for equipping an [[item]] to (for example, a sword or shield). The player can equip an [[item]] to the slot if the [[item]] has been configured as equippable in the [[Item Editor]] and it includes a tag matching the slot ID assigned to the equipment slot.|
 +|{{:jump.png?nolink|}}|[[Skill Slot]]|Slot for assigning a [[skill]] to (for example, a healing spell or physical ability).|
 |{{:wiki:coins.png?nolink|}}|[[Shop Item Slot]]|Slot for allowing an [[item]] to be purchased by the player. The cost of the [[item]] is configured in the [[Item Editor]].| |{{:wiki:coins.png?nolink|}}|[[Shop Item Slot]]|Slot for allowing an [[item]] to be purchased by the player. The cost of the [[item]] is configured in the [[Item Editor]].|
 |{{:wiki:anvil_in.png?nolink|}}|[[Crafting Input Slot]]|Slot that an [[item]] can be placed into for crafting purposes. Adding multiple crafting input slots to a [[widget]], along with a button configured as a "Crafting" button, will allow the player to combine [[item|items]] together to create something new. The ingredients/materials required to craft a particular [[item]] is configured in the [[Item Editor]].| |{{:wiki:anvil_in.png?nolink|}}|[[Crafting Input Slot]]|Slot that an [[item]] can be placed into for crafting purposes. Adding multiple crafting input slots to a [[widget]], along with a button configured as a "Crafting" button, will allow the player to combine [[item|items]] together to create something new. The ingredients/materials required to craft a particular [[item]] is configured in the [[Item Editor]].|
Line 46: Line 56:
 |{{:wiki:character.png?nolink|}}|[[3D Model]]|Element for displaying a 3D model that the player can rotate by clicking and dragging. This is currently limited to displaying the [[player_character|player character's]] model, with future updates allowing it to display others.| |{{:wiki:character.png?nolink|}}|[[3D Model]]|Element for displaying a 3D model that the player can rotate by clicking and dragging. This is currently limited to displaying the [[player_character|player character's]] model, with future updates allowing it to display others.|
 |{{:wiki:map.png?nolink|}}|[[minimap_element|Minimap]]|Element for displaying a top-down view of the current [[map]].| |{{:wiki:map.png?nolink|}}|[[minimap_element|Minimap]]|Element for displaying a top-down view of the current [[map]].|
- 
-=====Creating a Widget===== 
- 
-(WIP) 
  
 ~~NOTOC~~ ~~NOTOC~~
widget_editor.1606850300.txt.gz · Last modified: 2020/12/01 11:18 by justin