Class MultiversionUi.Registration

java.lang.Object

dev.xichil.mvui.MultiversionUi.Registration

Enclosing class:

MultiversionUi

public static final class MultiversionUi.Registration
extends Object

One successful MultiversionUi.register(String, Text, ScreenFactory) call: a mod id, its display name and its guarded menu. Immutable. Obtained from MultiversionUi.menus(); mods don't create these.

Method Summary

Modifier and Type	Method	Description
ScreenFactory	menu()	The menu, wrapped by Failsafe: not the object the mod passed, but one that delegates to it and turns only this mod's menu off when the mod's code fails.
String	modId()	The id of the mod that registered the menu, as passed to MultiversionUi.register(String, Text, ScreenFactory).
Text	name()	What the list of mod menus shows for this mod: the name passed to MultiversionUi.register(String, Text, ScreenFactory).
String	toString()	The mod id.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

modId

public String modId()

The id of the mod that registered the menu, as passed to MultiversionUi.register(String, Text, ScreenFactory).

Returns:

the registering mod's id

name

public Text name()

What the list of mod menus shows for this mod: the name passed to MultiversionUi.register(String, Text, ScreenFactory).

Returns:

the text shown for this mod in the list of mod menus

menu

public ScreenFactory menu()

The menu, wrapped by Failsafe: not the object the mod passed, but one that delegates to it and turns only this mod's menu off when the mod's code fails.

Returns:

the wrapped menu factory, which turns only this mod's menu off when the mod's code fails

toString

public String toString()

The mod id.

Overrides:

toString in class Object