Compatibility
Minecraft: Java Edition
1.12.2
Platforms
Forge
Supported environments
90% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Creators
Details
Licensed ARR
Published last year
Updated 6 months ago
A small mod that lets mods and modpacks handle piston interactions!
API Features:
Give custom blocks advanced piston interactions
Piston API gives blocks a way to have position & world sensitive interactions with pistons! Mainly the block's pushability, and its stickiness.
- This interface adds one method
getPushReaction
(which takes in the block source & piston info, and returns theEnumPushReaction
). Blocks should implement this if they have advanced push reaction logic. This interface overrides vanilla'sgetPushReaction(IBlockState)
method, blocks that don't implement the interface fallback on vanilla's method. For modpack devs: Each block's push reaction can be overriden by callingPushReactionHanlder.overridePushReaction
through Groovyscript during postInit (mod devs should not do this!) - Grovvyscript examples:
import static git.jbredwards.piston_api.mod.asm.PushReactionHandler.overridePushReaction
import net.minecraft.block.material.EnumPushReaction
//makes dirt be destroyed by pistons when pushed (like grass or leaves)
overridePushReaction(block('minecraft:dirt'), EnumPushReaction.DESTROY)
//makes orange wool not pushable by pistons, while leaving the rest pushable
def orangeWool = blockstate('minecraft:wool', 1)
overridePushReaction(block('minecraft:wool'), {source, pistonInfo -> orangeWool == source.getBlockState() ? EnumPushReaction.BLOCK : EnumPushReaction.NORMAL})
- This interface adds two methods:
getStickReaction
(which takes in the block source, the neighbor block to test, and piston info, and returns theEnumStickReaction
), andhasStickySide
(which takes in the block source & piston info, and returns whether the block has any potentially sticky sides). Blocks should implement this if they have advanced stickiness logic. This interface overrides forge'sisStickyBlock(IBlockState)
method, blocks that don't implement the interface fallback on forge's method. For modpack devs: Each block's stick result can be overriden by callingStickReactionHanlder.overrideStickReaction
through Groovyscript during postInit (mod devs should not do this!) - Groovyscript examples:
import static git.jbredwards.piston_api.mod.asm.StickReactionHandler.overrideStickReaction
import git.jbredwards.piston_api.api.piston.EnumStickReaction
//makes slime blocks not sticky
overrideStickReaction(block('minecraft:slime'), EnumStickReaction.PASS)
//makes crafting tables sticky
overrideStickReaction(block('minecraft:crafting_table'), EnumStickReaction.STICK)
//makes bookshelves never stick to anything
overrideStickReaction(block('minecraft:bookshelf'), EnumStickReaction.NEVER)
//makes stained glass sticky, but only to the same color
overrideStickReaction(block('minecraft:stained_glass'), {source, other, pistonInfo -> source.getBlockState() == other.getBlockState() ? EnumStickReaction.STICK : EnumStickReaction.PASS})
//a more complicated example, makes the open part of logs sticky
import static git.jbredwards.piston_api.api.block.IStickyBehavior.getConnectingSide
import net.minecraft.block.BlockLog
overrideStickReaction([block('minecraft:log'), block('minecraft:log2')], {source, other, pistonInfo ->
def connectingAxis = BlockLog.EnumAxis.fromFacingAxis(getConnectingSide(source, other).getAxis())
def logAxis = source.getBlockState().getValue(BlockLog.LOG_AXIS)
connectingAxis == logAxis ? EnumStickReaction.STICK : EnumStickReaction.PASS
})
Main Features:
- Configurable piston push limit
- Pistons move tile entities
- Pistons don't destroy fluid states (while Fluidlogged API is installed)
- Quark mod compatibility
Small Features:
- Override existing piston interactions
- Chests stick each other when pushed
- Play block breaking sounds and particles when blocks are destroyed by pistons