Class RegisterDebugEntriesEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterDebugEntriesEvent

All Implemented Interfaces:

IModBusEvent

public final class RegisterDebugEntriesEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Event fired when debug entries are registered.

This event is fired during the DebugScreenEntries initialization to allow registration of custom entries.

Existing entries cannot be modified or amended directly. However new lines can be appended to existing groups, such as the "System Specs", by using DebugScreenDisplayer.addToGroup(Identifier, java.lang.String).

This event is fired on the mod event bus.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<Identifier, DebugScreenEntryStatus>	defaultProfile
private final Map<Identifier, DebugScreenEntry>	entries
private final Map<Identifier, DebugScreenEntryStatus>	performanceProfile

Constructor Summary

Constructors

Constructor	Description
RegisterDebugEntriesEvent(Map<Identifier, DebugScreenEntry> entries, Map<Identifier, DebugScreenEntryStatus> defaultProfile, Map<Identifier, DebugScreenEntryStatus> performanceProfile)

Method Summary

Modifier and Type	Method	Description
private Map<Identifier, DebugScreenEntryStatus>	getProfileMap(DebugScreenProfile profile)
void	includeInProfile(Identifier id, DebugScreenProfile profile, DebugScreenEntryStatus profileStatus)	Includes the entry into the given profile.
boolean	isIncludedInProfile(Identifier id, DebugScreenProfile profile)	Returns true if the entry is included into the given profile.
boolean	isRegistered(Identifier id)	Returns true if the given entry id has been registered.
void	register(Identifier id, DebugScreenEntry entry)	Registers a new DebugScreenEntry to allow it to be used for debug rendering and state toggling.
private @Nullable IllegalStateException	validateProfile(DebugScreenProfile profile)
Map<DebugScreenProfile, Map<Identifier, DebugScreenEntryStatus>>	validateProfiles()

Methods inherited from class Object

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

Field Details

entries

private final Map<Identifier, DebugScreenEntry> entries

defaultProfile

private final Map<Identifier, DebugScreenEntryStatus> defaultProfile

performanceProfile

private final Map<Identifier, DebugScreenEntryStatus> performanceProfile

Constructor Details

RegisterDebugEntriesEvent

@Internal
public RegisterDebugEntriesEvent(Map<Identifier, DebugScreenEntry> entries,
 Map<Identifier, DebugScreenEntryStatus> defaultProfile,
 Map<Identifier, DebugScreenEntryStatus> performanceProfile)

Method Details

register

public void register(Identifier id,
 DebugScreenEntry entry)

Registers a new DebugScreenEntry to allow it to be used for debug rendering and state toggling.

Parameters:

id - Registration ID for this entry.

entry - Screen entry to be registered.

isRegistered

public boolean isRegistered(Identifier id)

Returns true if the given entry id has been registered.

Returns:

true if the given entry id has been registered

includeInProfile

public void includeInProfile(Identifier id,
 DebugScreenProfile profile,
 DebugScreenEntryStatus profileStatus)

Includes the entry into the given profile.

Parameters:

id - Registration ID for this entry.

profile - Debug profile this entry will be included with.

profileStatus - Status this entry will be set to when the profile is enabled.

isIncludedInProfile

public boolean isIncludedInProfile(Identifier id,
 DebugScreenProfile profile)

Returns true if the entry is included into the given profile.

Returns:

true if the entry is included into the given profile

getProfileMap

private Map<Identifier, DebugScreenEntryStatus> getProfileMap(DebugScreenProfile profile)

validateProfiles

@Internal
public Map<DebugScreenProfile, Map<Identifier, DebugScreenEntryStatus>> validateProfiles()

validateProfile

private @Nullable IllegalStateException validateProfile(DebugScreenProfile profile)