UI

UI label functions.

Functions

Function	Returns	Description
SetLabel(type: string, label: string)	null	Sets the label at a certain location. Valid types: "TopCenter", "TopLeft", "TopRight", "MiddleCenter", "MiddleLeft", "MiddleRight", "BottomLeft", "BottomRight", "BottomCenter".
SetLabelForTime(type: string, label: string, time: float)	null	Sets the label for a certain time, after which it will be cleared.
SetLabelAll(type: string, label: string)	null	Sets the label for all players. Master client only. Be careful not to call this often.
SetLabelForTimeAll(type: string, label: string, time: float)	null	Sets the label for all players for a certain time. Master client only.
CreatePopup(name: string, title: string, width: int, height: int)	null	Creates a new popup. This popup is hidden until shown.
ShowPopup(name: string)	null	Shows the popup with given name.
HidePopup(name: string)	null	Hides the popup with given name.
ClearPopup(name: string)	null	Clears all elements in popup with given name.
IsPopupActive(name: string)	bool	Is the popup active.
GetPopups()	List(string)	Returns a list of all created popup names.
AddPopupLabel(name: string, label: string)	null	Adds a text row to the popup with label as content.
AddPopupButton(popupName: string, buttonName: string, buttonText: string)	null	Adds a button row to the popup with given button name and display text. When button is pressed, OnButtonClick is called in Main with buttonName parameter.
AddPopupButtons(popupName: string, buttonNames: List, buttonTitles: List)	null	Adds a list of buttons in a row to the popup.
AddPopupBottomButton(popupName: string, buttonName: string, buttonText: string)	null	Adds a button to the bottom bar of the popup.
WrapStyleTag(text: string, style: string, args: string)	string	Returns a wrapped string given style and args.
GetLocale(category: string, subcategory: string, key: string)	string	Gets translated locale from the current Language.json file with given category, subcategory, and key pattern.
GetLanguage()	string	Returns the current language (ie "English).
ShowChangeCharacterMenu()	null	Shows the change character menu if main character is Human.
SetScoreboardHeader(header: string)	null	Sets the display of the scoreboard header (default "Kills / Deaths...")
SetScoreboardProperty(property: string)	null	Sets which Player custom property to read from to display on the scoreboard. If set to empty string, will use the default "Kills / Deaths..." display.
GetThemeColor(panel : string, category : string, item : string)	Color	Gets the color of the specified item. See theme json for reference.