Common API

Generated from module common.

Source Roots

• common/src/main/kotlin/top/katton/api

Pages

• ClientDataApi - Sync a key-value pair to all connected players. A value of null removes the key on the client side.
• ClientItemRenderAnimation - A transform keyframe on an animation track. [time] is usually 0.0 to 1.0.
• ClientItemRenderMarkerApi - A lightweight client-side item model rendered directly in the world.
• ClientPostEffectApi - Register a runtime client post effect from Minecraft 26.x post-effect JSON.
• ClientPostEffectPresetsApi - Register a configurable full-screen invert effect.
• ClientPostEffectServerApi - Ask one Fabric or NeoForge client to activate a registered post effect.
• KattonAPI - Execute [block] only once for a given [key] under the current script owner namespace.
• KattonClientApi - Gets the raw Minecraft client instance.
• KattonClientRenderApi - Screen-space render callback context.
• KattonComponentApi - Combines two nullable Components into a new Component.
• KattonConfigApi - Script-facing config API. Reads config values from the current script's pack manifest.
• KattonContextApi - Determines which position the returned [ExecutionContext] uses.
• KattonDependencyApi - Script-facing access to optional mod and plugin dependency state.
• ScriptEntrypoint - Execution stages available to server entrypoints.
• AudioApi - Audio bytes are resolved on the client.
• AudioServerApi - Loader-owned transport. Paper deliberately has no full-player transport.
• BasicSoundApi - Platform scheduling hook; Paper installs entity-region scheduling.
• Recipes
• KattonBlockApi - Map-like access to blocks in a level by position.
• KattonBlockEntityApi - Map-like access to block entities in a level by position.
• KattonEntityApi - Get/Set the NBT data of an Entity.
• KattonItemApi - Extension property to get/set NBT data on an ItemStack.
• KattonLootTableApi - Get drops for a block as if it were broken with a tool.
• KattonMiscApi - Send a system message to a player.
• KattonNbtApi - Create a numeric Tag from a Number value.
• KattonPlayerApi - List-like access to all online players.
• KattonRecipeApi - Give recipe advancements to players.
• KattonScoreboardApi - Get a score value for a target in an objective.
• KattonServerApi - Access to all online players.
• KattonSlotProviderApi - Get an item from a container slot.
• KattonWorldApi - Map-like access to all server levels by ResourceKey.
• EventCapabilities - Runtime capability query for event APIs whose platform parity is not exact.
• KattonEventsArg - Argument for server-level events.
• ManagedEvents - Managed event listener handle returned to scripts when registering a native listener. 注册原生事件监听器后返回给脚本的托管监听器句柄。
• InjectApi - 注册注入的句柄，用于回滚操作。
• InjectionCapabilities - Current availability of Katton's unsafe runtime bytecode injection.
• KattonBlockModificationApi - Configuration for modifying existing block properties.
• KattonEntityTypeModificationApi - Configuration for modifying default attributes of an existing [EntityType] (vanilla or modded).
• KattonItemModificationApi - Configuration for modifying existing item properties.
• KattonLootTableModificationApi - Returns the JSON form of an existing loot table, or null when the table is not registered or the server is offline.
• KattonRecipeModificationApi - Configuration for modifying existing recipe properties.
• KattonVillagerTradeModificationApi - Configuration for a single trade to be appended to an existing [TradeSet] via [addVillagerTrade].
• Block - Registers a native Block with hot-reload support (String overload).
• BlockEntityType - Registers a native BlockEntityType with hot-reload support.
• CreativeModeTab - Registers a native CreativeModeTab with hot-reload support.
• DataComponentType - Registers a persistent (saved to disk) DataComponentType with hot-reload support.
• Effect - Registers a native MobEffect with hot-reload support (String overload).
• Entity - Registers a complete native Entity with hot-reload support.
• EntityRenderer - Registers a custom entity renderer for a script-registered entity type.
• EntityType - Registers a native EntityType with hot-reload support.
• Item - Registers a native Item with hot-reload support.
• ParticleType - Registers a native ParticleType with hot-reload support.
• SoundEvent - Registers a native SoundEvent with hot-reload support.
• SceneClientApi - Register a client definition, owned by the current script. Version defaults to the script pack's code hash.
• SceneServerApi - Cancellation targets the original recipients; this is not a playback acknowledgement.
• SceneTimeline - A reusable scene definition. Factories run once when their track starts.
• SceneTypes - Completion is local; cancellation does not change server gameplay.