Creating the GeoReplacedEntity Class

The first step in making a GeckoLib replaced entity is to create the entity class itself.

Quick Summary

Just looking for a quick summary? Expand the section below!

Click to expand

Here are the quick steps required to create a GeckoLib entity class:

1. Create a new class implementing GeoReplacedEntity
2. Override the getReplacingEntityType() method and return the EntityType you're replacing
3. Override the getAnimatableInstanceCache and registerController methods from GeoEntity
4. Instantiate a new AnimatableInstanceCache in a final field at the top of your class via GeckoLibUtil.createInstanceCache(this)
5. Return the AnimatableInstanceCache in the getAnimatableInstanceCache method
6. Add any animation controllers you want to use in registerControllers

You now have a working GeckoLib replaced entity!

Making the class

warning

This example replaces the vanilla CREEPER entity, as an example.
You will need to replace this with the EntityType you're replacing.

💻Additive Code Section

All code snippets in this section add onto the previous code snippets, using a step-by-step approach to build the complete code.
Green highlights show added or modified lines of code for each step.

First, we will make the base replaced entity class:

public class ExampleReplacedEntity implements GeoReplacedEntity {

}

Then, we will implement the getReplacingEntityType interface and return the EntityType we're replacing:

public class ExampleReplacedEntity implements GeoReplacedEntity {
    @Override
    public EntityType<?> getReplacingEntityType() {
        return EntityType.CREEPER;
    }
}

Then, we will override the getAnimatableInstanceCache and registerControllers methods:

public class ExampleReplacedEntity implements GeoReplacedEntity {
    @Override
    public EntityType<?> getReplacingEntityType() {
        return EntityType.CREEPER;
    }

    @Override
    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {
        // We can fill this in later
    }

    @Override
    public AnimatableInstanceCache getAnimatableInstanceCache() {
        return null;
    }
}

Next, let's instantiate an AnimatableInstanceCache in a final field at the top of our class, and return it in getAnimatableInstanceCache:

public class ExampleReplacedEntity implements GeoReplacedEntity {
    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);

    @Override
    public EntityType<?> getReplacingEntityType() {
        return EntityType.CREEPER;
    }

    @Override
    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {
        // We can fill this in later
    }

    @Override
    public AnimatableInstanceCache getAnimatableInstanceCache() {
        return this.geoCache;
    }
}

And you're done!

For information on adding animation controllers, see the Animation Controllers page.