🛠️API Usage

This page will describe how use the API from Create Encased

⚠️ Warning: All of these methods doesn't generate blockstates, models or textures, you need to do them manually

---

Available Features

Casing Related Methods

Casing

Definition : createCasing(registrate,name,connectedTexturesSprite)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the casing in your shaft

• connectedTexturesSprite CTSpriteShiftEntry — The sprite with the connected texture of your casing

Returns : BlockEntry<CasingBlock> — The Block Entry of the Casing

Example :

CreateCasingApi.createCasing(
    Create.REGISTRATE,
    "andesite",
    AllSpriteShifts.ANDESITE_CASING
)

Encased Shaft

Definition : createEncasedShaft(registrate,name,casing,connectedTexturesSprite)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the casing in your shaft

• casing Supplier<Block> — Supplier of the casing block applied to the shaft

• connectedTexturesSprite CTSpriteShiftEntry — The sprite with the connected texture of your casing

Returns : BlockEntry<PublicEncasedShaftBlock> — The Block Entry of the Encased Shaft

Example :

CreateCasingApi.createEncasedShaft(
    Create.REGISTRATE,
    "andesite",
    () -> AllBlocks.ANDESITE_CASING.get(),
    AllSpriteShifts.ANDESITE_CASING
)

Encased Cogwheel

Definition : createEncasedCogwheel(registrate,name,casing,connectedTexturesSprite,verticalCogwheelSide,horizontalCogwheelSide)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the casing in your shaft

• casing Supplier<Block> — Supplier of the casing block applied to the shaft

• connectedTexturesSprite CTSpriteShiftEntry — The sprite with the connected texture of your casing

• verticalCogwheelSide CTSpriteShiftEntry — The sprite for the vertical side of the cogwheel

• horizontalCogwheelSide CTSpriteShiftEntry — The sprite for the horizontal side of the cogwheel

Returns : BlockEntry<PublicEncasedCogwheelBlock> — The Block Entry of the Encased Cogwheel

Example :

CreateCasingApi.createEncasedCogwheel(
    Create.REGISTRATE,
    "andesite",
    () -> AllBlocks.ANDESITE_CASING.get(),
    AllSpriteShifts.ANDESITE_CASING,
    AllSpriteShifts.ANDESITE_ENCASED_COGWHEEL_SIDE,
    AllSpriteShifts.ANDESITE_ENCASED_COGWHEEL_OTHERSIDE
)

Encased Large Cogwheel

Definition : createEncasedLargeCogwheel(registrate,name,casing,connectedTexturesSprite)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the casing in your shaft

• casing Supplier<Block> — Supplier of the casing block applied to the shaft

• connectedTexturesSprite CTSpriteShiftEntry — The sprite with the connected texture of your casing

Returns : BlockEntry<PublicEncasedCogwheelBlock> — The Block Entry of the Encased Large Cogwheel

Example :

CreateCasingApi.createEncasedLargeCogwheel(
    Create.REGISTRATE,
    "andesite",
    () -> AllBlocks.ANDESITE_CASING.get(),
    AllSpriteShifts.ANDESITE_CASING
)

Encased Pipe

Definition : createEncasedPipe(registrate,name,casing,connectedTexturesSprite)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the casing in your shaft

• casing Supplier<Block> — Supplier of the casing block applied to the shaft

• connectedTexturesSprite CTSpriteShiftEntry — The sprite with the connected texture of your casing

Returns : BlockEntry<PublicEncasedPipeBlock> — The Block Entry of the Encased Pipe

⚠️ Warning : This method doesn't create an item because Create doesn't offer the possibility to do it

Example :

CreateCasingApi.createEncasedPipe(
    Create.REGISTRATE,"andesite",
    () -> AllBlocks.ANDESITE_CASING.get(),
    AllSpriteShifts.ANDESITE_CASING
)

Gearbox

Definition : createGearbox(registrate,name,connectedTexturesSprite,shouldGenerateVerticalItem)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the casing in your shaft

• connectedTexturesSprite CTSpriteShiftEntry — The sprite with the connected texture of your casing

• shouldGenerateVerticalItem boolean — Whether to generate a vertical item for the gearbox

Returns : BlockEntry<ApiGearboxBlock> — The Block Entry of the Gearbox

Example :

CreateCasingApi.createGearbox(
    Create.REGISTRATE,
    "andesite",
    AllSpriteShifts.ANDESITE_CASING,
    true
)

Depot

Definition : createDepot(registrate, name)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the depot (e.g. andesite)

Returns : BlockEntry<ApiDepotBlock> — The Block Entry of the Depot

Example :

CreateCasingApi.createDepot(
    Create.REGISTRATE,
    "andesite"
)

Mixer

Definition : createMixer(registrate, name)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the mixer (e.g. andesite)

Returns : BlockEntry<ApiMixerBlock> — The Block Entry of the Mixer

Example :

CreateCasingApi.createMixer(
    Create.REGISTRATE,
    "andesite"
)

Shaft and Cogwheels Related Methods

Small Cogwheel

Definition : createSmallCogwheel(registrate, name)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the cogwheel (e.g. andesite)

Returns : BlockEntry<ApiCogwheelBlock> — The Block Entry of the Small Cogwheel

Example :

CreateCasingApi.createSmallCogwheel(
    Create.REGISTRATE,
    "andesite"
)

Large Cogwheel

Definition : createLargeCogwheel(registrate, name, shaftlessModel)

Parameters :

• registrate CreateRegistrate — The registrate of your mod

• name String — The name of the cogwheel (e.g. andesite)

• shaftlessModel PartialModel — The model used when the cogwheel is shaftless

Returns : BlockEntry<ApiCogwheelBlock> — The Block Entry of the Large Cogwheel

Example :

CreateCasingApi.createLargeCogwheel(
    Create.REGISTRATE,
    "andesite",
    AllPartialModels.SHAFTLESS_LARGE_COGWHEEL
)

For Custom Shafts

Definition : forCustomShafts(action)

Parameters :

• action Consumer<BlockEntry<? extends ShaftBlock>> — A consumer that will receive each registered custom shaft

Returns : void — This method is used for performing an action on all custom shafts registered via the API

Example :

CreateCasingApi.forCustomShafts(shaft -> {
    // do something with each shaft
});

---

Additional informations

Takes in note that these methods can change at any time and may not work as intended for some peoples

The datagen will be added to these methods in a future update.

It's recommanded to use these method with the registrate from Create Encased (CreateCasing.REGISTRATE) because the stress config verify if the block is from the mod.