|
|
|
{{Template:Stub}} |
|
{{Template:Stub}} |
|
[[File:Menu Editing Example.png|thumb|An example menu edit]] |
|
|
'''Menu Editing''' is a form of modding which consists of Lua and XML file menu editing. The following article will help you understand more about this topic. |
|
|
|
|
|
==Functions== |
|
|
'''Functions''' are short strings of code that hold data and are used internally to cause something inside of the game to happen. |
|
|
|
|
|
This section lists all functions that you can find and use inside of the menu XML files, sorted by internal order. |
|
|
|
|
|
game.AcceptTermsOfService |
|
|
This function checks if you have accepted the Terms of Service or not. Usage: '''game.AcceptTermsOfService(true)''' |
|
|
<hr> |
|
|
game.AnimateRecordButton |
|
|
<hr> |
|
|
game.Awakener_GetClosedAnim |
|
|
<hr> |
|
|
game.ContextBar_cancelButton |
|
|
<hr> |
|
|
game.ContextBar_confirmButton |
|
|
<hr> |
|
|
game.ContextBar_marketEnterButton |
|
|
<hr> |
|
|
game.ContextBar_marketExitButton |
|
|
<hr> |
|
|
game.ContextBar_mobileToPcMappingButton |
|
|
<hr> |
|
|
game.EnableRecordButton |
|
|
This function enables and disables the record button. It can also be called to check if the record button is enabled. Usage: '''game.EnableRecordButton''' - '''if (game.EnableRecordButton()) then''' |
|
|
<hr> |
|
|
game.popPopUp() |
|
|
This function closes the current menu on the screen. |
|
|
<hr> |
|
|
game.pushPopUp() |
|
|
This function opens almost any xml file found in the 'menus' folder. Usage: '''game.pushPopUp("filename")'''. |
|
|
<hr> |
|
|
game.displayNotification() |
|
|
This function displays a "Listen Up!" notification, with text that you can customize. Usage: '''game.displayNotification("your message")'''. To make line breaks, you have to enter a large amount of empty characters/spaces, and then put text after it. |
|
|
<hr> |
|
|
game.showWebView() |
|
|
This function opens a specified link. Usage: '''game.showWebView("yourlink")''' |
|
|
<hr> |
|
|
game.loadWorldContext() |
|
|
This function re-loads your Island after visiting certain menus. |
|
|
<hr> |
|
|
game.setMonsterVolume() |
|
|
This function sets the selected Monster's volume. Usage: '''game.setMonsterVolume("number")''' |
|
|
<hr> |
|
|
<tabber> |
|
|
|-|Template= |
|
|
<pre>game.is<b>X</b>Island()</pre> |
|
|
|-|Plant Island= |
|
|
<pre>game.is<b>Plant</b>Island()</pre> |
|
|
|-|Cold Island= |
|
|
<pre>game.is<b>Cold</b>Island()</pre> |
|
|
|-|Air Island= |
|
|
<pre>game.is<b>Air</b>Island()</pre> |
|
|
|-|Water Island= |
|
|
<pre>game.is<b>Water</b>Island()</pre> |
|
|
|-|Earth Island= |
|
|
<pre>game.is<b>Earth</b>Island()</pre> |
|
|
</tabber> |
|
|
This function calls something to happen/appear if you are on a certain Island. Usage: '''if game.isXIsland() then''' followed by what you want to happen. To use this function, replace the "X" in the above example to specify an Island. |
|
|
<br> |
|
|
<hr> |
|
|
game.logout() |
|
|
This function logs the user out of their account. |
|