Difference between revisions of "GUIWindowDefinitionWML"

From The Battle for Wesnoth Wiki
(Lobby sounds options)
 
(14 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
The window definition define how the windows shown in the dialog look.
 
The window definition define how the windows shown in the dialog look.
== Addon connect ==
+
== Community ==
  
This shows the dialog for managing addons and connecting to the addon server.
+
This shows a dialog displaying community links.
  
 
{| border="1"
 
{| border="1"
Line 12: Line 12:
 
!Description
 
!Description
 
|-
 
|-
| hostname
+
| forums
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Links to the Wesnoth forums
 +
|-
 +
| discord
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Links to the Wesnoth Discord server
 +
|-
 +
| irc
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Links to a web client for the Wesnoth IRC channels
 +
|-
 +
| steam
 +
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| This text contains the name of the server to connect to.
+
| Links to the Wesnoth Steam forums
 
|-
 
|-
| show_help
+
| reddit
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Thus button shows the in-game help about add-ons management when triggered.
+
| Links to the Wesnoth sub-reddit
 
|-
 
|-
| ''free to choose'' (2)
+
| donate
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
| no
+
| yes
| This button closes the dialog to display a dialog for removing installed add-ons.
+
| Links to the SPI donation page for Wesnoth
 
|}
 
|}
== Add-on description ==
+
== Editor: Edit PBL ==
  
Add-on description and details for the add-ons manager interface.
+
* Dialog for editing an add-on's _server.pbl.
  
 
{| border="1"
 
{| border="1"
Line 37: Line 52:
 
!Description
 
!Description
 
|-
 
|-
| image
+
| name
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying the add-on icon, in a 72x72 area.
+
| The name of the add-on displayed on the UI.
 
|-
 
|-
| title
+
| description
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#scroll_text|scroll_text]]
 +
| yes
 +
| The add-on's description.
 +
|-
 +
| icon
 +
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Dialog title label, corresponding to the add-on name.
+
| The add-on's icon.
 
|-
 
|-
| type
+
| author
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying the add-on's type.
+
| The author of the add-on. When using forum_auth, this must be a forum username.
 
|-
 
|-
 
| version
 
| version
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying the add-on version number.
+
| The add-on's version.
 
|-
 
|-
| status
+
| dependencies
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying the current installation/upgradability status.
+
| Other add-on IDs which this add-on depends on.
 
|-
 
|-
| author
+
| tags
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#multimenu_button|multimenu_button]]
 
| yes
 
| yes
| Label for displaying the add-on author/maintainer name.
+
| Tags for the add-on for searching in the add-ons manager.
 
|-
 
|-
| size
+
| type
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#menu_button|menu_button]]
 
| yes
 
| yes
| Label for displaying the add-on package size.
+
| The type of the add-on.
 
|-
 
|-
| downloads
+
| forum_thread
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying the add-on's download count.
+
| The topic ID of this add-on's forum feedback thread.
 
|-
 
|-
| description
+
| forum_auth
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Text label for displaying the add-on's description. The control can be given a text, this text is shown when the addon has no description. If the addon has a description this field shows the description of the addon.
+
| Whether to use forum authentication when uploading or deleting the add-on.
 
|-
 
|-
| translations
+
| secondary_authors
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying a list of translations provided by the add-on. Like the ''description'' it can also show a default text if no translations are available.
+
| Any other forum usernames of people who are also allowed to upload updates for this add-on. Only works with forum_auth being enabled.
 
|-
 
|-
| dependencies
+
| email
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label for displaying a list of dependencies of the add-on. Like the ''description'' it can also show a default text if no dependencies are defined.
+
| A contact email address. Requred when not using forum_auth.
 
|-
 
|-
| updated
+
| password
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Label displaying the add-on's last upload date.
+
| The password to use when uploading the add-on. Requred when not using forum_auth.
 +
|}
 +
== Editor: Choose Add-on ==
 +
 
 +
Dialog for choosing the add-on to use in the editor.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| created
+
| existing_addons
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Label displaying the add-on's first upload date.
+
| A listbox that contains all available options for choosing an add-on
 +
|}
 +
== Editor: PBL Translations ==
 +
 
 +
Dialog for adding a translation while editing an add-on's _server.pbl.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| url
+
| language
 
| [[GUIToolkitWML#text_box|text_box]]
 
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Textbox displaying the add-on's feedback page URL if provided by the server.
+
| The language code for this translation.
 
|-
 
|-
| url_go
+
| lang_title
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Button for launching a web browser to visit the add-on's feedback page URL if provided by the server.
+
| The name of the language displayed on the UI.
 
|-
 
|-
| url_copy
+
| description
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Button for copying the add-on's feedback page URL to clipboard if provided by the server.
+
| The description of the translation.
 
|}
 
|}
== Add-on filter options ==
+
== Prompt ==
  
Advanced filtering options for the legacy (GUI1) Add-ons Manager dialog.
+
Dialog for getting a single text value from the player.
  
 
{| border="1"
 
{| border="1"
Line 127: Line 167:
 
!Description
 
!Description
 
|-
 
|-
| statuses_list
+
| prompt_box
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| A listbox for displaying and selecting add-on installation status filter options.
+
| The text box to enter the value into.
 +
|}
 +
== Add-on Auth ==
 +
 
 +
This shows the dialog to provide a password when uploading an add-on.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| toggle_all_displayed_types
+
| password
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| This button toggles the values for all the widgets used to control the following add-on display options.
+
| The password used to verify the uploader.
 +
|}
 +
== MP Report ==
 +
 
 +
This shows a dialog to report players on the multiplayer server.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| show_unknown
+
| reportee
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Whether to display add-ons of unknown type.
+
| The person being reported.
 
|-
 
|-
| show_sp_campaigns
+
| report_reason
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Whether to display single-player campaign add-ons.
+
| Why they're being reported.
 
|-
 
|-
| show_sp_scenarios
+
| occurrence_location
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#menu_button|menu_button]]
 
| yes
 
| yes
| Whether to display single-player scenario add-ons.
+
| Where in-game it happened.
 
|-
 
|-
| show_mp_campaigns
+
| additional_information
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Whether to display multiplayer campaign add-ons.
+
| Any additional information to add.
 +
|}
 +
== Achievements ==
 +
 
 +
This shows a dialog displaying achievements.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| show_mp_scenarios
+
| selected_achievements_list
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#menu_button|menu_button]]
 
| yes
 
| yes
| Whether to display multiplayer scenario add-ons.
+
| Allows selecting achievements by what content they're for.
 
|-
 
|-
| show_mp_maps
+
| name
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Whether to display multiplayer map-pack add-ons.
+
| The user displayed name of the achievement.
 
|-
 
|-
| show_mp_eras
+
| description
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Whether to display multiplayer era add-ons.
+
| The achievement's longer description.
 
|-
 
|-
| show_mp_factions
+
| icon
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#image|image]]
 
| yes
 
| yes
| Whether to display multiplayer faction add-ons.
+
| An icon to display to the left of the achievement.
 +
|}
 +
== Addon connect ==
 +
 
 +
This shows the dialog for managing addons and connecting to the addon server.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| show_mp_mods
+
| hostname
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Whether to display multiplayer mod add-ons.
+
| This text contains the name of the server to connect to.
 
|-
 
|-
| show_media
+
| show_help
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Whether to display author resource add-ons.
+
| Thus button shows the in-game help about add-ons management when triggered.
 
|-
 
|-
| show_other
+
| ''free to choose'' (2)
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#button|button]]
| yes
+
| no
| Whether to display add-ons of indeterminate types.
+
| This button closes the dialog to display a dialog for removing installed add-ons.
 +
|}
 +
== Add-on description ==
 +
 
 +
Add-on description and details for the add-ons manager interface.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| sort_ascending
+
| image
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Display add-ons in ascending order by default.
+
| Label for displaying the add-on icon, in a 72x72 area.
 
|-
 
|-
| sort_descending
+
| title
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Display add-ons in descending order by default.
+
| Dialog title label, corresponding to the add-on name.
 
|-
 
|-
| sort_by_name
+
| type
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Sort add-ons by name by default.
+
| Label for displaying the add-on's type.
 
|-
 
|-
| sort_by_last_updated
+
| version
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Sort add-ons by last update time by default.
+
| Label for displaying the add-on version number.
 
|-
 
|-
| sort_by_first_upload
+
| status
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Sort add-ons by creation time by default.
+
| Label for displaying the current installation/upgradability status.
|}
 
== Addon list ==
 
 
 
This shows the dialog with the addons to install. This dialog is under
 
construction and only used with --new-widgets.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| addons
+
| author
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| A listbox that will contain the info about all addons on the server.
+
| Label for displaying the add-on author/maintainer name.
 
|-
 
|-
|         name
+
| size
 +
| [[GUIToolkitWML#control|control]]
 +
| yes
 +
| Label for displaying the add-on package size.
 +
|-
 +
| downloads
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| The name of the addon.
+
| Label for displaying the add-on's download count.
 
|-
 
|-
|         version
+
| description
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| The version number of the addon.
+
| Text label for displaying the add-on's description. The control can be given a text, this text is shown when the addon has no description. If the addon has a description this field shows the description of the addon.
 
|-
 
|-
|         author
+
| translations
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| The author of the addon.
+
| Label for displaying a list of translations provided by the add-on. Like the ''description'' it can also show a default text if no translations are available.
 
|-
 
|-
|         downloads
+
| dependencies
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| The number of times the addon has been downloaded.
+
| Label for displaying a list of dependencies of the add-on. Like the ''description'' it can also show a default text if no dependencies are defined.
 
|-
 
|-
|         size
+
| updated
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| The size of the addon.
+
| Label displaying the add-on's last upload date.
|}
+
|-
== Add-on uninstall list ==
+
| created
 +
| [[GUIToolkitWML#control|control]]
 +
| yes
 +
| Label displaying the add-on's first upload date.
 +
|-
 +
| url
 +
| [[GUIToolkitWML#text_box|text_box]]
 +
| yes
 +
| Textbox displaying the add-on's feedback page URL if provided by the server.
 +
|-
 +
| url_go
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Button for launching a web browser to visit the add-on's feedback page URL if provided by the server.
 +
|-
 +
| url_copy
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Button for copying the add-on's feedback page URL to clipboard if provided by the server.
 +
|}
 +
== Add-on filter options ==
  
Dialog with a checkbox list for choosing installed add-ons to remove.
+
Advanced filtering options for the legacy (GUI1) Add-ons Manager dialog.
  
 
{| border="1"
 
{| border="1"
Line 268: Line 372:
 
!Description
 
!Description
 
|-
 
|-
| addons_list
+
| statuses_list
 
| [[GUIToolkitWML#listbox|listbox]]
 
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| A listbox containing add-on selection entries.
+
| A listbox for displaying and selecting add-on installation status filter options.
 +
|-
 +
| toggle_all_displayed_types
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| This button toggles the values for all the widgets used to control the following add-on display options.
 
|-
 
|-
|         checkbox
+
| show_unknown
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| A toggle button allowing the user to mark/unmark the add-on.
+
| Whether to display add-ons of unknown type.
 
|-
 
|-
|         name
+
| show_sp_campaigns
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
 
| The name of the add-on.
 
|}
 
== Campaign difficulty ==
 
 
 
The campaign mode difficulty menu.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
|-
 
| title
 
| [[GUIToolkitWML#label|label]]
 
 
| yes
 
| yes
| Dialog title label.
+
| Whether to display single-player campaign add-ons.
 
|-
 
|-
| message
+
| show_sp_scenarios
| [[GUIToolkitWML#scroll_label|scroll_label]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
+
| yes
| Text label displaying a description or instructions.
+
| Whether to display single-player scenario add-ons.
 
|-
 
|-
| listbox
+
| show_mp_campaigns
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Listbox displaying user choices, defined by WML for each campaign.
+
| Whether to display multiplayer campaign add-ons.
 
|-
 
|-
|         icon
+
| show_mp_scenarios
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Widget which shows a listbox item icon, first item markup column.
+
| Whether to display multiplayer scenario add-ons.
 
|-
 
|-
|         label
+
| show_mp_maps
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Widget which shows a listbox item label, second item markup column.
+
| Whether to display multiplayer map-pack add-ons.
 
|-
 
|-
|         description
+
| show_mp_eras
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Widget which shows a listbox item description, third item markup column.
+
| Whether to display multiplayer era add-ons.
|}
 
== Campaign selection ==
 
 
 
This shows the dialog which allows the user to choose which campaign to
 
play.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| campaign_list
+
| show_mp_factions
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| A listbox that contains all available campaigns.
+
| Whether to display multiplayer faction add-ons.
 
|-
 
|-
|         icon
+
| show_mp_mods
| [[GUIToolkitWML#image|image]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
+
| yes
| The icon for the campaign.
+
| Whether to display multiplayer mod add-ons.
 
|-
 
|-
|         name
+
| show_media
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
+
| yes
| The name of the campaign.
+
| Whether to display author resource add-ons.
 
|-
 
|-
|         victory
+
| show_other
| [[GUIToolkitWML#image|image]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
+
| yes
| The icon to show when the user finished the campaign. The engine determines whether or not the user has finished the campaign and sets the visible flag for the widget accordingly.
+
| Whether to display add-ons of indeterminate types.
 
|-
 
|-
| campaign_details
+
| sort_ascending
| [[GUIToolkitWML#multi_page|multi_page]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| A multi page widget that shows more details for the selected campaign.
+
| Display add-ons in ascending order by default.
 
|-
 
|-
|         image
+
| sort_descending
| [[GUIToolkitWML#image|image]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
+
| yes
| The image for the campaign.
+
| Display add-ons in descending order by default.
 +
|-
 +
| sort_by_name
 +
| [[GUIToolkitWML#toggle_button|toggle_button]]
 +
| yes
 +
| Sort add-ons by name by default.
 +
|-
 +
| sort_by_last_updated
 +
| [[GUIToolkitWML#toggle_button|toggle_button]]
 +
| yes
 +
| Sort add-ons by last update time by default.
 
|-
 
|-
|         description
+
| sort_by_first_upload
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| no
+
| yes
| The description of the campaign.
+
| Sort add-ons by creation time by default.
 
|}
 
|}
== Campaign settings ==
+
== Addon list ==
  
This shows the dialog which allows the user to select an era
+
Shows the list of addons on the server available for installation.
and modifications for the selected campaign, and to show
 
dialogs for additional level configuration.
 
  
 
{| border="1"
 
{| border="1"
Line 381: Line 472:
 
!Description
 
!Description
 
|-
 
|-
| title
+
| addons
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Dialog title label.
+
| A listbox that will contain the info about all addons on the server.
 
|-
 
|-
| mp_configure
+
| name
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Option to show the multiplayer configure dialog.
+
| The name of the addon.
 
|-
 
|-
| mp_connect
+
| version_filter
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#menu_button|menu_button]]
 
| yes
 
| yes
| Option to show the multiplayer connect dialog.
+
| List allowing current or older versions to be selected.
 
|-
 
|-
| era_label
+
| author
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| The label for the era list.
+
| The author of the addon.
 
|-
 
|-
| era_list
+
| downloads
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| List of available eras.
+
| The number of times the addon has been downloaded.
 
|-
 
|-
|         era
+
| size
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
| no
+
| yes
| The name of the era. One can be selected at a time.
+
| The size of the addon.
 
|-
 
|-
| mod_label
+
| tags
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| The label for the modification list.
+
| Contents of the PblWML "tags" attribute.
 +
|}
 +
 
 +
== Add-on uninstall list ==
 +
 
 +
Dialog with a checkbox list for choosing installed add-ons to remove.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| modification_list
+
| addons_list
 
| [[GUIToolkitWML#listbox|listbox]]
 
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| List of available modifications.
+
| A listbox containing add-on selection entries.
 
|-
 
|-
|         mod
+
|         checkbox
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 +
| yes
 +
| A toggle button allowing the user to mark/unmark the add-on.
 +
|-
 +
|         name
 +
| [[GUIToolkitWML#control|control]]
 
| no
 
| no
| The name of the modification. Each can be enabled or disabled.
+
| The name of the add-on.
 
|}
 
|}
== Clock ==
+
== Campaign difficulty ==
  
This shows the dialog for keeping track of the drawing events related to the
+
The campaign mode difficulty menu.
current time. (This window is used for debug purposes only.)
 
  
 
{| border="1"
 
{| border="1"
Line 437: Line 543:
 
!Description
 
!Description
 
|-
 
|-
| hour_percentage
+
| title
| [[GUIToolkitWML#progress_bar|progress_bar]]
+
| [[GUIToolkitWML#label|label]]
| no
+
| yes
| This shows the hours as a percentage, where 24 hours is 100%.
+
| Dialog title label.
 
|-
 
|-
| minute_percentage
+
| message
| [[GUIToolkitWML#progress_bar|progress_bar]]
+
| [[GUIToolkitWML#scroll_label|scroll_label]]
 
| no
 
| no
| This shows the minutes as a percentage, where 60 minutes is 100%.
+
| Text label displaying a description or instructions.
 
|-
 
|-
| second_percentage
+
| listbox
| [[GUIToolkitWML#progress_bar|progress_bar]]
+
| [[GUIToolkitWML#listbox|listbox]]
| no
+
| yes
| This shows the seconds as a percentage, where 60 seconds is 100%.
+
| Listbox displaying user choices, defined by WML for each campaign.
 
|-
 
|-
| hour
+
|         icon
| [[GUIToolkitWML#integer_selector|integer_selector]]
+
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| This shows the seconds since the beginning of the day. The control should have a ''minimum_value'' of 0 and a ''maximum_value'' of 86399 (246060 - 1).
+
| Widget which shows a listbox item icon, first item markup column.
 
|-
 
|-
| minute
+
|         label
| [[GUIToolkitWML#integer_selector|integer_selector]]
+
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| This shows the seconds since the beginning of the current hour. The control should have a ''minimum_value'' of 0 and a ''maximum_value'' of 3599 (6060 - 1).
+
| Widget which shows a listbox item label, second item markup column.
 
|-
 
|-
| minute
+
|         description
| [[GUIToolkitWML#integer_selector|integer_selector]]
 
| no
 
| This shows the seconds since the beginning of the current minute. The control should have a ''minimum_value'' of 0 and a ''maximum_value'' of 59.
 
|-
 
| clock
 
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
| no
+
| yes
| A control which will have set three variables in its canvas:
+
| Widget which shows a listbox item description, third item markup column.
* hour, the same value as the hour integer_selector.
 
* minute, the same value as the minute integer_selector.
 
* second, the same value as the second integer_selector.
 
the control can then should the time in its own preferred format(s).
 
 
|}
 
|}
== Core selection ==
+
== Campaign selection ==
  
This shows the dialog which allows the user to choose which core to
+
This shows the dialog which allows the user to choose which campaign to
 
play.
 
play.
  
Line 487: Line 584:
 
!Description
 
!Description
 
|-
 
|-
| core_list
+
| campaign_list
 
| [[GUIToolkitWML#listbox|listbox]]
 
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| A listbox that contains all available cores.
+
| A listbox that contains all available campaigns.
 
|-
 
|-
 
|         icon
 
|         icon
 
| [[GUIToolkitWML#image|image]]
 
| [[GUIToolkitWML#image|image]]
 
| no
 
| no
| The icon for the core.
+
| The icon for the campaign.
 
|-
 
|-
 
|         name
 
|         name
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
 
| no
 
| no
| The name of the core.
+
| The name of the campaign.
 +
|-
 +
|         victory
 +
| [[GUIToolkitWML#image|image]]
 +
| no
 +
| The icon to show when the user finished the campaign. The engine determines whether or not the user has finished the campaign and sets the visible flag for the widget accordingly.
 
|-
 
|-
| core_details
+
| campaign_details
 
| [[GUIToolkitWML#multi_page|multi_page]]
 
| [[GUIToolkitWML#multi_page|multi_page]]
 
| yes
 
| yes
| A multi page widget that shows more details for the selected core.
+
| A multi page widget that shows more details for the selected campaign.
 
|-
 
|-
 
|         image
 
|         image
 
| [[GUIToolkitWML#image|image]]
 
| [[GUIToolkitWML#image|image]]
 
| no
 
| no
| The image for the core.
+
| The image for the campaign.
 
|-
 
|-
 
|         description
 
|         description
 
| [[GUIToolkitWML#control|control]]
 
| [[GUIToolkitWML#control|control]]
 
| no
 
| no
| The description of the core.
+
| The description of the campaign.
 
|}
 
|}
== Custom Schedules ==
+
== Campaign settings ==
  
This shows the dialog to modify tod schedules.
+
This shows the dialog which allows the user to select an era
 +
and modifications for the selected campaign, and to show
 +
dialogs for additional level configuration.
  
 
{| border="1"
 
{| border="1"
Line 527: Line 631:
 
!Description
 
!Description
 
|-
 
|-
| current_tod_name
+
| title
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| The name of the time of day(ToD).
+
| Dialog title label.
 
|-
 
|-
| current_tod_id
+
| mp_configure
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| The id of the time of day(ToD).
+
| Option to show the multiplayer configure dialog.
 
|-
 
|-
| current_tod_image
+
| mp_connect
| [[GUIToolkitWML#image|image]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| The image for the time of day(ToD).
+
| Option to show the multiplayer connect dialog.
 
|-
 
|-
| current_tod_mask
+
| era_label
| [[GUIToolkitWML#image|image]]
 
| yes
 
| The image mask for the time of day(ToD).
 
|-
 
| current_tod_sonund
 
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| The sound for the time of day(ToD).
+
| The label for the era list.
 
|-
 
|-
| next_tod
+
| era_list
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Selects the next ToD.
+
| List of available eras.
 
|-
 
|-
| prev_tod
+
|         era
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#label|label]]
| yes
+
| no
| Selects the previous ToD.
+
| The name of the era. One can be selected at a time.
 
|-
 
|-
| lawful_bonus
+
| mod_label
| [[GUIToolkitWML#slider|slider]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Sets the Lawful Bonus for the current ToD.
+
| The label for the modification list.
 
|-
 
|-
| tod_red
+
| modification_list
| [[GUIToolkitWML#slider|slider]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Sets the red component of the current ToD.
+
| List of available modifications.
 
|-
 
|-
| tod_green
+
|         mod
| [[GUIToolkitWML#slider|slider]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| yes
+
| no
| Sets the green component of the current ToD.
+
| The name of the modification. Each can be enabled or disabled.
|-
+
|}
| tod_blue
+
== Debug Clock ==
| [[GUIToolkitWML#slider|slider]]
 
| yes
 
| Sets the blue component of the current ToD.
 
|}
 
== SP/MP Dependency Check: Confirm Change ==
 
  
Asks the user to confirm a change required to proceed. Currently used
+
This shows the dialog for keeping track of the drawing events related to the
for enabling/disabling modifications
+
current time. (This window is used for debug purposes only.)
  
 
{| border="1"
 
{| border="1"
Line 593: Line 687:
 
!Description
 
!Description
 
|-
 
|-
| message
+
| hour_percentage
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#progress_bar|progress_bar]]
| yes
+
| no
| displays the details of the required changes
+
| This shows the hours as a percentage, where 24 hours is 100%.
 
|-
 
|-
| itemlist
+
| minute_percentage
| [[GUIToolkitWML#scroll_label|scroll_label]]
+
| [[GUIToolkitWML#progress_bar|progress_bar]]
| yes
+
| no
| displays the list of affected items
+
| This shows the minutes as a percentage, where 60 minutes is 100%.
 
|-
 
|-
| cancel
+
| second_percentage
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#progress_bar|progress_bar]]
| yes
+
| no
| refuse to apply changes
+
| This shows the seconds as a percentage, where 60 seconds is 100%.
 
|-
 
|-
| ok
+
| hour
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#integer_selector|integer_selector]]
| yes
+
| no
| agree to apply changes
+
| This shows the seconds since the beginning of the day. The control should have a ''minimum_value'' of 0 and a ''maximum_value'' of 86399 (246060 - 1).
|}
 
== SP/MP Dependency Check: Select New ==
 
 
 
Offers a list of compatible items if a currently selected one is
 
incompatible. Currently used for switching era or map.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| message
+
| minute
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#integer_selector|integer_selector]]
| yes
+
| no
| displays the details of the required changes
+
| This shows the seconds since the beginning of the current hour. The control should have a ''minimum_value'' of 0 and a ''maximum_value'' of 3599 (6060 - 1).
 
|-
 
|-
| itemlist
+
| minute
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#integer_selector|integer_selector]]
| yes
+
| no
| displays the available items to choose from
+
| This shows the seconds since the beginning of the current minute. The control should have a ''minimum_value'' of 0 and a ''maximum_value'' of 59.
 
|-
 
|-
| cancel
+
| clock
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
| yes
+
| no
| refuse to apply any changes
+
| A control which will have set three variables in its canvas:
|-
+
* hour, the same value as the hour integer_selector.
| ok
+
* minute, the same value as the minute integer_selector.
| [[GUIToolkitWML#button|button]]
+
* second, the same value as the second integer_selector.
| yes
+
the control can then show the time in its own preferred format(s).
| select the chosen item
 
 
|}
 
|}
  
== Edit label ==
+
== Core selection ==
  
Dialog for editing gamemap labels.
+
This shows the dialog which allows the user to choose which core to
 +
play.
  
 
{| border="1"
 
{| border="1"
Line 655: Line 738:
 
!Description
 
!Description
 
|-
 
|-
| title
+
| core_list
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Dialog title label.
+
| A listbox that contains all available cores.
 +
|-
 +
|         icon
 +
| [[GUIToolkitWML#image|image]]
 +
| no
 +
| The icon for the core.
 +
|-
 +
|         name
 +
| [[GUIToolkitWML#control|control]]
 +
| no
 +
| The name of the core.
 
|-
 
|-
| label
+
| core_details
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#multi_page|multi_page]]
 
| yes
 
| yes
| Input field for the map label.
+
| A multi page widget that shows more details for the selected core.
 
|-
 
|-
| team_only_toggle
+
|         image
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#image|image]]
| yes
+
| no
| Checkbox for whether to make the label visible to the player's team only or not.
+
| The image for the core.
 +
|-
 +
|         description
 +
| [[GUIToolkitWML#control|control]]
 +
| no
 +
| The description of the core.
 
|}
 
|}
== Editor Edit label ==
+
== Custom Schedules ==
  
Dialog for editing gamemap labels.
+
This shows the dialog to modify tod schedules.
  
 
{| border="1"
 
{| border="1"
Line 680: Line 778:
 
!Description
 
!Description
 
|-
 
|-
| title
+
| current_tod_name
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Dialog title label.
+
| The name of the time of day(ToD).
 
|-
 
|-
| label
+
| current_tod_id
 
| [[GUIToolkitWML#text_box|text_box]]
 
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Input field for the map label.
+
| The id of the time of day(ToD).
 
|-
 
|-
| team_only_toggle
+
| current_tod_image
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#image|image]]
 
| yes
 
| yes
| Checkbox for whether to make the label visible to the player's team only or not.
+
| The image for the time of day(ToD).
|}
+
|-
 
+
| current_tod_mask
== Edit scenario ==
+
| [[GUIToolkitWML#image|image]]
 
+
| yes
Dialog for editing gamemap scenarios.
+
| The image mask for the time of day(ToD).
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| title
+
| current_tod_sonund
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Dialog title label.
+
| The sound for the time of day(ToD).
 
|-
 
|-
| label
+
| next_tod
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Input field for the map label.
+
| Selects the next ToD.
 
|-
 
|-
| team_only_toggle
+
| prev_tod
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Selects the previous ToD.
 +
|-
 +
| lawful_bonus
 +
| [[GUIToolkitWML#slider|slider]]
 
| yes
 
| yes
| Checkbox for whether to make the label visible to the player's team only or not.
+
| Sets the Lawful Bonus for the current ToD.
 +
|-
 +
| tod_red
 +
| [[GUIToolkitWML#slider|slider]]
 +
| yes
 +
| Sets the red component of the current ToD.
 +
|-
 +
| tod_green
 +
| [[GUIToolkitWML#slider|slider]]
 +
| yes
 +
| Sets the green component of the current ToD.
 +
|-
 +
| tod_blue
 +
| [[GUIToolkitWML#slider|slider]]
 +
| yes
 +
| Sets the blue component of the current ToD.
 
|}
 
|}
== Edit side ==
+
== SP/MP Dependency Check: Confirm Change ==
  
Dialog for editing gamemap sides.
+
Asks the user to confirm a change required to proceed. Currently used
 +
for enabling/disabling modifications
  
 
{| border="1"
 
{| border="1"
Line 731: Line 844:
 
!Description
 
!Description
 
|-
 
|-
| title
+
| message
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Dialog title label.
+
| displays the details of the required changes
 +
|-
 +
| itemlist
 +
| [[GUIToolkitWML#scroll_label|scroll_label]]
 +
| yes
 +
| displays the list of affected items
 
|-
 
|-
| id
+
| cancel
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Input field for the id.
+
| refuse to apply changes
 
|-
 
|-
| team_only_toggle
+
| ok
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Checkbox for whether to make the label visible to the player's team only or not.
+
| agree to apply changes
 
|}
 
|}
== Editor generate map ==
+
== SP/MP Dependency Check: Select New ==
  
This shows the dialog in the editor to select which random generator
+
Offers a list of compatible items if a currently selected one is
should be used to generate a map.
+
incompatible. Currently used for switching era or map.
  
 
{| border="1"
 
{| border="1"
Line 757: Line 875:
 
!Description
 
!Description
 
|-
 
|-
| generators_list
+
| message
 +
| [[GUIToolkitWML#label|label]]
 +
| yes
 +
| displays the details of the required changes
 +
|-
 +
| itemlist
 
| [[GUIToolkitWML#listbox|listbox]]
 
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Listbox displaying known map generators.
+
| displays the available items to choose from
 
|-
 
|-
| settings
+
| cancel
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| When clicked this button opens the generator settings dialog.
+
| refuse to apply any changes
 
|-
 
|-
| seed_textbox
+
| ok
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Allows entering a seed for the map generator.
+
| select the chosen item
 
|}
 
|}
== Editor new map ==
 
  
This shows the dialog to generate a new map in the editor.
+
== Edit label ==
 +
 
 +
Dialog for editing gamemap labels.
  
 
{| border="1"
 
{| border="1"
Line 782: Line 906:
 
!Description
 
!Description
 
|-
 
|-
| width
+
| title
| [[GUIToolkitWML#integer_selector|integer_selector]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| An integer selector to determine the width of the map to create.
+
| Dialog title label.
 
|-
 
|-
| height
+
| label
| [[GUIToolkitWML#integer_selector|integer_selector]]
+
| [[GUIToolkitWML#text_box|text_box]]
 +
| yes
 +
| Input field for the map label.
 +
|-
 +
| team_only_toggle
 +
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| An integer selector to determine the height of the map to create.
+
| Checkbox for whether to make the label visible to the player's team only or not.
 
|}
 
|}
== Editor resize map ==
+
== Editor Edit label ==
  
This shows the dialog to resize the current map.
+
Dialog for editing gamemap labels.
  
 
{| border="1"
 
{| border="1"
Line 802: Line 931:
 
!Description
 
!Description
 
|-
 
|-
| old_width
+
| title
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
| no
+
| yes
| Shows the old width of the map.
+
| Dialog title label.
 
|-
 
|-
| old_height
+
| label
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#text_box|text_box]]
| no
 
| Shows the old height of the map.
 
|-
 
| width
 
| [[GUIToolkitWML#slider|slider]]
 
 
| yes
 
| yes
| Determines the new width of the map.
+
| Input field for the map label.
 
|-
 
|-
| height
+
| team_only_toggle
| [[GUIToolkitWML#slider|slider]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Determines the new height of the map.
+
| Checkbox for whether to make the label visible to the player's team only or not.
 +
|}
 +
 
 +
== Edit scenario ==
 +
 
 +
Dialog for editing gamemap scenarios.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| copy_edge_terrain
+
| title
| [[GUIToolkitWML#boolean_selector|boolean_selector]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Determines whether the border terrains should be used to expand or not.
+
| Dialog title label.
 
|-
 
|-
| expand0
+
| label
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Determines in which direction to expand, shows the north east marker.
+
| Input field for the map label.
 
|-
 
|-
| expand1
+
| team_only_toggle
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Determines in which direction to expand, shows the north marker.
+
| Checkbox for whether to make the label visible to the player's team only or not.
 +
|}
 +
== Edit side ==
 +
 
 +
Dialog for editing gamemap sides.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| expand2
+
| title
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| Determines in which direction to expand, shows the north west marker.
+
| Dialog title label.
 
|-
 
|-
| expand3
+
| id
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Determines in which direction to expand, shows the east marker.
+
| Input field for the id.
 
|-
 
|-
| expand4
+
| team_only_toggle
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Determines in which direction to expand, shows the center marker.
+
| Checkbox for whether to make the label visible to the player's team only or not.
|-
 
| expand5
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| Determines in which direction to expand, shows the west marker.
 
|-
 
| expand6
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| Determines in which direction to expand, shows the south east marker.
 
|-
 
| expand7
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| Determines in which direction to expand, shows the south marker.
 
|-
 
| expand8
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| Determines in which direction to expand, shows the south west marker.
 
 
|}
 
|}
== Editor set starting position ==
+
== Editor generate map ==
  
Map editor dialog for setting player starting positions.
+
This shows the dialog in the editor to select which random generator
 +
should be used to generate a map.
  
 
{| border="1"
 
{| border="1"
Line 882: Line 1,008:
 
!Description
 
!Description
 
|-
 
|-
| listbox
+
| generators_list
 
| [[GUIToolkitWML#listbox|listbox]]
 
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Listbox displaying player choices.
+
| Listbox displaying known map generators.
 
|-
 
|-
|         player
+
| settings
| [[GUIToolkitWML#control|control]]
 
| yes
 
| Widget which shows a player item label.
 
|-
 
|         location
 
| [[GUIToolkitWML#control|control]]
 
| yes
 
| Widget which shows the coordinates to the current starting position for a player if it exists.
 
|-
 
| ok
 
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| OK button.
+
| When clicked this button opens the generator settings dialog.
 
|-
 
|-
| cancel
+
| seed_textbox
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Cancel button.
+
| Allows entering a seed for the map generator.
 
|}
 
|}
== Folder Create ==
+
== Editor new map ==
  
Dialog for providing the name of a new folder to create.
+
This shows the dialog to generate a new map in the editor.
Used by the file dialog.
 
  
 
{| border="1"
 
{| border="1"
Line 918: Line 1,033:
 
!Description
 
!Description
 
|-
 
|-
| name
+
| width
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#integer_selector|integer_selector]]
 +
| yes
 +
| An integer selector to determine the width of the map to create.
 +
|-
 +
| height
 +
| [[GUIToolkitWML#integer_selector|integer_selector]]
 
| yes
 
| yes
| Input field for the new folder name.
+
| An integer selector to determine the height of the map to create.
 
|}
 
|}
== Formula debugger ==
+
== Editor resize map ==
  
This shows the debugger for the formulas.
+
This shows the dialog to resize the current map.
  
 
{| border="1"
 
{| border="1"
Line 933: Line 1,053:
 
!Description
 
!Description
 
|-
 
|-
| stack
+
| old_width
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#label|label]]
 +
| no
 +
| Shows the old width of the map.
 +
|-
 +
| old_height
 +
| [[GUIToolkitWML#label|label]]
 +
| no
 +
| Shows the old height of the map.
 +
|-
 +
| width
 +
| [[GUIToolkitWML#slider|slider]]
 
| yes
 
| yes
| A stack.
+
| Determines the new width of the map.
 
|-
 
|-
| execution
+
| height
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#slider|slider]]
 
| yes
 
| yes
| Execution trace label.
+
| Determines the new height of the map.
 
|-
 
|-
| state
+
| copy_edge_terrain
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#boolean_selector|boolean_selector]]
 
| yes
 
| yes
| The state.
+
| Determines whether the border terrains should be used to expand or not.
 
|-
 
|-
| step
+
| expand0
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Button to step into the execution.
+
| Determines in which direction to expand, shows the north east marker.
 
|-
 
|-
| stepout
+
| expand1
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Button to step out of the execution.
+
| Determines in which direction to expand, shows the north marker.
 
|-
 
|-
| next
+
| expand2
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Button to execute the next statement.
+
| Determines in which direction to expand, shows the north west marker.
 
|-
 
|-
| continue
+
| expand3
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Button to continue the execution.
+
| Determines in which direction to expand, shows the east marker.
|}
 
== Game cache options ==
 
 
 
A Preferences subdialog including a report on the location and size of the
 
game's WML cache, buttons to copy its path to clipboard or browse to it,
 
and the possibility of clearing stale files from the cache or purging it
 
entirely.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| path
+
| expand4
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Cache dir path.
+
| Determines in which direction to expand, shows the center marker.
 
|-
 
|-
| copy
+
| expand5
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Copies the cache path to clipboard.
+
| Determines in which direction to expand, shows the west marker.
 
|-
 
|-
| browse
+
| expand6
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Browses to the cache path using the platform's file management application.
+
| Determines in which direction to expand, shows the south east marker.
 
|-
 
|-
| size
+
| expand7
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Current total size of the cache dir's contents.
+
| Determines in which direction to expand, shows the south marker.
 
|-
 
|-
| clean
+
| expand8
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Cleans the cache, erasing stale files not used by the Wesnoth version presently running the dialog.
+
| Determines in which direction to expand, shows the south west marker.
|-
 
| purge
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| Purges the cache in its entirety.
 
 
|}
 
|}
== Delete a savegame ==
+
== Editor set starting position ==
  
This shows the dialog to confirm deleting a savegame file.
+
Map editor dialog for setting player starting positions.
  
 
{| border="1"
 
{| border="1"
Line 1,021: Line 1,133:
 
!Description
 
!Description
 
|-
 
|-
| dont_ask_again
+
| listbox
| [[GUIToolkitWML#boolean_selector|boolean_selector]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| A checkbox to not show this dialog again.
+
| Listbox displaying player choices.
|}
 
== Load a game ==
 
 
 
This shows the dialog to select and load a savegame file.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| txtFilter
+
|         player
| [[GUIToolkitWML#text|text]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| The filter for the listbox items.
+
| Widget which shows a player item label.
 
|-
 
|-
| savegame_list
+
|         location
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| List of savegames.
+
| Widget which shows the coordinates to the current starting position for a player if it exists.
 
|-
 
|-
|         filename
+
| ok
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Name of the savegame.
+
| OK button.
 
|-
 
|-
|         date
+
| cancel
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#button|button]]
| no
 
| Date the savegame was created.
 
|-
 
| preview_pane
 
| [[GUIToolkitWML#widget|widget]]
 
 
| yes
 
| yes
| Container widget or grid that contains the items for a preview. The visible status of this container depends on whether or not something is selected.
+
| Cancel button.
 +
|}
 +
== Folder Create ==
 +
 
 +
Dialog for providing the name of a new folder to create.
 +
Used by the file dialog.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
|         minimap
+
| name
| [[GUIToolkitWML#minimap|minimap]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Minimap of the selected savegame.
+
| Input field for the new folder name.
|-
 
|         imgLeader
 
| [[GUIToolkitWML#image|image]]
 
| yes
 
| The image of the leader in the selected savegame.
 
|-
 
|         lblScenario
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| The name of the scenario of the selected savegame.
 
|-
 
|         lblSummary
 
| [[GUIToolkitWML#label|label]]
 
| yes
 
| Summary of the selected savegame.
 
 
|}
 
|}
== Save a game ==
+
== Formula debugger ==
  
This shows the dialog to create a savegame file.
+
This shows the debugger for the formulas.
  
 
{| border="1"
 
{| border="1"
Line 1,091: Line 1,184:
 
!Description
 
!Description
 
|-
 
|-
| lblTitle
+
| stack
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| The title of the window.
+
| A stack.
 
|-
 
|-
| txtFilename
+
| execution
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| The name of the savefile.
+
| Execution trace label.
|}
 
== Game paths ==
 
 
 
Dialog displaying the various paths used by the game to locate
 
resource and configuration files.
 
 
 
There are several item types used to build widget ids in this dialog.
 
All references to TYPE below refer to the following suffixes:
 
datadir, config, userdata, saves, addons, cache.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| path_TYPE
+
| state
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Textbox containing the filesystem path for the given item.
+
| The state.
 
|-
 
|-
| copy_TYPE
+
| step
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Button to step into the execution.
 +
|-
 +
| stepout
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Button to step out of the execution.
 +
|-
 +
| next
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Copies the given item's path to clipboard.
+
| Button to execute the next statement.
 
|-
 
|-
| browse_TYPE
+
| continue
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Launches the default file browser on the given item's path.
+
| Button to continue the execution.
 
|}
 
|}
== Gamestate inspector ==
+
== Game cache options ==
  
This shows the gamestate inspector
+
A Preferences subdialog including a report on the location and size of the
 +
game's WML cache, buttons to copy its path to clipboard or browse to it,
 +
and the possibility of clearing stale files from the cache or purging it
 +
entirely.
  
 
{| border="1"
 
{| border="1"
Line 1,141: Line 1,232:
 
!Description
 
!Description
 
|-
 
|-
| inspector_name
+
| path
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Name of the inspector.
+
| Cache dir path.
 +
|-
 +
| copy
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Copies the cache path to clipboard.
 +
|-
 +
| browse
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Browses to the cache path using the platform's file management application.
 
|-
 
|-
| stuff_list
+
| size
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| List of various stuff that can be viewed.
+
| Current total size of the cache dir's contents.
 
|-
 
|-
| inspect
+
| clean
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| The state of the variable or event.
+
| Cleans the cache, erasing stale files not used by the Wesnoth version presently running the dialog.
 
|-
 
|-
| copy
+
| purge
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| A button to copy the state to clipboard.
+
| Purges the cache in its entirety.
 
|}
 
|}
== Joystick settings ==
+
== Delete a savegame ==
  
Joystick configuration dialog.
+
This shows the dialog to confirm deleting a savegame file.
 
 
Empty table.
 
== Language selection ==
 
 
 
This shows the dialog to select the language to use. When the dialog is
 
closed with the OK button it also updates the selected language in the
 
preferences.
 
  
 
{| border="1"
 
{| border="1"
Line 1,178: Line 1,272:
 
!Description
 
!Description
 
|-
 
|-
| language_list
+
| dont_ask_again
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#boolean_selector|boolean_selector]]
 
| yes
 
| yes
| This listbox contains the list with available languages.
+
| A checkbox to not show this dialog again.
|-
 
|         ''free to choose''
 
| [[GUIToolkitWML#control|control]]
 
| no
 
| Show the name of the language in the current row.
 
 
|}
 
|}
== Lobby sounds options ==
+
== Load a game ==
  
A Preferences subdialog permitting to configure the sounds and notifications
+
This shows the dialog to select and load a savegame file.
generated in response to various mp lobby / game events.
 
  
 
{| border="1"
 
{| border="1"
Line 1,199: Line 1,287:
 
!Description
 
!Description
 
|-
 
|-
| _label
+
| txtFilter
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#text|text]]
 
| yes
 
| yes
| Item name.
+
| The filter for the listbox items.
 
|-
 
|-
| _sound
+
| savegame_list
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Toggles whether to play the item sound.
+
| List of savegames.
 
|-
 
|-
| _notif
+
|         filename
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Toggles whether to give a notification.
+
| Name of the savegame.
 +
|-
 +
|         date
 +
| [[GUIToolkitWML#control|control]]
 +
| no
 +
| Date the savegame was created.
 
|-
 
|-
| _lobby
+
| preview_pane
| [[GUIToolkitWML#toggle_button|toggle_button]]
+
| [[GUIToolkitWML#widget|widget]]
 
| yes
 
| yes
| Toggles whether to take actions for this item when in the lobby.
+
| Container widget or grid that contains the items for a preview. The visible status of this container depends on whether or not something is selected.
|}
+
|-
== Change control dialog ==
+
|         minimap
 +
| [[GUIToolkitWML#minimap|minimap]]
 +
| yes
 +
| Minimap of the selected savegame.
 +
|-
 +
|         imgLeader
 +
| [[GUIToolkitWML#image|image]]
 +
| yes
 +
| The image of the leader in the selected savegame.
 +
|-
 +
|         lblScenario
 +
| [[GUIToolkitWML#label|label]]
 +
| yes
 +
| The name of the scenario of the selected savegame.
 +
|-
 +
|         lblSummary
 +
| [[GUIToolkitWML#label|label]]
 +
| yes
 +
| Summary of the selected savegame.
 +
|}
 +
== Save a game ==
  
This shows the multiplayer change control dialog.
+
This shows the dialog to create a savegame file.
  
 
{| border="1"
 
{| border="1"
Line 1,229: Line 1,342:
 
!Description
 
!Description
 
|-
 
|-
| sides_list
+
| lblTitle
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| List of sides participating in the MP game.
+
| The title of the window.
 
|-
 
|-
| nicks_list
+
| txtFilename
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| List of nicks of all clients playing or observing the MP game.
+
| The name of the savefile.
 
|}
 
|}
 +
== Game paths ==
  
== Multiplayer command wrapper ==
+
Dialog displaying the various paths used by the game to locate
 +
resource and configuration files.
  
This shows a dialog that provides a graphical front-end
+
There are several item types used to build widget ids in this dialog.
to various commands in the multiplayer lobby
+
All references to TYPE below refer to the following suffixes:
 +
datadir, config, userdata, saves, addons, cache.
  
 
{| border="1"
 
{| border="1"
Line 1,251: Line 1,367:
 
!Description
 
!Description
 
|-
 
|-
| message
+
| path_TYPE
 
| [[GUIToolkitWML#text_box|text_box]]
 
| [[GUIToolkitWML#text_box|text_box]]
| no
+
| yes
| Text to send as a private message.
+
| Textbox containing the filesystem path for the given item.
 
|-
 
|-
| reason
+
| copy_TYPE
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#button|button]]
| no
+
| yes
| The reason for a ban.
+
| Copies the given item's path to clipboard.
 
|-
 
|-
| time
+
| browse_TYPE
| [[GUIToolkitWML#text_box|text_box]]
 
| no
 
| The time the ban lasts.
 
|-
 
| user_label
 
| [[GUIToolkitWML#label|label]]
 
| no
 
| The label to show which user has been selected.
 
|-
 
| send_message
 
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Execute /msg.
+
| Launches the default file browser on the given item's path.
 +
|}
 +
== Gamestate inspector ==
 +
 
 +
This shows the gamestate inspector
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| add_friend
+
| inspector_name
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Execute /friend.
+
| Name of the inspector.
 
|-
 
|-
| add_ignore
+
| stuff_list
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Execute /ignore.
+
| List of various stuff that can be viewed.
 
|-
 
|-
| remove
+
| inspect
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| Execute /remove.
+
| The state of the variable or event.
 
|-
 
|-
| status
+
| copy
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| Execute /query status.
+
| A button to copy the state to clipboard.
|-
+
|}
| kick
+
== Joystick settings ==
| [[GUIToolkitWML#button|button]]
+
 
| yes
+
Joystick configuration dialog.
| Execute /query kick.
+
 
|-
+
Empty table.
| ban
+
== Language selection ==
| [[GUIToolkitWML#button|button]]
 
| yes
 
| Execute /query kban.
 
|-
 
| mod_options
 
| [[GUIToolkitWML#grid|grid]]
 
| yes
 
| Grid containing the status/kick/ban options. This grid and its children are hidden when these options are unavailable.
 
|}
 
== Multiplayer connect ==
 
  
This shows the dialog to the MP server to connect to.
+
This shows the dialog to select the language to use. When the dialog is
 +
closed with the OK button it also updates the selected language in the
 +
preferences.
  
 
{| border="1"
 
{| border="1"
Line 1,321: Line 1,429:
 
!Description
 
!Description
 
|-
 
|-
| start_table
+
| language_list
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| The name of the server to connect to.
+
| This listbox contains the list with available languages.
 
|-
 
|-
| list
+
|         ''free to choose''
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
 
| no
 
| no
| Shows a dialog with a list of predefined servers to connect to.
+
| Show the name of the language in the current row.
 
|}
 
|}
== Create Game: Set Password ==
+
== Lobby sounds options ==
  
Dialog for setting a join password for MP games.
+
A Preferences subdialog permitting to configure the sounds and notifications
 +
generated in response to various mp lobby / game events.
  
 
{| border="1"
 
{| border="1"
Line 1,341: Line 1,450:
 
!Description
 
!Description
 
|-
 
|-
| password
+
| _label
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#label|label]]
 +
| yes
 +
| Item name.
 +
|-
 +
| _sound
 +
| [[GUIToolkitWML#toggle_button|toggle_button]]
 +
| yes
 +
| Toggles whether to play the item sound.
 +
|-
 +
| _notif
 +
| [[GUIToolkitWML#toggle_button|toggle_button]]
 +
| yes
 +
| Toggles whether to give a notification.
 +
|-
 +
| _lobby
 +
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
| yes
 
| yes
| Input field for the game password.
+
| Toggles whether to take actions for this item when in the lobby.
 
|}
 
|}
== Host Networked Game prompt ==
+
== Change control dialog ==
  
This shows the dialog to confirm deleting a savegame file.
+
This shows the multiplayer change control dialog.
  
 
{| border="1"
 
{| border="1"
Line 1,356: Line 1,480:
 
!Description
 
!Description
 
|-
 
|-
| do_not_show_again
+
| sides_list
| [[GUIToolkitWML#boolean_selector|boolean_selector]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| A checkbox to not show this dialog again.
+
| List of sides participating in the MP game.
|}
 
== Join Game: Password Prompt ==
 
 
 
Dialog for entering a password for joining a password-protected MP game.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| password
+
| nicks_list
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Input field for the game password.
+
| List of nicks of all clients playing or observing the MP game.
 
|}
 
|}
== Multiplayer connect ==
 
  
This shows the dialog to log in to the MP server
+
== Multiplayer command wrapper ==
 +
 
 +
This shows a dialog that provides a graphical front-end
 +
to various commands in the multiplayer lobby
  
 
{| border="1"
 
{| border="1"
Line 1,386: Line 1,502:
 
!Description
 
!Description
 
|-
 
|-
| user_name
+
| message
 
| [[GUIToolkitWML#text_box|text_box]]
 
| [[GUIToolkitWML#text_box|text_box]]
| yes
+
| no
| The login user name.
+
| Text to send as a private message.
 
|-
 
|-
| password
+
| reason
 
| [[GUIToolkitWML#text_box|text_box]]
 
| [[GUIToolkitWML#text_box|text_box]]
| yes
 
| The password.
 
|-
 
| remember_password
 
| [[GUIToolkitWML#toggle_button|toggle_button]]
 
 
| no
 
| no
| A toggle button to offer to remember the password in the preferences.
+
| The reason for a ban.
 
|-
 
|-
| password_reminder
+
| time
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| no
 
| no
| Request a password reminder.
+
| The time the ban lasts.
 
|-
 
|-
| change_username
+
| user_label
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#label|label]]
 
| no
 
| no
| Use a different username.
+
| The label to show which user has been selected.
 
|-
 
|-
| login_label
+
| send_message
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
| no
+
| yes
| Displays the information received from the server.
+
| Execute /msg.
|}
 
== MP method selection ==
 
 
 
This shows the dialog to select the kind of MP game the user wants to play.
 
 
 
{| border="1"
 
!ID (return value)
 
!Type
 
!Mandatory
 
!Description
 
 
|-
 
|-
| user_name
+
| add_friend
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| This text contains the name the user on the MP server. This widget will get a fixed maximum length by the engine.
+
| Execute /friend.
 
|-
 
|-
| method_list
+
| add_ignore
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| The list with possible game methods.
+
| Execute /ignore.
|}
+
|-
== Multiplayer server list ==
+
| remove
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Execute /remove.
 +
|-
 +
| status
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Execute /query status.
 +
|-
 +
| kick
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Execute /query kick.
 +
|-
 +
| ban
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| Execute /query kban.
 +
|-
 +
| mod_options
 +
| [[GUIToolkitWML#grid|grid]]
 +
| yes
 +
| Grid containing the status/kick/ban options. This grid and its children are hidden when these options are unavailable.
 +
|}
 +
== Multiplayer connect ==
  
This shows the dialog with a list of predefined multiplayer servers.
+
This shows the dialog to the MP server to connect to.
  
 
{| border="1"
 
{| border="1"
Line 1,446: Line 1,572:
 
!Description
 
!Description
 
|-
 
|-
| server_list
+
| start_table
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Listbox with the predefined servers to connect to.
+
| The name of the server to connect to.
 
|-
 
|-
|         name
+
| list
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#button|button]]
 
| no
 
| no
| Widget which shows the name of the server.
+
| Shows a dialog with a list of predefined servers to connect to.
|-
 
|         address
 
| [[GUIToolkitWML#control|control]]
 
| yes
 
| The address/host_name of the server.
 
 
|}
 
|}
== Rename unit ==
+
== Create Game: Set Password ==
  
Dialog for renaming units in-game.
+
Dialog for setting a join password for MP games.
  
 
{| border="1"
 
{| border="1"
Line 1,471: Line 1,592:
 
!Description
 
!Description
 
|-
 
|-
| name
+
| password
 
| [[GUIToolkitWML#text_box|text_box]]
 
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Input field for the unit name.
+
| Input field for the game password.
 
|}
 
|}
== Screenshot notification ==
+
== Host Networked Game prompt ==
  
Notification dialog used after saving a game or map screenshot to display
+
This shows the dialog to confirm deleting a savegame file.
information about it for the user.
 
  
 
{| border="1"
 
{| border="1"
Line 1,487: Line 1,607:
 
!Description
 
!Description
 
|-
 
|-
| path
+
| do_not_show_again
| [[GUIToolkitWML#text_box|text_box]]
+
| [[GUIToolkitWML#boolean_selector|boolean_selector]]
 
| yes
 
| yes
| Read-only textbox containing the screenshot path.
+
| A checkbox to not show this dialog again.
|-
 
| filesize
 
| [[GUIToolkitWML#label|label]]
 
| no
 
| Optional label to display the file size.
 
|-
 
| copy
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| Button to copy the path to clipboard.
 
|-
 
| open
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| Button to open the screnshot using the default application.
 
|-
 
| browse_dir
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| Button to browse the screenshots directory in the file manager.
 
 
|}
 
|}
== Simple item selector ==
+
== Join Game: Password Prompt ==
  
A simple one-column listbox with OK and Cancel buttons.
+
Dialog for entering a password for joining a password-protected MP game.
  
 
{| border="1"
 
{| border="1"
Line 1,522: Line 1,622:
 
!Description
 
!Description
 
|-
 
|-
| title
+
| password
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Dialog title label.
+
| Input field for the game password.
 +
|}
 +
== Multiplayer connect ==
 +
 
 +
This shows the dialog to log in to the MP server
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| message
+
| user_name
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Text label displaying a description or instructions.
+
| The login user name.
 
|-
 
|-
| listbox
+
| password
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Listbox displaying user choices.
+
| The password.
 
|-
 
|-
|         item
+
| remember_password
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#toggle_button|toggle_button]]
| yes
+
| no
| Widget which shows a listbox item label.
+
| A toggle button to offer to remember the password in the preferences.
 +
|-
 +
| password_reminder
 +
| [[GUIToolkitWML#button|button]]
 +
| no
 +
| Request a password reminder.
 
|-
 
|-
| ok
+
| change_username
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
| yes
+
| no
| OK button.
+
| Use a different username.
 
|-
 
|-
| cancel
+
| login_label
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
| yes
+
| no
| Cancel button.
+
| Displays the information received from the server.
 
|}
 
|}
== Theme list ==
+
== MP method selection ==
  
Dialog for selecting a GUI theme.
+
This shows the dialog to select the kind of MP game the user wants to play.
  
 
{| border="1"
 
{| border="1"
Line 1,562: Line 1,677:
 
!Description
 
!Description
 
|-
 
|-
| themes
+
| user_name
| [[GUIToolkitWML#listbox|listbox]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| Listbox displaying user choices.
+
| This text contains the name the user on the MP server. This widget will get a fixed maximum length by the engine.
 
|-
 
|-
|         name
+
| method_list
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| Widget which shows a theme item name.
+
| The list with possible game methods.
|-
 
|         description
 
| [[GUIToolkitWML#control|control]]
 
| yes
 
| Widget which shows a theme item description.
 
 
|}
 
|}
== Tip float ==
+
== Multiplayer server list ==
  
Generic window to show a floating tip window. The class has several
+
This shows the dialog with a list of predefined multiplayer servers.
subclasses using the same format. For example there will be tooltips and
 
helptips, both using this class.
 
  
 
{| border="1"
 
{| border="1"
Line 1,589: Line 1,697:
 
!Description
 
!Description
 
|-
 
|-
| label
+
| server_list
| [[GUIToolkitWML#control|control]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| This text contains the message to show in the tip.
+
| Listbox with the predefined servers to connect to.
|}
+
|-
 
+
|         name
In the canvas of the windows used in this dialog the following variables are
+
| [[GUIToolkitWML#control|control]]
defined:
+
| no
 
+
| Widget which shows the name of the server.
{| border="1"
 
!Variable
 
!type
 
!description
 
 
|-
 
|-
| mouse_x
+
|         address
| unsigned
+
| [[GUIToolkitWML#control|control]]
| The x coordinate of the mouse pointer when the window was created.
+
| yes
|-
+
| The address/host_name of the server.
| mouse_y
 
| unsigned
 
| The y coordinate of the mouse pointer when the window was created.
 
 
|}
 
|}
== Title screen ==
+
== Rename unit ==
  
This shows the title screen.
+
Dialog for renaming units in-game.
  
 
{| border="1"
 
{| border="1"
Line 1,621: Line 1,722:
 
!Description
 
!Description
 
|-
 
|-
| tutorial
+
| name
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| The button to start the tutorial.
+
| Input field for the unit name.
 +
|}
 +
== Screenshot notification ==
 +
 
 +
Notification dialog used after saving a game or map screenshot to display
 +
information about it for the user.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| campaign
+
| path
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#text_box|text_box]]
 
| yes
 
| yes
| The button to start a campaign.
+
| Read-only textbox containing the screenshot path.
 +
|-
 +
| filesize
 +
| [[GUIToolkitWML#label|label]]
 +
| no
 +
| Optional label to display the file size.
 
|-
 
|-
| multiplayer
+
| copy
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| The button to start multiplayer mode.
+
| Button to copy the path to clipboard.
 
|-
 
|-
| load
+
| open
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| The button to load a saved game.
+
| Button to open the screnshot using the default application.
 
|-
 
|-
| editor
+
| browse_dir
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| The button to start the editor.
+
| Button to browse the screenshots directory in the file manager.
 +
|}
 +
== Simple item selector ==
 +
 
 +
A simple one-column listbox with OK and Cancel buttons.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 
|-
 
|-
| addons
+
| title
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#label|label]]
 
| yes
 
| yes
| The button to start managing the addons.
+
| Dialog title label.
 
|-
 
|-
| cores
+
| message
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| The button to start managing the cores.
+
| Text label displaying a description or instructions.
 
|-
 
|-
| language
+
| listbox
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#listbox|listbox]]
 
| yes
 
| yes
| The button to select the game language.
+
| Listbox displaying user choices.
 
|-
 
|-
| credits
+
|         item
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#control|control]]
 
| yes
 
| yes
| The button to show Wesnoth's contributors.
+
| Widget which shows a listbox item label.
 
|-
 
|-
| quit
+
| ok
 
| [[GUIToolkitWML#button|button]]
 
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| The button to quit Wesnoth.
+
| OK button.
 
|-
 
|-
| tips
+
| cancel
| [[GUIToolkitWML#multi_page|multi_page]]
+
| [[GUIToolkitWML#button|button]]
 
| yes
 
| yes
| A multi_page to hold all tips, when this widget is used the area of the tips doesn't need to be resized when the next or previous button is pressed.
+
| Cancel button.
 +
|}
 +
== Theme list ==
 +
 
 +
Dialog for selecting a GUI theme.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 +
|-
 +
| themes
 +
| [[GUIToolkitWML#listbox|listbox]]
 +
| yes
 +
| Listbox displaying user choices.
 
|-
 
|-
|         tip
+
|         name
 +
| [[GUIToolkitWML#control|control]]
 +
| yes
 +
| Widget which shows a theme item name.
 +
|-
 +
|         description
 +
| [[GUIToolkitWML#control|control]]
 +
| yes
 +
| Widget which shows a theme item description.
 +
|}
 +
== Tip float ==
 +
 
 +
Generic window to show a floating tip window. The class has several
 +
subclasses using the same format. For example there will be tooltips and
 +
helptips, both using this class.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 +
|-
 +
| label
 +
| [[GUIToolkitWML#control|control]]
 +
| yes
 +
| This text contains the message to show in the tip.
 +
|}
 +
 
 +
In the canvas of the windows used in this dialog the following variables are
 +
defined:
 +
 
 +
{| border="1"
 +
!Variable
 +
!type
 +
!description
 +
|-
 +
| mouse_x
 +
| unsigned
 +
| The x coordinate of the mouse pointer when the window was created.
 +
|-
 +
| mouse_y
 +
| unsigned
 +
| The y coordinate of the mouse pointer when the window was created.
 +
|}
 +
== Title screen ==
 +
 
 +
This shows the title screen.
 +
 
 +
{| border="1"
 +
!ID (return value)
 +
!Type
 +
!Mandatory
 +
!Description
 +
|-
 +
| campaign
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to start a campaign.
 +
|-
 +
| multiplayer
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to start multiplayer mode.
 +
|-
 +
| load
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to load a saved game.
 +
|-
 +
| editor
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to start the editor.
 +
|-
 +
| addons
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to start managing the addons.
 +
|-
 +
| cores
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to start managing the cores.
 +
|-
 +
| language
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to select the game language.
 +
|-
 +
| credits
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to show Wesnoth's contributors.
 +
|-
 +
| quit
 +
| [[GUIToolkitWML#button|button]]
 +
| yes
 +
| The button to quit Wesnoth.
 +
|-
 +
| tips
 +
| [[GUIToolkitWML#multi_page|multi_page]]
 +
| yes
 +
| A multi_page to hold all tips, when this widget is used the area of the tips doesn't need to be resized when the next or previous button is pressed.
 +
|-
 +
|         tip
 +
| [[GUIToolkitWML#label|label]]
 +
| no
 +
| Shows the text of the current tip.
 +
|-
 +
|         source
 
| [[GUIToolkitWML#label|label]]
 
| [[GUIToolkitWML#label|label]]
| no
+
| no
| Shows the text of the current tip.
+
| The source (the one who's quoted or the book referenced) of the current tip.
|-
+
|-
|         source
+
| next_tip
| [[GUIToolkitWML#label|label]]
+
| [[GUIToolkitWML#button|button]]
| no
+
| yes
| The source (the one who's quoted or the book referenced) of the current tip.
+
| The button show the next tip of the day.
|-
+
|-
| next_tip
+
| previous_tip
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#button|button]]
| yes
+
| yes
| The button show the next tip of the day.
+
| The button show the previous tip of the day.
|-
+
|-
| previous_tip
+
| logo
| [[GUIToolkitWML#button|button]]
+
| [[GUIToolkitWML#progress_bar|progress_bar]]
| yes
+
| no
| The button show the previous tip of the day.
+
| A progress bar to "animate" the Wesnoth logo.
|-
+
|-
| logo
+
| revision_number
| [[GUIToolkitWML#progress_bar|progress_bar]]
+
| [[GUIToolkitWML#control|control]]
| no
+
| no
| A progress bar to "animate" the Wesnoth logo.
+
| A widget to show the version number when the version number is known.
|-
+
|}
| revision_number
+
 
| [[GUIToolkitWML#control|control]]
 
| no
 
| A widget to show the version number when the version number is known.
 
|}
 
 
== Unit attack ==
 
== Unit attack ==
  
Line 1,798: Line 2,045:
 
== WML error ==
 
== WML error ==
  
Dialog used to report WML parser or preprocessor errors.
+
WML preprocessor/parser error report dialog.
  
 
{| border="1"
 
{| border="1"
Line 1,831: Line 2,078:
 
| Button that the user can click on to copy the error report to the system clipboard.
 
| Button that the user can click on to copy the error report to the system clipboard.
 
|}
 
|}
== Settings manager ==
 
 
This shows the settings manager
 
  
 
== Settings manager ==
 
== Settings manager ==

Latest revision as of 17:55, 27 April 2024

Window definition

The window definition define how the windows shown in the dialog look.

Community

This shows a dialog displaying community links.

ID (return value) Type Mandatory Description
forums button yes Links to the Wesnoth forums
discord button yes Links to the Wesnoth Discord server
irc button yes Links to a web client for the Wesnoth IRC channels
steam button yes Links to the Wesnoth Steam forums
reddit button yes Links to the Wesnoth sub-reddit
donate button yes Links to the SPI donation page for Wesnoth

Editor: Edit PBL

  • Dialog for editing an add-on's _server.pbl.
ID (return value) Type Mandatory Description
name text_box yes The name of the add-on displayed on the UI.
description scroll_text yes The add-on's description.
icon text_box yes The add-on's icon.
author text_box yes The author of the add-on. When using forum_auth, this must be a forum username.
version text_box yes The add-on's version.
dependencies text_box yes Other add-on IDs which this add-on depends on.
tags multimenu_button yes Tags for the add-on for searching in the add-ons manager.
type menu_button yes The type of the add-on.
forum_thread text_box yes The topic ID of this add-on's forum feedback thread.
forum_auth toggle_button yes Whether to use forum authentication when uploading or deleting the add-on.
secondary_authors text_box yes Any other forum usernames of people who are also allowed to upload updates for this add-on. Only works with forum_auth being enabled.
email text_box yes A contact email address. Requred when not using forum_auth.
password text_box yes The password to use when uploading the add-on. Requred when not using forum_auth.

Editor: Choose Add-on

Dialog for choosing the add-on to use in the editor.

ID (return value) Type Mandatory Description
existing_addons listbox yes A listbox that contains all available options for choosing an add-on

Editor: PBL Translations

Dialog for adding a translation while editing an add-on's _server.pbl.

ID (return value) Type Mandatory Description
language text_box yes The language code for this translation.
lang_title text_box yes The name of the language displayed on the UI.
description text_box yes The description of the translation.

Prompt

Dialog for getting a single text value from the player.

ID (return value) Type Mandatory Description
prompt_box text_box yes The text box to enter the value into.

Add-on Auth

This shows the dialog to provide a password when uploading an add-on.

ID (return value) Type Mandatory Description
password text_box yes The password used to verify the uploader.

MP Report

This shows a dialog to report players on the multiplayer server.

ID (return value) Type Mandatory Description
reportee text_box yes The person being reported.
report_reason text_box yes Why they're being reported.
occurrence_location menu_button yes Where in-game it happened.
additional_information text_box yes Any additional information to add.

Achievements

This shows a dialog displaying achievements.

ID (return value) Type Mandatory Description
selected_achievements_list menu_button yes Allows selecting achievements by what content they're for.
name label yes The user displayed name of the achievement.
description label yes The achievement's longer description.
icon image yes An icon to display to the left of the achievement.

Addon connect

This shows the dialog for managing addons and connecting to the addon server.

ID (return value) Type Mandatory Description
hostname text_box yes This text contains the name of the server to connect to.
show_help button yes Thus button shows the in-game help about add-ons management when triggered.
free to choose (2) button no This button closes the dialog to display a dialog for removing installed add-ons.

Add-on description

Add-on description and details for the add-ons manager interface.

ID (return value) Type Mandatory Description
image control yes Label for displaying the add-on icon, in a 72x72 area.
title control yes Dialog title label, corresponding to the add-on name.
type control yes Label for displaying the add-on's type.
version control yes Label for displaying the add-on version number.
status control yes Label for displaying the current installation/upgradability status.
author control yes Label for displaying the add-on author/maintainer name.
size control yes Label for displaying the add-on package size.
downloads control yes Label for displaying the add-on's download count.
description control yes Text label for displaying the add-on's description. The control can be given a text, this text is shown when the addon has no description. If the addon has a description this field shows the description of the addon.
translations control yes Label for displaying a list of translations provided by the add-on. Like the description it can also show a default text if no translations are available.
dependencies control yes Label for displaying a list of dependencies of the add-on. Like the description it can also show a default text if no dependencies are defined.
updated control yes Label displaying the add-on's last upload date.
created control yes Label displaying the add-on's first upload date.
url text_box yes Textbox displaying the add-on's feedback page URL if provided by the server.
url_go button yes Button for launching a web browser to visit the add-on's feedback page URL if provided by the server.
url_copy button yes Button for copying the add-on's feedback page URL to clipboard if provided by the server.

Add-on filter options

Advanced filtering options for the legacy (GUI1) Add-ons Manager dialog.

ID (return value) Type Mandatory Description
statuses_list listbox yes A listbox for displaying and selecting add-on installation status filter options.
toggle_all_displayed_types button yes This button toggles the values for all the widgets used to control the following add-on display options.
show_unknown toggle_button yes Whether to display add-ons of unknown type.
show_sp_campaigns toggle_button yes Whether to display single-player campaign add-ons.
show_sp_scenarios toggle_button yes Whether to display single-player scenario add-ons.
show_mp_campaigns toggle_button yes Whether to display multiplayer campaign add-ons.
show_mp_scenarios toggle_button yes Whether to display multiplayer scenario add-ons.
show_mp_maps toggle_button yes Whether to display multiplayer map-pack add-ons.
show_mp_eras toggle_button yes Whether to display multiplayer era add-ons.
show_mp_factions toggle_button yes Whether to display multiplayer faction add-ons.
show_mp_mods toggle_button yes Whether to display multiplayer mod add-ons.
show_media toggle_button yes Whether to display author resource add-ons.
show_other toggle_button yes Whether to display add-ons of indeterminate types.
sort_ascending toggle_button yes Display add-ons in ascending order by default.
sort_descending toggle_button yes Display add-ons in descending order by default.
sort_by_name toggle_button yes Sort add-ons by name by default.
sort_by_last_updated toggle_button yes Sort add-ons by last update time by default.
sort_by_first_upload toggle_button yes Sort add-ons by creation time by default.

Addon list

Shows the list of addons on the server available for installation.

ID (return value) Type Mandatory Description
addons listbox yes A listbox that will contain the info about all addons on the server.
name label yes The name of the addon.
version_filter menu_button yes List allowing current or older versions to be selected.
author label yes The author of the addon.
downloads label yes The number of times the addon has been downloaded.
size label yes The size of the addon.
tags label yes Contents of the PblWML "tags" attribute.

Add-on uninstall list

Dialog with a checkbox list for choosing installed add-ons to remove.

ID (return value) Type Mandatory Description
addons_list listbox yes A listbox containing add-on selection entries.
        checkbox toggle_button yes A toggle button allowing the user to mark/unmark the add-on.
        name control no The name of the add-on.

Campaign difficulty

The campaign mode difficulty menu.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
message scroll_label no Text label displaying a description or instructions.
listbox listbox yes Listbox displaying user choices, defined by WML for each campaign.
        icon control yes Widget which shows a listbox item icon, first item markup column.
        label control yes Widget which shows a listbox item label, second item markup column.
        description control yes Widget which shows a listbox item description, third item markup column.

Campaign selection

This shows the dialog which allows the user to choose which campaign to play.

ID (return value) Type Mandatory Description
campaign_list listbox yes A listbox that contains all available campaigns.
        icon image no The icon for the campaign.
        name control no The name of the campaign.
        victory image no The icon to show when the user finished the campaign. The engine determines whether or not the user has finished the campaign and sets the visible flag for the widget accordingly.
campaign_details multi_page yes A multi page widget that shows more details for the selected campaign.
        image image no The image for the campaign.
        description control no The description of the campaign.

Campaign settings

This shows the dialog which allows the user to select an era and modifications for the selected campaign, and to show dialogs for additional level configuration.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
mp_configure toggle_button yes Option to show the multiplayer configure dialog.
mp_connect toggle_button yes Option to show the multiplayer connect dialog.
era_label label yes The label for the era list.
era_list listbox yes List of available eras.
        era label no The name of the era. One can be selected at a time.
mod_label label yes The label for the modification list.
modification_list listbox yes List of available modifications.
        mod toggle_button no The name of the modification. Each can be enabled or disabled.

Debug Clock

This shows the dialog for keeping track of the drawing events related to the current time. (This window is used for debug purposes only.)

ID (return value) Type Mandatory Description
hour_percentage progress_bar no This shows the hours as a percentage, where 24 hours is 100%.
minute_percentage progress_bar no This shows the minutes as a percentage, where 60 minutes is 100%.
second_percentage progress_bar no This shows the seconds as a percentage, where 60 seconds is 100%.
hour integer_selector no This shows the seconds since the beginning of the day. The control should have a minimum_value of 0 and a maximum_value of 86399 (246060 - 1).
minute integer_selector no This shows the seconds since the beginning of the current hour. The control should have a minimum_value of 0 and a maximum_value of 3599 (6060 - 1).
minute integer_selector no This shows the seconds since the beginning of the current minute. The control should have a minimum_value of 0 and a maximum_value of 59.
clock control no A control which will have set three variables in its canvas:
  • hour, the same value as the hour integer_selector.
  • minute, the same value as the minute integer_selector.
  • second, the same value as the second integer_selector.

the control can then show the time in its own preferred format(s).

Core selection

This shows the dialog which allows the user to choose which core to play.

ID (return value) Type Mandatory Description
core_list listbox yes A listbox that contains all available cores.
        icon image no The icon for the core.
        name control no The name of the core.
core_details multi_page yes A multi page widget that shows more details for the selected core.
        image image no The image for the core.
        description control no The description of the core.

Custom Schedules

This shows the dialog to modify tod schedules.

ID (return value) Type Mandatory Description
current_tod_name text_box yes The name of the time of day(ToD).
current_tod_id text_box yes The id of the time of day(ToD).
current_tod_image image yes The image for the time of day(ToD).
current_tod_mask image yes The image mask for the time of day(ToD).
current_tod_sonund label yes The sound for the time of day(ToD).
next_tod button yes Selects the next ToD.
prev_tod button yes Selects the previous ToD.
lawful_bonus slider yes Sets the Lawful Bonus for the current ToD.
tod_red slider yes Sets the red component of the current ToD.
tod_green slider yes Sets the green component of the current ToD.
tod_blue slider yes Sets the blue component of the current ToD.

SP/MP Dependency Check: Confirm Change

Asks the user to confirm a change required to proceed. Currently used for enabling/disabling modifications

ID (return value) Type Mandatory Description
message label yes displays the details of the required changes
itemlist scroll_label yes displays the list of affected items
cancel button yes refuse to apply changes
ok button yes agree to apply changes

SP/MP Dependency Check: Select New

Offers a list of compatible items if a currently selected one is incompatible. Currently used for switching era or map.

ID (return value) Type Mandatory Description
message label yes displays the details of the required changes
itemlist listbox yes displays the available items to choose from
cancel button yes refuse to apply any changes
ok button yes select the chosen item

Edit label

Dialog for editing gamemap labels.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
label text_box yes Input field for the map label.
team_only_toggle toggle_button yes Checkbox for whether to make the label visible to the player's team only or not.

Editor Edit label

Dialog for editing gamemap labels.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
label text_box yes Input field for the map label.
team_only_toggle toggle_button yes Checkbox for whether to make the label visible to the player's team only or not.

Edit scenario

Dialog for editing gamemap scenarios.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
label text_box yes Input field for the map label.
team_only_toggle toggle_button yes Checkbox for whether to make the label visible to the player's team only or not.

Edit side

Dialog for editing gamemap sides.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
id text_box yes Input field for the id.
team_only_toggle toggle_button yes Checkbox for whether to make the label visible to the player's team only or not.

Editor generate map

This shows the dialog in the editor to select which random generator should be used to generate a map.

ID (return value) Type Mandatory Description
generators_list listbox yes Listbox displaying known map generators.
settings button yes When clicked this button opens the generator settings dialog.
seed_textbox text_box yes Allows entering a seed for the map generator.

Editor new map

This shows the dialog to generate a new map in the editor.

ID (return value) Type Mandatory Description
width integer_selector yes An integer selector to determine the width of the map to create.
height integer_selector yes An integer selector to determine the height of the map to create.

Editor resize map

This shows the dialog to resize the current map.

ID (return value) Type Mandatory Description
old_width label no Shows the old width of the map.
old_height label no Shows the old height of the map.
width slider yes Determines the new width of the map.
height slider yes Determines the new height of the map.
copy_edge_terrain boolean_selector yes Determines whether the border terrains should be used to expand or not.
expand0 toggle_button yes Determines in which direction to expand, shows the north east marker.
expand1 toggle_button yes Determines in which direction to expand, shows the north marker.
expand2 toggle_button yes Determines in which direction to expand, shows the north west marker.
expand3 toggle_button yes Determines in which direction to expand, shows the east marker.
expand4 toggle_button yes Determines in which direction to expand, shows the center marker.
expand5 toggle_button yes Determines in which direction to expand, shows the west marker.
expand6 toggle_button yes Determines in which direction to expand, shows the south east marker.
expand7 toggle_button yes Determines in which direction to expand, shows the south marker.
expand8 toggle_button yes Determines in which direction to expand, shows the south west marker.

Editor set starting position

Map editor dialog for setting player starting positions.

ID (return value) Type Mandatory Description
listbox listbox yes Listbox displaying player choices.
        player control yes Widget which shows a player item label.
        location control yes Widget which shows the coordinates to the current starting position for a player if it exists.
ok button yes OK button.
cancel button yes Cancel button.

Folder Create

Dialog for providing the name of a new folder to create. Used by the file dialog.

ID (return value) Type Mandatory Description
name text_box yes Input field for the new folder name.

Formula debugger

This shows the debugger for the formulas.

ID (return value) Type Mandatory Description
stack control yes A stack.
execution control yes Execution trace label.
state control yes The state.
step button yes Button to step into the execution.
stepout button yes Button to step out of the execution.
next button yes Button to execute the next statement.
continue button yes Button to continue the execution.

Game cache options

A Preferences subdialog including a report on the location and size of the game's WML cache, buttons to copy its path to clipboard or browse to it, and the possibility of clearing stale files from the cache or purging it entirely.

ID (return value) Type Mandatory Description
path text_box yes Cache dir path.
copy button yes Copies the cache path to clipboard.
browse button yes Browses to the cache path using the platform's file management application.
size label yes Current total size of the cache dir's contents.
clean button yes Cleans the cache, erasing stale files not used by the Wesnoth version presently running the dialog.
purge button yes Purges the cache in its entirety.

Delete a savegame

This shows the dialog to confirm deleting a savegame file.

ID (return value) Type Mandatory Description
dont_ask_again boolean_selector yes A checkbox to not show this dialog again.

Load a game

This shows the dialog to select and load a savegame file.

ID (return value) Type Mandatory Description
txtFilter text yes The filter for the listbox items.
savegame_list listbox yes List of savegames.
        filename control yes Name of the savegame.
        date control no Date the savegame was created.
preview_pane widget yes Container widget or grid that contains the items for a preview. The visible status of this container depends on whether or not something is selected.
        minimap minimap yes Minimap of the selected savegame.
        imgLeader image yes The image of the leader in the selected savegame.
        lblScenario label yes The name of the scenario of the selected savegame.
        lblSummary label yes Summary of the selected savegame.

Save a game

This shows the dialog to create a savegame file.

ID (return value) Type Mandatory Description
lblTitle label yes The title of the window.
txtFilename text_box yes The name of the savefile.

Game paths

Dialog displaying the various paths used by the game to locate resource and configuration files.

There are several item types used to build widget ids in this dialog. All references to TYPE below refer to the following suffixes: datadir, config, userdata, saves, addons, cache.

ID (return value) Type Mandatory Description
path_TYPE text_box yes Textbox containing the filesystem path for the given item.
copy_TYPE button yes Copies the given item's path to clipboard.
browse_TYPE button yes Launches the default file browser on the given item's path.

Gamestate inspector

This shows the gamestate inspector

ID (return value) Type Mandatory Description
inspector_name control yes Name of the inspector.
stuff_list control yes List of various stuff that can be viewed.
inspect control yes The state of the variable or event.
copy button yes A button to copy the state to clipboard.

Joystick settings

Joystick configuration dialog.

Empty table.

Language selection

This shows the dialog to select the language to use. When the dialog is closed with the OK button it also updates the selected language in the preferences.

ID (return value) Type Mandatory Description
language_list listbox yes This listbox contains the list with available languages.
        free to choose control no Show the name of the language in the current row.

Lobby sounds options

A Preferences subdialog permitting to configure the sounds and notifications generated in response to various mp lobby / game events.

ID (return value) Type Mandatory Description
_label label yes Item name.
_sound toggle_button yes Toggles whether to play the item sound.
_notif toggle_button yes Toggles whether to give a notification.
_lobby toggle_button yes Toggles whether to take actions for this item when in the lobby.

Change control dialog

This shows the multiplayer change control dialog.

ID (return value) Type Mandatory Description
sides_list listbox yes List of sides participating in the MP game.
nicks_list listbox yes List of nicks of all clients playing or observing the MP game.

Multiplayer command wrapper

This shows a dialog that provides a graphical front-end to various commands in the multiplayer lobby

ID (return value) Type Mandatory Description
message text_box no Text to send as a private message.
reason text_box no The reason for a ban.
time text_box no The time the ban lasts.
user_label label no The label to show which user has been selected.
send_message button yes Execute /msg.
add_friend button yes Execute /friend.
add_ignore button yes Execute /ignore.
remove button yes Execute /remove.
status button yes Execute /query status.
kick button yes Execute /query kick.
ban button yes Execute /query kban.
mod_options grid yes Grid containing the status/kick/ban options. This grid and its children are hidden when these options are unavailable.

Multiplayer connect

This shows the dialog to the MP server to connect to.

ID (return value) Type Mandatory Description
start_table text_box yes The name of the server to connect to.
list button no Shows a dialog with a list of predefined servers to connect to.

Create Game: Set Password

Dialog for setting a join password for MP games.

ID (return value) Type Mandatory Description
password text_box yes Input field for the game password.

Host Networked Game prompt

This shows the dialog to confirm deleting a savegame file.

ID (return value) Type Mandatory Description
do_not_show_again boolean_selector yes A checkbox to not show this dialog again.

Join Game: Password Prompt

Dialog for entering a password for joining a password-protected MP game.

ID (return value) Type Mandatory Description
password text_box yes Input field for the game password.

Multiplayer connect

This shows the dialog to log in to the MP server

ID (return value) Type Mandatory Description
user_name text_box yes The login user name.
password text_box yes The password.
remember_password toggle_button no A toggle button to offer to remember the password in the preferences.
password_reminder button no Request a password reminder.
change_username button no Use a different username.
login_label button no Displays the information received from the server.

MP method selection

This shows the dialog to select the kind of MP game the user wants to play.

ID (return value) Type Mandatory Description
user_name text_box yes This text contains the name the user on the MP server. This widget will get a fixed maximum length by the engine.
method_list listbox yes The list with possible game methods.

Multiplayer server list

This shows the dialog with a list of predefined multiplayer servers.

ID (return value) Type Mandatory Description
server_list listbox yes Listbox with the predefined servers to connect to.
        name control no Widget which shows the name of the server.
        address control yes The address/host_name of the server.

Rename unit

Dialog for renaming units in-game.

ID (return value) Type Mandatory Description
name text_box yes Input field for the unit name.

Screenshot notification

Notification dialog used after saving a game or map screenshot to display information about it for the user.

ID (return value) Type Mandatory Description
path text_box yes Read-only textbox containing the screenshot path.
filesize label no Optional label to display the file size.
copy button yes Button to copy the path to clipboard.
open button yes Button to open the screnshot using the default application.
browse_dir button yes Button to browse the screenshots directory in the file manager.

Simple item selector

A simple one-column listbox with OK and Cancel buttons.

ID (return value) Type Mandatory Description
title label yes Dialog title label.
message control yes Text label displaying a description or instructions.
listbox listbox yes Listbox displaying user choices.
        item control yes Widget which shows a listbox item label.
ok button yes OK button.
cancel button yes Cancel button.

Theme list

Dialog for selecting a GUI theme.

ID (return value) Type Mandatory Description
themes listbox yes Listbox displaying user choices.
        name control yes Widget which shows a theme item name.
        description control yes Widget which shows a theme item description.

Tip float

Generic window to show a floating tip window. The class has several subclasses using the same format. For example there will be tooltips and helptips, both using this class.

ID (return value) Type Mandatory Description
label control yes This text contains the message to show in the tip.

In the canvas of the windows used in this dialog the following variables are defined:

Variable type description
mouse_x unsigned The x coordinate of the mouse pointer when the window was created.
mouse_y unsigned The y coordinate of the mouse pointer when the window was created.

Title screen

This shows the title screen.

ID (return value) Type Mandatory Description
campaign button yes The button to start a campaign.
multiplayer button yes The button to start multiplayer mode.
load button yes The button to load a saved game.
editor button yes The button to start the editor.
addons button yes The button to start managing the addons.
cores button yes The button to start managing the cores.
language button yes The button to select the game language.
credits button yes The button to show Wesnoth's contributors.
quit button yes The button to quit Wesnoth.
tips multi_page yes A multi_page to hold all tips, when this widget is used the area of the tips doesn't need to be resized when the next or previous button is pressed.
        tip label no Shows the text of the current tip.
        source label no The source (the one who's quoted or the book referenced) of the current tip.
next_tip button yes The button show the next tip of the day.
previous_tip button yes The button show the previous tip of the day.
logo progress_bar no A progress bar to "animate" the Wesnoth logo.
revision_number control no A widget to show the version number when the version number is known.

Unit attack

This shows the dialog for attacking units.

ID (return value) Type Mandatory Description
attacker_portrait image no Shows the portrait of the attacking unit.
attacker_icon image no Shows the icon of the attacking unit.
attacker_name control no Shows the name of the attacking unit.
defender_portrait image no Shows the portrait of the defending unit.
defender_icon image no Shows the icon of the defending unit.
defender_name control no Shows the name of the defending unit.
weapon_list listbox yes The list with weapons to choose from.
        attacker_weapon control no The weapon for the attacker to use.
        defender_weapon control no The weapon for the defender to use.

Unit create

This shows the debug-mode dialog to create new units on the map.

ID (return value) Type Mandatory Description
male_toggle toggle_button yes Option button to select the "male" gender for created units.
female_toggle toggle_button yes Option button to select the "female" gender for created units.
unit_type_list listbox yes Listbox displaying existing unit types sorted by name and race.
        unit_type control yes Widget which shows the unit type name label.
        race control yes Widget which shows the unit race name label.

WML error

WML preprocessor/parser error report dialog.

ID (return value) Type Mandatory Description
summary control yes Label used for displaying a brief summary of the error(s).
files control yes Label used to display the list of affected add-ons or files, if applicable. It is hidden otherwise. It is recommended to place it after the summary label.
post_summary control yes Label used for displaying instructions for reporting the error. It is recommended to place it after the file list label. It may be hidden if empty.
details control yes Full report of the parser or preprocessor error(s) found.
copy button yes Button that the user can click on to copy the error report to the system clipboard.

Settings manager

This shows the settings manager

This page was last edited on 27 April 2024, at 17:55.