PulseLib Entities

Entities are the most natural fit for PulseLib: each entity already has its own lifetime, position, rotation, and tick state. The entity implements PAnimatable, and PEntityRenderer renders the animated model.

Use entity controllers to translate gameplay state into animation state. Do not put rendering decisions into the AI goals or renderer when a controller can express the same rule cleanly.

Entity class

This example chooses attack, walk, or idle from normal entity state. The animation names must exist in the exported model.

public class RobotEntity extends PathfinderMob implements PAnimatable<RobotEntity> {
    private static final PRawAnimation WALK = PRawAnimation.begin().thenLoop("walk").build();
    private static final PRawAnimation IDLE = PRawAnimation.begin().thenLoop("idle").build();
    private static final PRawAnimation ATTACK = PRawAnimation.begin().thenPlay("attack").build();

    private final PAnimationManager<RobotEntity> manager = PLibHelper.createManager(this);

    public RobotEntity(EntityType<? extends PathfinderMob> type, Level level) {
        super(type, level);
    }

    @Override
    public PAnimationManager<RobotEntity> getAnimationManager(AnimManagerKey key) {
        return this.manager;
    }

    @Override
    public void registerAnimationControllers(PAnimationManager.PAnimationRegistrar<RobotEntity> registrar) {
        registrar.add("main", () -> state -> {
            RobotEntity entity = state.animatable();
            if (entity.swinging) {
                state.controller().play(ATTACK);
            } else {
                state.controller().play(entity.walkAnimation.isMoving() ? WALK : IDLE);
            }
            return ControllerState.PLAY;
        });
    }
}

Renderer

The renderer is mostly declarative: model data plus render type. Living entity rotation and scaling are handled by PEntityRenderer.

public class RobotRenderer extends PEntityRenderer<RobotEntity, PEntityRenderState.LivingImpl<RobotEntity>> {
    public RobotRenderer(EntityRendererProvider.Context context) {
        super(context,
                new DefaultEntityModelData.DefaultEntityModelDataBuilder(
                        Identifier.fromNamespaceAndPath("examplemod", "robot")).build(),
                PRenderTypes.RenderTypeProvider::trianglesSolid);
    }

    @Override
    public PEntityRenderState.LivingImpl<RobotEntity> createRenderState() {
        return PLibHelper.livingRenderState();
    }
}

Register it:

@SubscribeEvent
public static void registerRenderers(EntityRenderersEvent.RegisterRenderers event) {
    event.registerEntityRenderer(MyEntities.ROBOT.get(), RobotRenderer::new);
}

LivingEntity behavior

For LivingEntity, PEntityRenderer follows several vanilla transforms so custom models behave like normal mobs:

• Body rotation is applied from vanilla interpolation.
• Death, sleeping, upside-down, and auto spin transforms are copied from vanilla-style behavior.
• Entity scale is applied.
• If the model has a bone named head, head yaw and pitch are applied to it.

Layers

Use PEntityRenderLayer for extra model parts attached to entity bones: armor plates, backpacks, equipment, or conditional body parts. See Entity Render Layers.

Classes used:

• PEntityRenderer
• DefaultEntityModelData
• PAnimationController