Class BlankModDisplayInfo

java.lang.Object

net.neoforged.neoforge.client.gui.modlist.BlankModDisplayInfo

All Implemented Interfaces:

IExtensionPoint, ModDisplayInfo

final class BlankModDisplayInfo
extends Object
implements ModDisplayInfo

A blank mod display info.

Field Summary

Fields

Modifier and Type	Field	Description
static final BlankModDisplayInfo	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlankModDisplayInfo()

Method Summary

Modifier and Type	Method	Description
Component	authors()	Returns the mod authors.
@Nullable ImageResource	banner()	Returns the banner displayed in the info panel, or null.
Component	credits()	Returns the credits.
Component	description()	Returns the mod description.
Component	displayName()	Returns the display name.
@Nullable URI	displayUrl()	Returns the URL for the mod homepage, or null.
@Nullable ImageResource	icon()	Returns the icon displayed in the mod list, or null.
String	id()	Returns the mod ID.
@Nullable URI	issuesUrl()	Returns the URL for the mod issues page, or null.
Component	license()	Returns the mod license.
String	version()	Returns the mod version.

Methods inherited from class Object

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

Methods inherited from interface ModDisplayInfo

iconBlur

Field Details

INSTANCE

public static final BlankModDisplayInfo INSTANCE

Constructor Details

BlankModDisplayInfo

private BlankModDisplayInfo()

Method Details

id

public String id()

Description copied from interface: ModDisplayInfo

Returns the mod ID. This is used to retrieve the mod container, configuration screen extension point, and other relevant information.

Specified by:

id in interface ModDisplayInfo

Returns:

the mod ID

displayName

public Component displayName()

Description copied from interface: ModDisplayInfo

Returns the display name. This is always displayed, even if empty. Click actions do not work on this component.

Specified by:

displayName in interface ModDisplayInfo

Returns:

the display name

version

public String version()

Description copied from interface: ModDisplayInfo

Returns the mod version. This is always displayed, even if empty.

Specified by:

version in interface ModDisplayInfo

Returns:

the mod version

authors

public Component authors()

Description copied from interface: ModDisplayInfo

Returns the mod authors. This is displayed if it is not an empty component.

Specified by:

authors in interface ModDisplayInfo

Returns:

the mod authors

credits

public Component credits()

Description copied from interface: ModDisplayInfo

Returns the credits. This is displayed if it is not an empty component.

Specified by:

credits in interface ModDisplayInfo

Returns:

the credits

description

public Component description()

Description copied from interface: ModDisplayInfo

Returns the mod description. This is displayed if it is not an empty component.

Specified by:

description in interface ModDisplayInfo

Returns:

the mod description

license

public Component license()

Description copied from interface: ModDisplayInfo

Returns the mod license. This is always displayed, even if empty.

Specified by:

license in interface ModDisplayInfo

Returns:

the mod license

banner

public @Nullable ImageResource banner()

Description copied from interface: ModDisplayInfo

Returns the banner displayed in the info panel, or null.

The banner is rendered with its original aspect ratio, bounded by the width of the info panel (ordinarily 250 pixels) and a maximum height of 50 pixels.

Specified by:

banner in interface ModDisplayInfo

Returns:

the banner displayed in the info panel, or null

icon

public @Nullable ImageResource icon()

Description copied from interface: ModDisplayInfo

Returns the icon displayed in the mod list, or null.

The icon is rendered as a square with sides of 24 pixels.

Specified by:

icon in interface ModDisplayInfo

Returns:

the icon displayed in the mod list, or null

displayUrl

public @Nullable URI displayUrl()

Description copied from interface: ModDisplayInfo

Returns the URL for the mod homepage, or null. If null, the homepage button is disabled.

Specified by:

displayUrl in interface ModDisplayInfo

Returns:

the URL for the mod homepage, or null

issuesUrl

public @Nullable URI issuesUrl()

Description copied from interface: ModDisplayInfo

Returns the URL for the mod issues page, or null. If null, the issues page button is disabled.

Specified by:

issuesUrl in interface ModDisplayInfo

Returns:

the URL for the mod issues page, or null