UI (functions)/Multiplayer
This page documents the ScriptUI class for Lua scripting.
As a singleton class, it can be accessed from Lua with UI.
ServersMenu
UI:ServersMenu()
Displays the Servers menu.
ContactsMenu
UI:ContactsMenu()
Displays the contacts menu.
SOSMenu
UI:SOSMenu()
Displays the SOS menu.
AOKMenu
UI:AOKMenu()
Displays the AOK menu.
PeersMenu
UI:PeersMenu()
Displays the Peers menu.
ShowConnectMenu
UI:ShowConnectMenu()
Displays the connection menu.
CurrentActivityMenu
UI:CurrentActivityMenu()
Displays the current activity of the connected peer.
ChooseMonsterMenu
UI:ChooseMonsterMenu(title, choices, canMenu, canCancel, slotsPerPage)
Marks the start of a choice menu for choosing monsters, showing a preview of their appearances via portrait.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to retrieve the string indicating the chosen species, UI:ChoiceResult() must be called.
Parameters
| Name | Type | Description |
|---|---|---|
| System.String | System.String | The title of the menu |
| NLua.LuaTable | NLua.LuaTable | A lua table of choices with each element being a MonsterID. |
| System.Boolean | System.Boolean | If set to true, the Menu Button exits the menu if pressed. |
| System.Boolean | System.Boolean | If set to true, the Cancel Button exits the menu if pressed. |
| System.Int32 | System.Int32 | Slots to display per page |
References
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Lua/ScriptUIMultiplayer.cs
