Common

Entity

top.katton.api.registrycommon/src/main/kotlin/top/katton/api/registry/Entity.kt

Registers a complete native Entity with hot-reload support.

Members

Jump directly to declarations on this page.

• registerNativeEntityFunction
• registerNativeEntityFunction
• registerEntityAttributesFunction
• registerSpawnPlacementFunction
• registerSpawnEggFunction
• registerSpawnEggFunction

registerNativeEntity

registerNativeEntityCommonFunction

@ApiStatus.Experimental
@ApiStatus.Experimental fun registerNativeEntity(id: String, registerMode: RegisterMode = RegisterMode.WORLD, configure: KattonEntityProperties.() -> Unit = {}, entityFactory: (KattonEntityProperties) -> EntityType<*>): KattonRegistry.KattonEntityTypeEntry

Registers a complete native Entity with hot-reload support.

This is the primary API for registering custom entities from scripts. It handles EntityType registration plus optional attributes, spawn egg, and spawn placement configuration in a single call.

Parameters

Parameter	Description
id	Entity identifier (e.g., "mymod:custom_mob")
registerMode	Registration mode (GLOBAL, WORLD, or RELOADABLE)
configure	Configuration lambda for entity properties (dimensions, category, attributes, etc.)
entityFactory	Factory function to create the EntityType instance

Returns

The registered KattonEntityTypeEntry

registerNativeEntity

registerNativeEntityCommonFunction

fun registerNativeEntity(id: Identifier, registerMode: RegisterMode = RegisterMode.WORLD, configure: KattonEntityProperties.() -> Unit = {}, entityFactory: (KattonEntityProperties) -> EntityType<*>): KattonRegistry.KattonEntityTypeEntry

Registers a complete native Entity with hot-reload support (Identifier overload).

registerEntityAttributes

registerEntityAttributesCommonFunction

@ApiStatus.Experimental
@ApiStatus.Experimental fun registerEntityAttributes(id: String, entityType: EntityType<out net.minecraft.world.entity.LivingEntity>, configure: KattonEntityProperties.() -> Unit, reloadable: Boolean = true)

Registers entity default attributes independently.

Use this when you want to register attributes for an entity that was already registered via [registerNativeEntityType]. For new entities, prefer [registerNativeEntity] which handles attributes automatically.

Note: This uses the reloadable path by default since standalone attribute registration typically happens during hot-reload. For global entities, use [registerNativeEntity] which routes through the correct mode-aware path.

Parameters

Parameter	Description
id	Entity identifier
entityType	The already-registered entity type
configure	Configuration lambda for attributes
reloadable	true for RELOADABLE, false for GLOBAL

registerSpawnPlacement

registerSpawnPlacementCommonFunction

@ApiStatus.Experimental
@Suppress("UNCHECKED_CAST")
@ApiStatus.Experimental @Suppress("UNCHECKED_CAST") fun <T : net.minecraft.world.entity.Mob> registerSpawnPlacement(entityType: EntityType<T>, placementType: SpawnPlacementType, heightmap: Heightmap.Types = Heightmap.Types.MOTION_BLOCKING_NO_LEAVES, predicate: SpawnPlacements.SpawnPredicate<T>, reloadable: Boolean = true)

Registers a spawn placement rule independently.

Parameters

Parameter	Description
T	The mob entity type
entityType	The entity type
placementType	Where the entity can spawn (e.g., ON_GROUND, IN_WATER)
heightmap	The heightmap type for spawn checks
predicate	Custom spawn predicate
reloadable	true for RELOADABLE, false for GLOBAL

registerSpawnEgg

registerSpawnEggCommonFunction

@ApiStatus.Experimental
@ApiStatus.Experimental fun registerSpawnEgg(id: String, entityType: EntityType<out net.minecraft.world.entity.Mob>, registerMode: RegisterMode = RegisterMode.WORLD): KattonRegistry.KattonItemEntry

Registers a spawn egg item for an entity type independently.

Use this to create a spawn egg for an entity registered via [registerNativeEntityType]. For new entities, prefer [registerNativeEntity] with withSpawnEgg().

In MC 1.21.11+, spawn egg colors are derived from the entity type automatically.

Parameters

Parameter	Description
id	Spawn egg item identifier (e.g., "mymod:custom_mob_spawn_egg")
entityType	The entity type this egg spawns
registerMode	Registration mode

Returns

The registered KattonItemEntry

registerSpawnEgg

registerSpawnEggCommonFunction

@ApiStatus.Experimental
@ApiStatus.Experimental fun registerSpawnEgg(id: Identifier, entityType: EntityType<out net.minecraft.world.entity.Mob>, registerMode: RegisterMode = RegisterMode.WORLD): KattonRegistry.KattonItemEntry

Registers a spawn egg item for an entity type independently (Identifier overload).