War.app Wiki - User contributions [en]

Map requirements

2020-04-10T14:49:01Z

TBest: /* Map Limits */

This page lists the requirements that all maps must meet in order to [[Making maps public|go public]].

== Requirements ==

=== Connections are Visible ===

Players must be able to tell what territories connect just by looking at the map.

The biggest mistake some map creators make is to connect two territories over water, but don't include any indication on the map that they connect. It's customary to use yellow lines to show where the connections are - see the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map] for an example. It's not necessary to use yellow lines, it just must be obvious where the connections are. It may be obvious that the territories connect in the map designer, but it needs to be obvious in the real game too.

https://d32kaghj56y4ei.cloudfront.net/static/img/ConnectionMissing.png

In maps with tricky connections, you may need to take special care to ensure that the connections can be reasonably figured out just by looking at the map (without clicking around). A common rule of thumb is that territories that touch must connect, and territories that connect but don't touch must show the connection somehow.

=== Tiny Territories ===

All territories must be big enough to fit a two-digit army number. Often people's first instinct is to keep territories real-life sized, however this doesn't work well in Warzone's engine. This is especially evident once you try playing the [[Mobile Client|mobile version of Warzone]].

Take, for example, Hawaii in the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map]. Hawaii is a very small island, but in the Earth map it's sized significantly larger so that it can fit the army number.

In the map designer, you'll find a button labeled Show Example Armies. When clicking this, all army numbers must fit entirely within the territory's borders.

https://d32kaghj56y4ei.cloudfront.net/static/img/TinyTerritories.png

See [[Inkscape tips]] for a guide on how to enlarge territories to make them fit their army number.

=== Copyright Violations ===

By uploading a map to Warzone, you are asserting that you own or have the necessary licenses, rights, consents, and permissions to the content within. See the [https://www.warzone.com/TermsOfService Terms of Service] for full details.

=== Missing or Mistaken Connections ===

Maps makers should make an effort to find and missing or mistaken territory connections. Missing connections are a very common problem, as it is difficult to find every last connection error within the map designer alone.

The best way to find these kinds of mistakes is to play the map with real humans. If you need help finding players to test your map, make a thread on the map development [[forum]] asking for volunteers to help test your map. There are always lots of people willing to help test.

Incorrect or missing connections are also much more pronounced in the map previewer (which you can access via links in the Get Link for Sharing window), where all territories connected to the clicked one turn bright yellow. Map creators should create several [[Testing maps|test games]] on their map with real human players and play them out.

=== Territories are named ===

All territories should be named appropriately. Naming many territories the same thing, or just typing gibberish makes it hard for players to coordinate in team games.

=== Bonus Links ===

Bonus Links are the small boxes that show how many armies each bonus is worth. Without these, it is difficult to tell where the bonuses are. See [[Creating the SVG]] for instructions on how to add bonus links.

When possible, bonus links should be placed near or on top of the bonus they correspond to and be big enough to fit the army number that appears inside of it.

=== Appropriate Size ===

The SVG file specifies the width and height of the map in pixels. The recommended starting point is 1000x1000, however map creators can reduce this if they are making a small map or increase it if they're making a big map.

The size specified in the SVG file determines how big the army numbers will be on the map. This size must be appropriate for the map. If a very small map is stretched into a huge SVG file, the army numbers will be too small to see without zooming in. In order to avoid unnecessary zooming, a large SVG file should only be used if the map really needs that much room to fit all of its territories.

=== Territories should not overlap ===

Player-controllable territories can never overlap with each other. If you find yourself in a situation where you feel like you want one territory to be on top of another, you need to cut a hole in the outer territory in the shape of the inner one. This makes the inner one look like it's on top, even though technically the territories aren't overlapping.

=== Testing Maps ===

The map must be a real map and not just a test. It's a good idea to make your first map just a couple of territories to prove you understand how to make a real map, however maps without any strategic value should not go public. You're free to put these into testing mode to play games on them, however.

=== Map Limits ===

Maps are limited to 30 distribution modes, 1500 bonuses and 3200 territories. The limit on distribution modes and bonuses was changed with update [https://www.warzone.com/ChangeLog/3.23.0.htm 3.23.6 ]

The .svg file also has a max file size limit. Uploading a file that is too big will give the following alert.

Sorry, maps must be smaller than 2,000,000 bytes. This SVG is 9487917 bytes long. If you have images in your map that you used for tracing, you should remove them before uploading since they'll just waste space. It's also possible that the SVG objects contain more detail than is necessary. Try using Inkscape's Simplify feature (Path -> Simplify) on complex objects to reduce their detail, which will reduce their size. If you need more help, please post on the forum.

== Grandfathered Maps ==

Players sometimes notice maps that are already public that don't meet some of these requirements. Older maps that were created before these requirements existed are grandfathered in, such as the Wheel map that does not have bonus links or the United States Big map that had tiny territories. The presence of the old violations does not exempt new maps from the requirements.

== See Also ==

* [[Map Making]]
* [[Map guidelines]]
* [[Inkscape tips]]

[[Category:Map Making]]

Map requirements

2020-04-10T14:47:46Z

TBest: /* Map Limits */

This page lists the requirements that all maps must meet in order to [[Making maps public|go public]].

== Requirements ==

=== Connections are Visible ===

Players must be able to tell what territories connect just by looking at the map.

The biggest mistake some map creators make is to connect two territories over water, but don't include any indication on the map that they connect. It's customary to use yellow lines to show where the connections are - see the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map] for an example. It's not necessary to use yellow lines, it just must be obvious where the connections are. It may be obvious that the territories connect in the map designer, but it needs to be obvious in the real game too.

https://d32kaghj56y4ei.cloudfront.net/static/img/ConnectionMissing.png

In maps with tricky connections, you may need to take special care to ensure that the connections can be reasonably figured out just by looking at the map (without clicking around). A common rule of thumb is that territories that touch must connect, and territories that connect but don't touch must show the connection somehow.

=== Tiny Territories ===

All territories must be big enough to fit a two-digit army number. Often people's first instinct is to keep territories real-life sized, however this doesn't work well in Warzone's engine. This is especially evident once you try playing the [[Mobile Client|mobile version of Warzone]].

Take, for example, Hawaii in the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map]. Hawaii is a very small island, but in the Earth map it's sized significantly larger so that it can fit the army number.

In the map designer, you'll find a button labeled Show Example Armies. When clicking this, all army numbers must fit entirely within the territory's borders.

https://d32kaghj56y4ei.cloudfront.net/static/img/TinyTerritories.png

See [[Inkscape tips]] for a guide on how to enlarge territories to make them fit their army number.

=== Copyright Violations ===

By uploading a map to Warzone, you are asserting that you own or have the necessary licenses, rights, consents, and permissions to the content within. See the [https://www.warzone.com/TermsOfService Terms of Service] for full details.

=== Missing or Mistaken Connections ===

Maps makers should make an effort to find and missing or mistaken territory connections. Missing connections are a very common problem, as it is difficult to find every last connection error within the map designer alone.

The best way to find these kinds of mistakes is to play the map with real humans. If you need help finding players to test your map, make a thread on the map development [[forum]] asking for volunteers to help test your map. There are always lots of people willing to help test.

Incorrect or missing connections are also much more pronounced in the map previewer (which you can access via links in the Get Link for Sharing window), where all territories connected to the clicked one turn bright yellow. Map creators should create several [[Testing maps|test games]] on their map with real human players and play them out.

=== Territories are named ===

All territories should be named appropriately. Naming many territories the same thing, or just typing gibberish makes it hard for players to coordinate in team games.

=== Bonus Links ===

Bonus Links are the small boxes that show how many armies each bonus is worth. Without these, it is difficult to tell where the bonuses are. See [[Creating the SVG]] for instructions on how to add bonus links.

When possible, bonus links should be placed near or on top of the bonus they correspond to and be big enough to fit the army number that appears inside of it.

=== Appropriate Size ===

The SVG file specifies the width and height of the map in pixels. The recommended starting point is 1000x1000, however map creators can reduce this if they are making a small map or increase it if they're making a big map.

The size specified in the SVG file determines how big the army numbers will be on the map. This size must be appropriate for the map. If a very small map is stretched into a huge SVG file, the army numbers will be too small to see without zooming in. In order to avoid unnecessary zooming, a large SVG file should only be used if the map really needs that much room to fit all of its territories.

=== Territories should not overlap ===

Player-controllable territories can never overlap with each other. If you find yourself in a situation where you feel like you want one territory to be on top of another, you need to cut a hole in the outer territory in the shape of the inner one. This makes the inner one look like it's on top, even though technically the territories aren't overlapping.

=== Testing Maps ===

The map must be a real map and not just a test. It's a good idea to make your first map just a couple of territories to prove you understand how to make a real map, however maps without any strategic value should not go public. You're free to put these into testing mode to play games on them, however.

=== Map Limits ===

Maps are limited to 30 distribution modes, 1500 bonuses and 3200 territories. The limit on distribution modes and bonuses was changed with update [https://www.warzone.com/ChangeLog/3.23.0.htm 3.23.6 ]

The .svg file also has a max filesize limit. Uploading a file that is too big will give the following alert.

Sorry, maps must be smaller than 2,000,000 bytes. This SVG is 9487917 bytes long. If you have images in your map that you used for tracing, you should remove them before uploading since they'll just waste space. It's also possible that the SVG objects contain more detail than is necessary. Try using Inkscape's Simplify feature (Path -> Simplify) on complex objects to reduce their detail, which will reduce their size. If you need more help, please post on the forum.

== Grandfathered Maps ==

Players sometimes notice maps that are already public that don't meet some of these requirements. Older maps that were created before these requirements existed are grandfathered in, such as the Wheel map that does not have bonus links or the United States Big map that had tiny territories. The presence of the old violations does not exempt new maps from the requirements.

== See Also ==

* [[Map Making]]
* [[Map guidelines]]
* [[Inkscape tips]]

[[Category:Map Making]]

Map requirements

2020-03-25T01:13:01Z

TBest: /* Map Limits */

This page lists the requirements that all maps must meet in order to [[Making maps public|go public]].

== Requirements ==

=== Connections are Visible ===

Players must be able to tell what territories connect just by looking at the map.

The biggest mistake some map creators make is to connect two territories over water, but don't include any indication on the map that they connect. It's customary to use yellow lines to show where the connections are - see the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map] for an example. It's not necessary to use yellow lines, it just must be obvious where the connections are. It may be obvious that the territories connect in the map designer, but it needs to be obvious in the real game too.

https://d32kaghj56y4ei.cloudfront.net/static/img/ConnectionMissing.png

In maps with tricky connections, you may need to take special care to ensure that the connections can be reasonably figured out just by looking at the map (without clicking around). A common rule of thumb is that territories that touch must connect, and territories that connect but don't touch must show the connection somehow.

=== Tiny Territories ===

All territories must be big enough to fit a two-digit army number. Often people's first instinct is to keep territories real-life sized, however this doesn't work well in Warzone's engine. This is especially evident once you try playing the [[Mobile Client|mobile version of Warzone]].

Take, for example, Hawaii in the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map]. Hawaii is a very small island, but in the Earth map it's sized significantly larger so that it can fit the army number.

In the map designer, you'll find a button labeled Show Example Armies. When clicking this, all army numbers must fit entirely within the territory's borders.

https://d32kaghj56y4ei.cloudfront.net/static/img/TinyTerritories.png

See [[Inkscape tips]] for a guide on how to enlarge territories to make them fit their army number.

=== Copyright Violations ===

By uploading a map to Warzone, you are asserting that you own or have the necessary licenses, rights, consents, and permissions to the content within. See the [https://www.warzone.com/TermsOfService Terms of Service] for full details.

=== Missing or Mistaken Connections ===

Maps makers should make an effort to find and missing or mistaken territory connections. Missing connections are a very common problem, as it is difficult to find every last connection error within the map designer alone.

The best way to find these kinds of mistakes is to play the map with real humans. If you need help finding players to test your map, make a thread on the map development [[forum]] asking for volunteers to help test your map. There are always lots of people willing to help test.

Incorrect or missing connections are also much more pronounced in the map previewer (which you can access via links in the Get Link for Sharing window), where all territories connected to the clicked one turn bright yellow. Map creators should create several [[Testing maps|test games]] on their map with real human players and play them out.

=== Territories are named ===

All territories should be named appropriately. Naming many territories the same thing, or just typing gibberish makes it hard for players to coordinate in team games.

=== Bonus Links ===

Bonus Links are the small boxes that show how many armies each bonus is worth. Without these, it is difficult to tell where the bonuses are. See [[Creating the SVG]] for instructions on how to add bonus links.

When possible, bonus links should be placed near or on top of the bonus they correspond to and be big enough to fit the army number that appears inside of it.

=== Appropriate Size ===

The SVG file specifies the width and height of the map in pixels. The recommended starting point is 1000x1000, however map creators can reduce this if they are making a small map or increase it if they're making a big map.

The size specified in the SVG file determines how big the army numbers will be on the map. This size must be appropriate for the map. If a very small map is stretched into a huge SVG file, the army numbers will be too small to see without zooming in. In order to avoid unnecessary zooming, a large SVG file should only be used if the map really needs that much room to fit all of its territories.

=== Territories should not overlap ===

Player-controllable territories can never overlap with each other. If you find yourself in a situation where you feel like you want one territory to be on top of another, you need to cut a hole in the outer territory in the shape of the inner one. This makes the inner one look like it's on top, even though technically the territories aren't overlapping.

=== Testing Maps ===

The map must be a real map and not just a test. It's a good idea to make your first map just a couple of territories to prove you understand how to make a real map, however maps without any strategic value should not go public. You're free to put these into testing mode to play games on them, however.

=== Map Limits ===

Maps are limited to 30 distribution modes, 1500 bonuses and 3200 territories. The limit on distribution modes and bonuses was changed with update [https://www.warzone.com/ChangeLog/3.23.0.htm 3.23.6 ]

== Grandfathered Maps ==

Players sometimes notice maps that are already public that don't meet some of these requirements. Older maps that were created before these requirements existed are grandfathered in, such as the Wheel map that does not have bonus links or the United States Big map that had tiny territories. The presence of the old violations does not exempt new maps from the requirements.

== See Also ==

* [[Map Making]]
* [[Map guidelines]]
* [[Inkscape tips]]

[[Category:Map Making]]

Map requirements

2020-03-25T01:12:11Z

TBest: /* Requirements */

This page lists the requirements that all maps must meet in order to [[Making maps public|go public]].

== Requirements ==

=== Connections are Visible ===

Players must be able to tell what territories connect just by looking at the map.

The biggest mistake some map creators make is to connect two territories over water, but don't include any indication on the map that they connect. It's customary to use yellow lines to show where the connections are - see the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map] for an example. It's not necessary to use yellow lines, it just must be obvious where the connections are. It may be obvious that the territories connect in the map designer, but it needs to be obvious in the real game too.

https://d32kaghj56y4ei.cloudfront.net/static/img/ConnectionMissing.png

In maps with tricky connections, you may need to take special care to ensure that the connections can be reasonably figured out just by looking at the map (without clicking around). A common rule of thumb is that territories that touch must connect, and territories that connect but don't touch must show the connection somehow.

=== Tiny Territories ===

All territories must be big enough to fit a two-digit army number. Often people's first instinct is to keep territories real-life sized, however this doesn't work well in Warzone's engine. This is especially evident once you try playing the [[Mobile Client|mobile version of Warzone]].

Take, for example, Hawaii in the [https://www.warzone.com/SinglePlayer?PreviewMap=12 Earth Map]. Hawaii is a very small island, but in the Earth map it's sized significantly larger so that it can fit the army number.

In the map designer, you'll find a button labeled Show Example Armies. When clicking this, all army numbers must fit entirely within the territory's borders.

https://d32kaghj56y4ei.cloudfront.net/static/img/TinyTerritories.png

See [[Inkscape tips]] for a guide on how to enlarge territories to make them fit their army number.

=== Copyright Violations ===

By uploading a map to Warzone, you are asserting that you own or have the necessary licenses, rights, consents, and permissions to the content within. See the [https://www.warzone.com/TermsOfService Terms of Service] for full details.

=== Missing or Mistaken Connections ===

Maps makers should make an effort to find and missing or mistaken territory connections. Missing connections are a very common problem, as it is difficult to find every last connection error within the map designer alone.

The best way to find these kinds of mistakes is to play the map with real humans. If you need help finding players to test your map, make a thread on the map development [[forum]] asking for volunteers to help test your map. There are always lots of people willing to help test.

Incorrect or missing connections are also much more pronounced in the map previewer (which you can access via links in the Get Link for Sharing window), where all territories connected to the clicked one turn bright yellow. Map creators should create several [[Testing maps|test games]] on their map with real human players and play them out.

=== Territories are named ===

All territories should be named appropriately. Naming many territories the same thing, or just typing gibberish makes it hard for players to coordinate in team games.

=== Bonus Links ===

Bonus Links are the small boxes that show how many armies each bonus is worth. Without these, it is difficult to tell where the bonuses are. See [[Creating the SVG]] for instructions on how to add bonus links.

When possible, bonus links should be placed near or on top of the bonus they correspond to and be big enough to fit the army number that appears inside of it.

=== Appropriate Size ===

The SVG file specifies the width and height of the map in pixels. The recommended starting point is 1000x1000, however map creators can reduce this if they are making a small map or increase it if they're making a big map.

The size specified in the SVG file determines how big the army numbers will be on the map. This size must be appropriate for the map. If a very small map is stretched into a huge SVG file, the army numbers will be too small to see without zooming in. In order to avoid unnecessary zooming, a large SVG file should only be used if the map really needs that much room to fit all of its territories.

=== Territories should not overlap ===

Player-controllable territories can never overlap with each other. If you find yourself in a situation where you feel like you want one territory to be on top of another, you need to cut a hole in the outer territory in the shape of the inner one. This makes the inner one look like it's on top, even though technically the territories aren't overlapping.

=== Testing Maps ===

The map must be a real map and not just a test. It's a good idea to make your first map just a couple of territories to prove you understand how to make a real map, however maps without any strategic value should not go public. You're free to put these into testing mode to play games on them, however.

=== Map Limits ===

Maps are limited to 30 distribution modes, 1500 bonuses and 3200 territories. The limit on distribution modes and bonuses was changed with update [https://www.warzone.com/ChangeLog/3.23.0.htm 3.23.0 ]

== Grandfathered Maps ==

Players sometimes notice maps that are already public that don't meet some of these requirements. Older maps that were created before these requirements existed are grandfathered in, such as the Wheel map that does not have bonus links or the United States Big map that had tiny territories. The presence of the old violations does not exempt new maps from the requirements.

== See Also ==

* [[Map Making]]
* [[Map guidelines]]
* [[Inkscape tips]]

[[Category:Map Making]]

Mod API Reference:UI

2020-03-15T16:27:56Z

TBest: /* Colors in the browser */

Mods can put UI (user interface) onto the screen when called from one of the Client '''Present''' [[Mod Hooks|hooks]]. This page describes how to create and update UI elements.

UI elements are created by accessing the <code>UI</code> global. For example, mods can call UI.CreateButton(...) to create a button. Any UI element listed below can be created in a similar manner.

Behind the scenes, these objects are implemented using Unity's UI and layout system. Being familiar with Unity's UI system will make understanding how to build UI easier, but it's not a requirement.

== Parents ==
All UI constructors take a single <code>parent</code> argument. This allows you to construct hierarchies. For example, mods can create a vertical stack of three buttons like this:

local vert = UI.CreateVerticalLayoutGroup(rootParent);
local btn1 = UI.CreateButton(vert);
local btn2 = UI.CreateButton(vert);
local btn3 = UI.CreateButton(vert);

When a mod is called to present UI, it will be passed a root UI element (rootParent). Your mod should pass the rootParent to a UI element that will be the root of all other elements you need. This element is most often a VerticalLayoutGroup, as shown in the example above.

You can never make more than one element a child of the rootParent. If you need more than one, simply make your own container to house them.

== Properties ==

UI elements have properties that can be read or set. For example, Buttons have a Text property that allows you to set the text that appears on the button.

To read or write a UI element's property, you must use getter/setter functions named GetX() and SetX(). For example, to set the text of a button you can write <code>btn1.SetText('Click me!')</code> and can retrieve it using <code>btn1.GetText()</code>.

All getter and setter functions return the UI element, which means you can chain them together to easily set lots of properties. For example:

UI.CreateButton(vert)
.SetText('Click me!')
.SetColor('#00FF00')
.SetOnClick(someFunction);

== Common Properties ==

All UI elements have the following properties:
* '''PreferredWidth''' ''number'': How wide the element prefers to be. It may not be this wide if there is not enough space, and it may be wider if FlexibleWidth is greater than 0. Defaults to -1, which is a special value meaning the object will meansure its own size based on its contents.
* '''PreferredHeight''' ''number'': How tall the element prefers to be. It may not be this tall if there is not enough space, and it may be taller if FlexibleHeight is greater than 0. Defaults to -1, which is a special value meaning the object will meansure its own size based on its contents.
* '''FlexibleWidth''' ''number'': A number from 0 to 1 indicating how much of the remaining space this element wishes to take up. Defaults to 0, which means the element will be no wider than PreferredWidth. Set it to 1 to indicate the object should grow to encompass all remaining horizontal space it can.
* '''FlexibleHeight''' ''number'': A number from 0 to 1 indicating how much of the remaining space this element wishes to take up. Defaults to 0, which means the element will be no taller than PreferredHeight. Set it to 1 to indicate the object should grow to encompass all remaining vertical space it can.

== UI Elements ==

'''Empty''': A simple UI element that displays nothing. This can be used as a container or to create space.

'''VerticalLayoutGroup''': A container that stacks its children vertically.

'''HorizontalLayoutGroup''': A container that stacks its children horizontally.

'''Label''': A way to display text on the screen.
* '''Text''' ''string'': The text to display.
* '''Color''' ''string'': The color of the text. Pass this as a string in #RRGGBB format.

'''Button''': A button that players can click on to do something.
* '''Text''' ''string'': The text to display on the button.
* '''Color''' ''string'': The color of the button. Pass this as a string in #RRGGBB format.
* '''TextColor''' ''string'': The color of the text on teh button. Pass this as a string in #RRGGBB format.
* '''OnClick''' ''function'': Pass the name of a lua function to be called whenever the player clicks the button.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

'''CheckBox''': A toggleable check box that players can check and uncheck.
* '''IsChecked''' ''bool'': Whether the check box is checked or unchecked.
* '''Text''' ''string'': The label displayed to the right of the check box.
* '''OnValueChanged''' ''function'': Pass the name of a lua function to be called whenever the IsChecked property changes, either by your code or by the player clicking the check box.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

'''TextInputField''': A box where players can type a string.
* '''Text''' ''string'': The string that appears in the box, or that players typed.
* '''PlaceholderText''' ''string'': The text that appears in the box grayed out when it's empty. For example, "Enter name here..."
* '''CharacterLimit''' ''integer'': The maximum number of characters that players can type into this text field.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

'''NumberInputField''': Allows players to input a number. Presents an input box and a slider that are linked, so players can either use the box to type a number or slide the slider. This makes it friendly for mobile users who don't have a hardware keyboard, while also allowing any number to be entered if someone wants to exceed the range allowable by the slider.
* '''Value''' ''number'': The value to show in the box+slider, or the value entered by the player.
* '''WholeNumbers''' ''bool'': If true, only integers will be selectable by the player. If false, partial numbers will be selectable. Defaults to true.
* '''SliderMinValue''' ''number'': The minimum value selectable by the slider. Numbers below this can still be entered by typing them into the box, so ensure to always validate the number you retrieve.
* '''SliderMaxValue''' ''number'': The maxium value selectable by the slider. Numbers above this can still be entered by typing them into the box, so ensure to always validate the number you retrieve.
* '''BoxPreferredWidth''' ''number'': Allows setting the preferred width of just the box. See '''Common Properties''' above.
* '''SliderPreferredWidth''' ''number'': Allows setting the preferred width of just the slider. See '''Common Properties''' above.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

== Helper Functions ==

'''UI.Destroy''': Destroys (removes) any UI that the mod previously created. Simply pass a UI element created by one of the UI.CreateXXX functions to UI.Destroy and it will disappear forever.

'''UI.Alert''': Pops up a dialog with a message and an Okay button to close the message. Call this as simply <code>UI.Alert(msg)</code>

'''UI.PromptFromList''': Pops up a dialog with a series of buttons to choose from. This takes two arguments:
* '''Message''' ''string'': Text to appear at the top of the dialog.
* '''Options''' ''array'': A list of options, each of which will show up as a button. Each entry in this array should be a table with two fields, '''text''' and '''selected'''. '''text''' populates the text that will appear on that button, and '''selected''' is a zero-argument function that gets called if the player selects that option.
[[Category:Mod API Reference]]

Mod API Reference:UI

2020-03-15T16:17:21Z

TBest: