Tutorial:Editing Menus - Revision history

Imbion: Imbion moved page Editing Menus to Tutorial:Editing Menus

2025-10-26T15:11:47Z

Imbion moved page Editing Menus to Tutorial:Editing Menus

← Older revision	Revision as of 15:11, 26 October 2025
(No difference)

Imbion at 17:44, 13 August 2025

2025-08-13T17:44:30Z

← Older revision		Revision as of 17:44, 13 August 2025
Line 47:		Line 47:

	This process can be applied to any menu that has a label. The only exception is SettingsMenu, that has [[Adding new Settings\|its own page]] describing how to interact with it.		This process can be applied to any menu that has a label. The only exception is SettingsMenu, that has [[Adding new Settings\|its own page]] describing how to interact with it.
			[[Category:Modding]]

MistressNebula: Connect to service tutorial pages

2025-03-13T15:55:41Z

Connect to service tutorial pages

← Older revision		Revision as of 15:55, 13 March 2025
Line 1:		Line 1:
	<small>''This guide does not apply to the [[Adding new Settings\|Settings Menu]]. Please refer to its specific page if that's what you are looking for.''</small>		<small>''This guide does not apply to the [[Adding new Settings\|Settings Menu]]. Please refer to its specific page if that's what you are looking for.''</small>

	As of 0.8.3, a new service callback has been added to the game, called [[Service ~~Callbacks~~#AddMenu\|AddMenu]]. This callback can be used by modders to edit menus on the fly right before they appear on screen. This guide exists as a way to explain how this callback works and how to use it.		As of 0.8.3, a new service callback has been added to the game, called [[Service Events#EngineServiceEvents.AddMenu\|AddMenu]]. This callback can be used by modders to edit menus on the fly right before they appear on screen. This guide exists as a way to explain how this callback works and how to use it.

	== Prerequisites ==		== Prerequisites ==
	This guide assumes that the user is capable of writing [[~~Service Callbacks\|~~Services]] and [[Creating Menus]]. Please refer to these pages if anything is unclear.		This guide assumes that the user is capable of writing [[Services]] and [[Creating Menus]]. Please refer to these pages if anything is unclear.
	The user is also expected to be able to navigate the RogueEssence repository, specifically looking into its [https://github.com/RogueCollab/RogueEssence/tree/master/RogueEssence/Menu Menu] folder and its subfolders.		The user is also expected to be able to navigate the RogueEssence repository, specifically looking into its [https://github.com/RogueCollab/RogueEssence/tree/master/RogueEssence/Menu Menu] folder and its subfolders.

MistressNebula: Account for new way to check labels

2025-03-13T13:04:24Z

Account for new way to check labels

← Older revision		Revision as of 13:04, 13 March 2025
Line 9:		Line 9:
	With the advent of 0.8.3, the callback AddMenu has been added to the game. This message is sent to services just before a menu is displayed so that modders can add, remove or modify its elements at their heart's content. What can be edited and how depends on the menu itself. Feel free to check the [[Menu Editing Reference]] page if you ever need more details on a specific function.		With the advent of 0.8.3, the callback AddMenu has been added to the game. This message is sent to services just before a menu is displayed so that modders can add, remove or modify its elements at their heart's content. What can be edited and how depends on the menu itself. Feel free to check the [[Menu Editing Reference]] page if you ever need more details on a specific function.

	There are three broader types of Menus. Each of them has one Scriptable counterpart and they are [[Menu Editing Reference#InteractableMenu\|InteractableMenu]], [[Menu Editing Reference#ChoiceMenu\|ChoiceMenu]] and [[Menu Editing Reference#MultiPageMenu\|MultiPageMenu]]. Being able to differentiate between them is key to know how to interact with the menu you're looking to edit. Furthermore, we will need the menu's Label. A Label is a string property that serves to identify a menu. Lucky for us, the game already gives us everything we need to know~~: if a menu has a label, its Menu Type~~ and ~~its Label will be displayed in~~ the ~~dev mode's output console every time you open it. So~~.~~.. let's check it out!~~ Here's ~~what happens when we open~~ the OthersMenu, for example:		There are three broader types of Menus. Each of them has one Scriptable counterpart and they are [[Menu Editing Reference#InteractableMenu\|InteractableMenu]], [[Menu Editing Reference#ChoiceMenu\|ChoiceMenu]] and [[Menu Editing Reference#MultiPageMenu\|MultiPageMenu]]. Being able to differentiate between them is key to know how to interact with the menu you're looking to edit. Furthermore, we will need the menu's Label. A Label is a string property that serves to identify a menu. Lucky for us, the game already gives us everything we need to know by just opening the F1 overlay and hovering over the menu itself with your mouse. Here's the OthersMenu, for example:

	[[File:~~OthersLabel~~.png~~\|link=~~]]		[[File:LabelDisplay.png]]

	This is already everything we need. We can now start working on our changes.		This is already everything we need. We can now start working on our changes.
Line 40:		Line 40:

	Now that we know that this is the right menu, we want to add our new option just above Settings. Since menu elements can also have labels, we ask the menu for the index of its OTH_SETTINGS option and save that value. The function then checks if the number is valid, and defaults to slot 1 if it isn't, or even 0 if the menu is empty for some reason.		Now that we know that this is the right menu, we want to add our new option just above Settings. Since menu elements can also have labels, we ask the menu for the index of its OTH_SETTINGS option and save that value. The function then checks if the number is valid, and defaults to slot 1 if it isn't, or even 0 if the menu is empty for some reason.
	If you ever need a label, you can look them up inside of the [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ILabeled.cs ILabeled.cs] file.		If you ever need an option's label, you can either hover it while displaying the F1 overlay or look them up inside of the [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ILabeled.cs ILabeled.cs] file.

	Finally, we apply the change: We first export the current list of choices, then add our new MenuTextChoice in the spot we chose and then load our edited list using ImportChoices.		Finally, we apply the change: We first export the current list of choices, then add our new MenuTextChoice in the spot we chose and then load our edited list using ImportChoices.

MistressNebula: Split from function reference

2024-08-26T18:43:54Z

Split from function reference

Show changes

MistressNebula: Final edits

2024-08-26T09:54:41Z

Final edits

← Older revision		Revision as of 09:54, 26 August 2024
Line 13:		Line 13:
	There are three broader types of Menus. Each of them has one Scriptable counterpart and they are [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/InteractableMenu.cs InteractableMenu], [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ChoiceMenu.cs ChoiceMenu] and [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/MultiPageMenu.cs MultiPageMenu]. Being able to differentiate between them is the key to know how to interact with the menu you're looking to edit. Furthermore, we will need the menu's Label. A Label is a little string property that serves to identify a menu. Lucky for us, the game already guves us everything we need to know: if a menu has a label, its Menu Type and its Label will be displayed in the dev mode's output console every time you open it. So... let's check it out! Here's what happens when we open the OthersMenu, for example:		There are three broader types of Menus. Each of them has one Scriptable counterpart and they are [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/InteractableMenu.cs InteractableMenu], [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ChoiceMenu.cs ChoiceMenu] and [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/MultiPageMenu.cs MultiPageMenu]. Being able to differentiate between them is the key to know how to interact with the menu you're looking to edit. Furthermore, we will need the menu's Label. A Label is a little string property that serves to identify a menu. Lucky for us, the game already guves us everything we need to know: if a menu has a label, its Menu Type and its Label will be displayed in the dev mode's output console every time you open it. So... let's check it out! Here's what happens when we open the OthersMenu, for example:

	[[File:~~Others_label~~.png]]		[[File:OthersLabel.png\|link=]]

	This is already everything we need. We can now start working on our changes.		This is already everything we need. We can now start working on our changes.
Line 37:		Line 37:
	</pre>		</pre>

	Now, what does this all mean?		Now, what does this all mean? Let's analyze it one step at a time.
	Let's analyze it one step at a time.		First things first, this new option must only appear while inside a dungeon, so the first part of the if statement makes sure that's the case. We must then check if the menu that has been opened has a label, and, if it does, check if it's the label we're looking for.
	First things first, this new option must only appear while inside a dungeon, so ~~that's what~~ the first part of the if statement ~~does~~. We must then check if the menu that has been opened has a label, and, if it does, check if it's the label we're looking for.

	Now that we know this is the right menu, we want to add our new option just above Settings. Since menu elements can also have labels, we ask the menu for the index of its OTH_SETTINGS option and save that value. The function then checks if the number is valid, and defaults to slot 1 if it isn't, or even 0 if the menu is empty for some reason.		Now that we know that this is the right menu, we want to add our new option just above Settings. Since menu elements can also have labels, we ask the menu for the index of its OTH_SETTINGS option and save that value. The function then checks if the number is valid, and defaults to slot 1 if it isn't, or even 0 if the menu is empty for some reason.
			If you need a label, you can look them up inside of the [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ILabeled.cs ILabeled.cs] file.

	Finally, we apply the change: We first export the current list of choices, then add our new MenuTextChoice in ~~that~~ spot and then load our edited ~~Choice~~ using ImportChoices.		Finally, we apply the change: We first export the current list of choices, then add our new MenuTextChoice in the spot we chose and then load our edited list using ImportChoices.

	== Functions ==		== Functions ==
	Now that we know how editing a menu looks like, it's time to explore all the tools offered by the engine ~~to help modders~~.		Now that we know how editing a menu looks like, it's time to explore all the tools offered by the engine.

	=== ILabeled ===		=== ILabeled ===
Line 211:		Line 211:
	====== Arguments ======		====== Arguments ======
	* <code>choices</code>: a list of IChoosable elements.		* <code>choices</code>: a list of IChoosable elements.


	~~''This article is currently waiting for the changes described to be released. The console screenshot also needs to be changed''~~

MistressNebula: Added TOC limit + small changes

2024-08-25T15:37:53Z

Added TOC limit + small changes

← Older revision		Revision as of 15:37, 25 August 2024
Line 2:		Line 2:

	As of 0.8.3, a new service callback has been added to the game, called AddMenu. This callback can be used by modders to edit menus on the fly right before they appear on screen. This guide exists as a way to explain how this callback works and how to use it.		As of 0.8.3, a new service callback has been added to the game, called AddMenu. This callback can be used by modders to edit menus on the fly right before they appear on screen. This guide exists as a way to explain how this callback works and how to use it.
			{\|limit=3
			\|__TOC__
			\|}
	== Prerequisites ==		== Prerequisites ==
	This guide assumes that the user is capable of writing [[Service Callbacks\|Services]] and [[Creating Menus]]. Please refer to these pages if anything is unclear.		This guide assumes that the user is capable of writing [[Service Callbacks\|Services]] and [[Creating Menus]]. Please refer to these pages if anything is unclear.
Line 64:		Line 66:
	===== Arguments =====		===== Arguments =====
	* <code>substr</code>: the string to look for.		* <code>substr</code>: the string to look for.



Line 115:		Line 118:
	====== Arguments ======		====== Arguments ======
	* <code>labels</code> one or more labels or, alternatively, an array of labels to look for.		* <code>labels</code> one or more labels or, alternatively, an array of labels to look for.



Line 185:		Line 189:
	====== Arguments ======		====== Arguments ======
	* <code>labels</code> one or more labels or, alternatively, an array of labels to look for.		* <code>labels</code> one or more labels or, alternatively, an array of labels to look for.



Line 208:		Line 213:


	''This article is currently ~~waitin g~~ for the changes described to ne released. The console screenshot also needs to be changed''		''This article is currently waiting for the changes described to be released. The console screenshot also needs to be changed''

MistressNebula: Update example

2024-08-10T11:55:08Z

Update example

← Older revision		Revision as of 11:55, 10 August 2024
Line 7:		Line 7:
	The user is also expected to be able to navigate the RogueEssence repository, specifically looking into its [https://github.com/RogueCollab/RogueEssence/tree/master/RogueEssence/Menu Menu] folder and its subfolders.		The user is also expected to be able to navigate the RogueEssence repository, specifically looking into its [https://github.com/RogueCollab/RogueEssence/tree/master/RogueEssence/Menu Menu] folder and its subfolders.

	~~=== Preparations ===~~		With the advent of 0.8.3, the callback AddMenu has been added to the game. This message is sent to services just before a menu is displayed so that modders can add, remove or modify its elements at their heart's content. What can be edited and how depends on the menu itself.
	With the advent of 0.8.3, the callback AddMenu has been added to the game. This message is sent to services just before a menu is displayed so that modders can add, remove or modify its ~~content~~ at their heart's content. What can be edited depends on the menu itself.

	There are three broader types of Menus. Each of them has one Scriptable counterpart and they are [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/InteractableMenu.cs InteractableMenu], [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ChoiceMenu.cs ChoiceMenu] and [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/MultiPageMenu.cs MultiPageMenu]. Being able to differentiate between them is the key to know how to interact with the menu you're looking to edit. Furthermore, we will need ~~its~~ Label. A Label is a little string property that serves to identify a menu. Lucky for us, the game already guves us everything we need to know: if a menu has a label, its Menu Type and its Label will be displayed in the dev mode's output console every time you open it. So... let's ~~do that~~! Here's what happens when we open the OthersMenu, for example:		There are three broader types of Menus. Each of them has one Scriptable counterpart and they are [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/InteractableMenu.cs InteractableMenu], [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/ChoiceMenu.cs ChoiceMenu] and [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Menu/MultiPageMenu.cs MultiPageMenu]. Being able to differentiate between them is the key to know how to interact with the menu you're looking to edit. Furthermore, we will need the menu's Label. A Label is a little string property that serves to identify a menu. Lucky for us, the game already guves us everything we need to know: if a menu has a label, its Menu Type and its Label will be displayed in the dev mode's output console every time you open it. So... let's check it out! Here's what happens when we open the OthersMenu, for example:

	[[File:Others_label.png]]		[[File:Others_label.png]]

	~~Great! Now~~ we ~~have all the pieces necessary to~~ start working on our changes.		This is already everything we need. We can now start working on our changes.

	== How to edit a menu ==		== How to edit a menu ==
Line 29:		Line 28:
	local index = menu:GetChoiceIndexByLabel("OTH_SETTINGS")		local index = menu:GetChoiceIndexByLabel("OTH_SETTINGS")
	if index <0 then index = math.min(1, menu.Choices.Count) end		if index <0 then index = math.min(1, menu.Choices.Count) end
	menu~~.Choices~~:Insert(index, RogueEssence.Menu.MenuTextChoice("OTH_RECRUIT",		local choices = menu:ExportChoices()
	RogueEssence.StringKey("MENU_RECRUITMENT"):ToLocal(),		choices:Insert(index, RogueEssence.Menu.MenuTextChoice("OTH_RECRUIT", RogueEssence.StringKey("MENU_RECRUITMENT"):ToLocal(), function () _MENU:AddMenu(RecruitmentListMenu:new().menu, false) end))
	function () _MENU:AddMenu(RecruitmentListMenu:new().menu, false) end))		menu:ImportChoices(choices)
	menu:~~InitMenu~~()
	end		end
	end		end
Line 42:		Line 40:

	Now that we know this is the right menu, we want to add our new option just above Settings. Since menu elements can also have labels, we ask the menu for the index of its OTH_SETTINGS option and save that value. The function then checks if the number is valid, and defaults to slot 1 if it isn't, or even 0 if the menu is empty for some reason.		Now that we know this is the right menu, we want to add our new option just above Settings. Since menu elements can also have labels, we ask the menu for the index of its OTH_SETTINGS option and save that value. The function then checks if the number is valid, and defaults to slot 1 if it isn't, or even 0 if the menu is empty for some reason.
	Finally, we add our new MenuTextChoice in that spot and ~~reload the~~ Choice ~~list by calling InitMenu~~.
			Finally, we apply the change: We first export the current list of choices, then add our new MenuTextChoice in that spot and then load our edited Choice using ImportChoices.

	== Functions ==		== Functions ==

MistressNebula: MultiPageMenu and Settings Menu disclaimer

2024-08-10T11:31:30Z

MultiPageMenu and Settings Menu disclaimer

@@ Line 1: / Line 1: @@
 As of 0.8.3, a new service callback has been added to the game, called AddMenu. This callback can be used by modders to edit menus on the fly right before they appear on screen. This guide exists as a way to explain how this callback works and how to use it.
@@ Line 119: / Line 121: @@
 === ChoiceMenu ===
 Any menu that has a list of choices to select from is a ChoiceMenu, and will have all these properties and methods plus those described in the ILabeled, MenuBase and InteractableMenu sections.
 ==== ChoiceMenu.Choices ====
@@ Line 186: / Line 189: @@
-''This article is still work in progress''
+=== MultiPageMenu ===

MistressNebula: /* ChoiceMenu.InitMenu() */ remove completely

2024-08-10T09:59:29Z

ChoiceMenu.InitMenu(): remove completely

← Older revision		Revision as of 09:59, 10 August 2024
Line 183:		Line 183:
	====== Arguments ======		====== Arguments ======
	* <code>labels</code> one or more labels or, alternatively, an array of labels to look for.		* <code>labels</code> one or more labels or, alternatively, an array of labels to look for.



	~~==== ChoiceMenu.InitMenu() ====~~
	~~It's not uncommon for ChoiceMenus to not update the displayed choice list automatically. When this happens, call this method and it'll start showing your changes.~~



	''This article is still work in progress''		''This article is still work in progress''