Mod API Reference:UI - Revision history

Fizzer at 02:36, 18 April 2026

2026-04-18T02:36:12Z

← Older revision		Revision as of 02:36, 18 April 2026
Line 37:		Line 37:
	* '''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.		* '''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.		* '''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.
	* '''MinWidth''' ''number'': The minimum width an element can be, up to a maximum of 60. Developers should take special care when using MinWidth since many players play ~~Warzone~~ on phones in portrait mode where there is very limited horizontal space. This setting is limited to 60 since it's intended to be used only for smaller elements, for example when you need to line things up vertically. (Added in version 5.34.1)		* '''MinWidth''' ''number'': The minimum width an element can be, up to a maximum of 60. Developers should take special care when using MinWidth since many players play War.app on phones in portrait mode where there is very limited horizontal space. This setting is limited to 60 since it's intended to be used only for smaller elements, for example when you need to line things up vertically. (Added in version 5.34.1)
	* '''MinHeight''' ''number'': The minimum height an element can be. (Added in version 5.34.1)		* '''MinHeight''' ''number'': The minimum height an element can be. (Added in version 5.34.1)

JustADutchman: /* Helper Functions */

2026-04-17T19:21:53Z

Helper Functions

← Older revision		Revision as of 19:21, 17 April 2026
Line 115:		Line 115:
	'''UI.PromptFromList''': Pops up a dialog with a series of buttons to choose from. This takes two arguments:		'''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.		* '''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.		* '''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, '''selected''' and either '''text''' or '''player'''. '''selected''' is a zero-argument function that gets called if the player selects that option, '''text''' populates the text that will appear on that button. '''player''' should be set to a [[Mod_API_Reference:PlayerID\|playerID]], this will also give the button the corresponding color of the player.

Fizzer at 22:19, 29 March 2025

2025-03-29T22:19:44Z

← Older revision		Revision as of 22:19, 29 March 2025
Line 53:		Line 53:
	* '''Text''' ''string'': The text to display.		* '''Text''' ''string'': The text to display.
	* '''Color''' ''string'': The color of the text. Pass this as a string in #RRGGBB format.		* '''Color''' ''string'': The color of the text. Pass this as a string in #RRGGBB format.
			* '''Alignment''' ''[[Mod API Reference:TextAlignmentOptions\|TextAlignmentOptions]] (enum)'': Sets text alignment, vertically and horizontally, within the label. This will usually only have an effect if the label is made larger by increasing its Preferred, Minimum, or Flexible width/height. (Added in version 5.34.1)

	'''Button''': A button that players can click on to do something.		'''Button''': A button that players can click on to do something.

Fizzer at 22:06, 29 March 2025

2025-03-29T22:06:19Z

← Older revision		Revision as of 22:06, 29 March 2025
Line 33:		Line 33:

	All UI elements have the following 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.		* '''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 measure 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.		* '''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 measure 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.		* '''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.		* '''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.
			* '''MinWidth''' ''number'': The minimum width an element can be, up to a maximum of 60. Developers should take special care when using MinWidth since many players play Warzone on phones in portrait mode where there is very limited horizontal space. This setting is limited to 60 since it's intended to be used only for smaller elements, for example when you need to line things up vertically. (Added in version 5.34.1)
			* '''MinHeight''' ''number'': The minimum height an element can be. (Added in version 5.34.1)

	== UI Elements ==		== UI Elements ==

Fizzer at 10:20, 14 March 2025

2025-03-14T10:20:10Z

← Older revision		Revision as of 10:20, 14 March 2025
Line 43:		Line 43:

	'''VerticalLayoutGroup''': A container that stacks its children vertically.		'''VerticalLayoutGroup''': A container that stacks its children vertically.
			* '''Center''' ''bool'': If true, the container will center elements within it horizontally. Defaults to false.

	'''HorizontalLayoutGroup''': A container that stacks its children horizontally.		'''HorizontalLayoutGroup''': A container that stacks its children horizontally.
			* '''Center''' ''bool'': If true, the container will center elements within it vertically. Defaults to false.

	'''Label''': A way to display text on the screen.		'''Label''': A way to display text on the screen.

DanWL60: /* UI Elements */ mention in which version RadioButton added in

2025-03-11T14:16:44Z

UI Elements: mention in which version RadioButton added in

← Older revision		Revision as of 14:16, 11 March 2025
Line 67:		Line 67:


	'''RadioButton''': Like a CheckBox except circular, and when assigned into a group, only one may be selected at a time.		'''RadioButton''': Added in [[Mod API Reference:IsVersionOrHigher\|5.34.0]]. Like a CheckBox except circular, and when assigned into a group, only one may be selected at a time.
	* '''IsChecked''' ''bool'': Whether it's checked or unchecked.		* '''IsChecked''' ''bool'': Whether it's checked or unchecked.
	* '''Text''' ''string'': The label displayed to the right of the radio button.		* '''Text''' ''string'': The label displayed to the right of the radio button.

Fizzer at 21:25, 10 March 2025

2025-03-10T21:25:49Z

← Older revision		Revision as of 21:25, 10 March 2025
Line 65:		Line 65:
	* '''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.		* '''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.		* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.


	'''RadioButton''': Like a CheckBox except circular, and when assigned into a group, only one may be selected at a time.		'''RadioButton''': Like a CheckBox except circular, and when assigned into a group, only one may be selected at a time.

Fizzer at 21:19, 10 March 2025

2025-03-10T21:19:36Z

← Older revision		Revision as of 21:19, 10 March 2025
Line 65:		Line 65:
	* '''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.		* '''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.		* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

			'''RadioButton''': Like a CheckBox except circular, and when assigned into a group, only one may be selected at a time.
			* '''IsChecked''' ''bool'': Whether it's checked or unchecked.
			* '''Text''' ''string'': The label displayed to the right of the radio button.
			* '''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.
			* '''Group''': ''RadioButtonGroup'': Created by using UI.CreateRadioButtonGroup. Create one group and assign it to multiple radio buttons to group them together. CreateRadioButtonGroup must be passed a UI element that it will live on. It does not matter what UI element you pass in as long as it doesn't get destroyed before the radio buttons. A common choice is to pass in the first radio button itself, or pass in the VerticalLayoutGroup that all the radio buttons live in together. For example:

			local vert = UI.CreateVerticalLayoutGroup(rootParent);
			local group = UI.CreateRadioButtonGroup(vert);
			UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 1');
			UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 2');
			UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 3');
			UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 4');

DanWL60: /* UI Elements */

2024-05-12T11:29:45Z

UI Elements

← Older revision		Revision as of 11:29, 12 May 2024
Line 54:		Line 54:
	* '''Text''' ''string'': The text to display on the button.		* '''Text''' ''string'': The text to display on the button.
	* '''Color''' ''string'': The color of the button. Pass this as a string in #RRGGBB format. Only the following colors are supported for buttons:		* '''Color''' ''string'': The color of the button. Pass this as a string in #RRGGBB format. Only the following colors are supported for buttons:
	{{~~Color~~\|BABABC}} {{~~Color~~\|6C73D1}} {{~~Color~~\|FF00ED}} {{~~Color~~\|FFC200}} {{~~Color~~\|00A0FF}} {{~~Color~~\|00B5FF}} {{~~Color~~\|F3FFAE}} {{~~Color~~\|43C731}} {{~~Color~~\|43C631}} {{~~Color~~\|1274A4}} {{~~Color~~\|1274A5}} {{~~Color~~\|B03B3B}} {{~~Color~~\|0021FF}} {{~~Color~~\|359029}} {{~~Color~~\|00E9FF}} {{~~Color~~\|00FF21}} {{~~Color~~\|FFF700}} {{~~Color~~\|AA3A3A}} {{~~Color~~\|43C732}} {{~~Color~~\|00D4FF}} {{~~Color~~\|B03C3C}} {{~~Color~~\|00F4FF}} {{~~Color~~\|00BFFF}} {{~~Color~~\|4EC4FF}} {{~~Color~~\|615DDF}} {{~~Color~~\|100C08}} {{~~Color~~\|0000FF}} {{~~Color~~\|4EFFFF}} {{~~Color~~\|59009D}} {{~~Color~~\|008000}} {{~~Color~~\|FF7D00}} {{~~Color~~\|FF0000}} {{~~Color~~\|606060}} {{~~Color~~\|00FF05}} {{~~Color~~\|FF697A}} {{~~Color~~\|94652E}} {{~~Color~~\|00FF8C}} {{~~Color~~\|FF4700}} {{~~Color~~\|009B9D}} {{~~Color~~\|23A0FF}} {{~~Color~~\|AC0059}} {{~~Color~~\|FF87FF}} {{~~Color~~\|FFFF00}} {{~~Color~~\|943E3E}} {{~~Color~~\|FEFF9B}} {{~~Color~~\|AD7E7E}} {{~~Color~~\|B70AFF}} {{~~Color~~\|FFAF56}} {{~~Color~~\|FF00B1}} {{~~Color~~\|8EBE57}} {{~~Color~~\|DAA520}} {{~~Color~~\|990024}} {{~~Color~~\|00FFFF}} {{~~Color~~\|8F9779}} {{~~Color~~\|880085}} {{~~Color~~\|00755E}} {{~~Color~~\|FFE5B4}} {{~~Color~~\|4169E1}} {{~~Color~~\|FF43A4}} {{~~Color~~\|8DB600}} {{~~Color~~\|40826D}} {{~~Color~~\|C04000}} {{~~Color~~\|FFDDF4}} {{~~Color~~\|CD7F32}} {{~~Color~~\|C19A6B}} {{~~Color~~\|C09999}} {{~~Color~~\|B0BF1A}} {{~~Color~~\|3B7A57}} {{~~Color~~\|4B5320}} {{~~Color~~\|664C28}} {{~~Color~~\|893F45}} {{~~Color~~\|D2691E}} {{~~Color~~\|36454F}} {{~~Color~~\|FF00FF}} {{~~Color~~\|76FF7A}}		{{Color2\|BABABC}} {{Color2\|6C73D1}} {{Color2\|FF00ED}} {{Color2\|FFC200}} {{Color2\|00A0FF}} {{Color2\|00B5FF}} {{Color2\|F3FFAE}} {{Color2\|43C731}} {{Color2\|43C631}} {{Color2\|1274A4}} {{Color2\|1274A5}} {{Color2\|B03B3B}} {{Color2\|0021FF}} {{Color2\|359029}} {{Color2\|00E9FF}} {{Color2\|00FF21}} {{Color2\|FFF700}} {{Color2\|AA3A3A}} {{Color2\|43C732}} {{Color2\|00D4FF}} {{Color2\|B03C3C}} {{Color2\|00F4FF}} {{Color2\|00BFFF}} {{Color2\|4EC4FF}} {{Color2\|615DDF}} {{Color2\|100C08}} {{Color2\|0000FF}} {{Color2\|4EFFFF}} {{Color2\|59009D}} {{Color2\|008000}} {{Color2\|FF7D00}} {{Color2\|FF0000}} {{Color2\|606060}} {{Color2\|00FF05}} {{Color2\|FF697A}} {{Color2\|94652E}} {{Color2\|00FF8C}} {{Color2\|FF4700}} {{Color2\|009B9D}} {{Color2\|23A0FF}} {{Color2\|AC0059}} {{Color2\|FF87FF}} {{Color2\|FFFF00}} {{Color2\|943E3E}} {{Color2\|FEFF9B}} {{Color2\|AD7E7E}} {{Color2\|B70AFF}} {{Color2\|FFAF56}} {{Color2\|FF00B1}} {{Color2\|8EBE57}} {{Color2\|DAA520}} {{Color2\|990024}} {{Color2\|00FFFF}} {{Color2\|8F9779}} {{Color2\|880085}} {{Color2\|00755E}} {{Color2\|FFE5B4}} {{Color2\|4169E1}} {{Color2\|FF43A4}} {{Color2\|8DB600}} {{Color2\|40826D}} {{Color2\|C04000}} {{Color2\|FFDDF4}} {{Color2\|CD7F32}} {{Color2\|C19A6B}} {{Color2\|C09999}} {{Color2\|B0BF1A}} {{Color2\|3B7A57}} {{Color2\|4B5320}} {{Color2\|664C28}} {{Color2\|893F45}} {{Color2\|D2691E}} {{Color2\|36454F}} {{Color2\|FF00FF}} {{Color2\|76FF7A}}
	* '''TextColor''' ''string'': The color of the text on the button. Pass this as a string in #RRGGBB format.		* '''TextColor''' ''string'': The color of the text on the 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.		* '''OnClick''' ''function'': Pass the name of a lua function to be called whenever the player clicks the button.

DanWL60: /* Helper Functions */

2024-02-18T10:22:43Z

Helper Functions

← Older revision		Revision as of 10:22, 18 February 2024
Line 91:		Line 91:


	'''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.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>. Only one mod can use this at a time.


Line 106:		Line 106:
	* '''Callback''' ''function'': Pass a function that will be called on the next click. This function will be passed a [[Mod_API_Reference:BonusDetails\|BonusDetails]] object, which can be used to get the bonus ID or the name of the bonus that was clicked. This function can also be called with nil if the intercept request is cancelled, which can happen if another mod calls UI.InterceptNextBonusLinkClick before a bonus link is clicked. If you want to cancel the intercept request, you can return WL.CancelClickIntercept from the callback which will make the client behave as if you never called intercept. Return nil, or leave off the return statement entirely, for normal operation.		* '''Callback''' ''function'': Pass a function that will be called on the next click. This function will be passed a [[Mod_API_Reference:BonusDetails\|BonusDetails]] object, which can be used to get the bonus ID or the name of the bonus that was clicked. This function can also be called with nil if the intercept request is cancelled, which can happen if another mod calls UI.InterceptNextBonusLinkClick before a bonus link is clicked. If you want to cancel the intercept request, you can return WL.CancelClickIntercept from the callback which will make the client behave as if you never called intercept. Return nil, or leave off the return statement entirely, for normal operation.


	~~InterceptNextTerritoryClick~~
	[[Category:Mod API Reference]]		[[Category:Mod API Reference]]