Common

Effect

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

Registers a native MobEffect with hot-reload support (String overload).

Members

Jump directly to declarations on this page.

• registerNativeEffectFunction
• registerNativeEffectFunction
• createSimpleEffectFunction

registerNativeEffect

registerNativeEffectCommonFunction

fun registerNativeEffect(id: String, registerMode: RegisterMode = RegisterMode.WORLD, effectFactory: () -> MobEffect): KattonRegistry.KattonMobEffectEntry

Registers a native MobEffect with hot-reload support (String overload).

This is the primary API for registering custom MobEffect subclasses from scripts. The effect will be registered in the global Minecraft registry with full hot-reload capability.

Parameters

Parameter	Description
id	Effect identifier (e.g., "mymod:custom_effect")
registerMode	Registration mode (GLOBAL, WORLD, or RELOADABLE)
effectFactory	Factory function to create the MobEffect instance

Returns

registered KattonMobEffectEntry

registerNativeEffect

registerNativeEffectCommonFunction

fun registerNativeEffect(id: Identifier, registerMode: RegisterMode = RegisterMode.WORLD, effectFactory: () -> MobEffect): KattonRegistry.KattonMobEffectEntry

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

Parameters

Parameter	Description
id	Effect identifier
registerMode	Registration mode
effectFactory	Factory function to create the MobEffect instance

Returns

registered KattonMobEffectEntry

createSimpleEffect

createSimpleEffectCommonFunction

fun createSimpleEffect(category: MobEffectCategory, color: Int): MobEffect

Utility factory for quickly creating a simple custom MobEffect.

Creates a basic MobEffect with the specified category and color. For more complex effects, use the full factory pattern with registerNativeEffect.

Parameters

Parameter	Description
category	The effect category (BENEFICIAL, HARMFUL, or NEUTRAL)
color	The effect color in RGB format

Returns

new MobEffect instance