Package dev.jaxydog.astral.register

Class ContentRegistrar

java.lang.Object

dev.jaxydog.astral.register.ContentRegistrar

All Implemented Interfaces:

Registered, Registered.All, Registered.Client, Registered.Common, Registered.Generated, Registered.Server

Direct Known Subclasses:

AstralActions, AstralBlocks, AstralConditions, AstralData, AstralDataLoaders, AstralGamerules, AstralItemGroups, AstralItems, AstralPotions, AstralPowers, AstralSoundEvents, AstralStatusEffects, AstralTrinketPredicates, CustomContent

public abstract class ContentRegistrar
extends Object
implements Registered.All, Registered.Generated

Implements the automatic registration system for extending classes.

Extending classes should typically be final and only contain subclasses or public static final fields. They should be singletons with their only instance being placed within the CustomContent class.

Since:

1.5.0

See Also:

• Registered
• IgnoreRegistration

Nested Class Summary

Nested classes/interfaces inherited from interface dev.jaxydog.astral.register.Registered

Registered.All, Registered.Client, Registered.Common, Registered.Generated, Registered.Server

Constructor Summary

Constructors

Constructor	Description
ContentRegistrar()

Method Summary

Modifier and Type	Method	Description
void	generate()	Generates game assets or data.
net.minecraft.util.Identifier	getRegistryId()	Returns this value's associated registry identifier.
String	getRegistryPath()	Returns this value's associated registry identifier path.
final void	registerClient()	Registers this value on the client environment.
final void	registerCommon()	Registers this value on both the client and server environments.
final void	registerServer()	Registers this value on the server environment.

Methods inherited from class java.lang.Object

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

Constructor Details

ContentRegistrar

public ContentRegistrar()

Method Details

getRegistryPath

public String getRegistryPath()

Description copied from interface: Registered

Returns this value's associated registry identifier path.

This is by default used to determine the Identifier provided by Registered.getRegistryId(). For example, returning "my_item" will cause the associated identifier to be astral:my_item.

Specified by:

getRegistryPath in interface Registered

Returns:

An identifier path.

getRegistryId

public net.minecraft.util.Identifier getRegistryId()

Description copied from interface: Registered

Returns this value's associated registry identifier.

This is used to uniquely distinguish this instance from other equally-typed instances.

Specified by:

getRegistryId in interface Registered

Returns:

A new identifier.

registerCommon

public final void registerCommon()

Description copied from interface: Registered.Common

Registers this value on both the client and server environments.

The contained code will run for both environments. If you only want one or the other, see its sister interfaces.

Specified by:

registerCommon in interface Registered.Common

See Also:

• Registered.Client
• Registered.Server
• Registered.Generated

registerClient

public final void registerClient()

Description copied from interface: Registered.Client

Registers this value on the client environment.

The contained code will only ever run on the game client. If you only want the server or want both, see its sister interfaces.

Specified by:

registerClient in interface Registered.Client

See Also:

• Registered.Common
• Registered.Server
• Registered.Generated

registerServer

public final void registerServer()

Description copied from interface: Registered.Server

Registers this value on the server environment.

The contained code will only ever run on the game server. If you only want the client or want both, see its sister interfaces.

Specified by:

registerServer in interface Registered.Server

See Also:

• Registered.Common
• Registered.Client
• Registered.Generated

generate

public void generate()

Description copied from interface: Registered.Generated

Generates game assets or data.

It should be assumed that the contained code will only ever run on the server environment.

Specified by:

generate in interface Registered.Generated