Menu Editing

This article is a stub. You can help the My Singing Monsters Modding Wiki by expanding it.

This article discusses information on modding at an intermediate level. Please only edit this article if you have a good understanding of the featured material.

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)

---

game.AnimateRecordButton

---

game.Awakener_GetClosedAnim

---

game.ContextBar_cancelButton

---

game.ContextBar_confirmButton

---

game.ContextBar_marketEnterButton

---

game.ContextBar_marketExitButton

---

game.ContextBar_mobileToPcMappingButton

---

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

---

game.popPopUp()

This function closes the current menu on the screen.

---

game.pushPopUp()

This function opens almost any xml file found in the 'menus' folder. Usage: game.pushPopUp("filename").

---

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.

---

game.showWebView()

This function opens a specified link. Usage: game.showWebView("yourlink")

---

game.loadWorldContext()

This function re-loads your Island after visiting certain menus.

---

game.setMonsterVolume()

This function sets the selected Monster's volume. Usage: game.setMonsterVolume("number")

---

game.is<b>X</b>Island()

game.is<b>Plant</b>Island()

game.is<b>Cold</b>Island()

game.is<b>Air</b>Island()

game.is<b>Water</b>Island()

game.is<b>Earth</b>Island()

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.

---

game.logout()

This function logs the user out of their account.