EntityLib/README.md

EntityLib

EntityLib is a PacketEvents addon that provides an abstraction over raw entity data and packets to make it easier to work with entities as a whole.

Features

• Full EntityMeta support
• Creation of WrapperEntities
• Keeping track of entities.

Usage

For more realistic examples, please take a look at the test-plugin module. It has an example Bukkit plugin that uses EntityLib.

Using the EntityMeta api

import java.sql.Wrapper;

class Example {

    public static void main(String[] args) {
        PacketEventsAPI api = ;// create PacketEventsAPI instance
        EntityLib.init(api); // If failed, it will throw an exception.

        // Making a random entity using packet events raw, i strongly recommend using the EntityLib#createEntity method instead
        int entityID = 1;
        WrapperPlayServerSpawnEntity packet = new WrapperPlayServerSpawnEntity(constructor args);
        EntityMeta meta = EntityLib.createMeta(entityId, EntityType);
        // You can cast the meta to the correct type depending on the entity type
        PigMeta pigMeta = (PigMeta) meta;

        // Once you're done modifying the meta accordingly, you can convert it to a packet, and send it to whoever you want for them  to see the changes.
        WrapperPlayServerEntityMetadata metaPacket = meta.createPacket();
        User.sendPacket(metaPacket);;
    }

}

Creating a WrapperEntity

import javax.xml.stream.Location;

class Example {

    public static void main(String[] args) {
        PacketEventsAPI api = ;// create PacketEventsAPI instance
        EntityLib.init(api); // If failed, it will throw an exception.

        WrapperEntity entity = EntityLib.createEntity(UUID, EntityType);
        // You can keep track of the entity yourself or store its entityId or uuid and fetch it using EntityLib#getEntity

        // Handling entity interactions if needed
        // By default EntityLib will ignore interaction packets and not handle them. You can enable this if needed
        EntityLib.enableEntityInteractions(); // Now we need to create an interaction handler
        EntityLib.setInteractionProcessor(EntityInteractionProcessor);


        // Entities also have access to the EntityMeta api, the EntityMeta api can be used seperately from wrapper entities but also can be used together
        EntityMeta meta = entity.getEntityMeta();
        // Depending on the entity type, you can safely cast the meta to the correct type
        PigMeta meta1 = (PigMeta) meta; // If the entity type is EntityTypes.PIG

        // adding a viewer to the entity can be done before or after spawn, doesnt matter
        entity.addViewer(User); // UUID also applicable
        entity.removeViewer(User); // UUID also applicable

        entity.spawn(Location); // Spawns the entity at the given location
        entity.remove(); // Removes the entity from the world
        entity.rotateHead(float yaw, float pitch); // Rotates the head of the entity
        entity.teleport(Location); // Teleports the entity to the given location.
        
        // If the entityId provider for WrapperEntities is not working for you or needs changing, you can get it from WrapperEntity#ID_PROVIDER
        // You can also set it to a custom provider if needed
        WrapperEntity.ID_PROVIDER = new EntityIdProvider() {
            @Override
            public int getEntityId() {
                return 0;
            }
        };
        
        // You can also create the EntityLib default provider by calling EntityIdProvider.simple();
    }

}