Create Packet-Based Entities

Creating a Packet-Based Entity (PacketDisplayEntityPart)

//Building a 2.0 Scale Block Display Grass Block
PacketAttributeContainer container = new PacketAttributeContainer(); //Used to hold/supply entity attributes and used to build entities
container.setAttribute(DisplayAttributes.Transform.SCALE, new Vector3f(2f)) //Set scale to 2.0
            .setAttribute(DisplayAttributes.BlockDisplay.BLOCK_STATE, BlockType.GRASS_BLOCK.createBlockData()) //Set Block Display's Block
            .setAttribute(DisplayAttributes.BRIGHTNESS, new Display.Brightness(15, 15)) //Set the brightness

//Create the part
PacketDisplayEntityPart part = container.createPart(PartType.BLOCK_DISPLAY, spawnLocation);

//Player Visibility
part.showToPlayer(player, GroupSpawnedEvent.SpawnReason.CUSTOM);
part.hideFromPlayer(player);

//Entities can also be sent to players by using the method below, 
//but the entity will not be internally tracked by DisplayEntityUtils
//The same container can be used to hold the entity's data and to send data changes
container.sendEntity(PartType.BLOCK_DISPLAY, player, spawnLocation);

Interaction Entity Example

PacketAttributeContainer container = new PacketAttributeContainer();
container.setAttribute(DisplayAttributes.Interaction.WIDTH, 2f)
            .setAttribute(DisplayAttributes.Interaction.HEIGHT, 5f)
            .setAttribute(DisplayAttributes.Interaction.RESPONSIVE, false);

//Creates a packet based interaction entity
PacketDisplayEntityPart interactionPart = container.createPart(PartType.INTERACTION, spawnLocation);

Entity Tracking

//Entity Tracking is Internally handled by DEU

DEUUser user = DEUUser.getOrCreateUser(player);
PacketDisplayEntityPart part = yourMethodToGetAPacketDisplayEntityPart();

//Whether a user has had a part's entity data sent to their client
boolean isTracking = part.isTrackedBy(player);

//A UUID collection of all players who have had this part's entity data sent to their client
Collection<UUID> viewers = part.getViewers();

//A collection of all players who have had this part's entity data sent to their client
Collection<Player> players = part.getTrackingPlayers();

Sending Data Changes

PacketDisplayEntityPart part = yourMethodToGetAPacketDisplayEntityPart();

//Sending data changes from a part, to all viewers of part
part.setAttribute(DisplayAttributes.GLOWING, false); //Sets the glowing attribute of this part to false for all players tracking the part

//Set and send a given attribute at the same time
part.setAndSend(DisplayAttributes.BILLBOARD, Display.Billboard.CENTER);

//----------------------------------------------------------
//Send many data changes from a part, to all viewers of part
//This is more optimal, rather than setting a single attribute multiple times
DisplayAttributeMap map = new DisplayAttributeMap();
map.add(DisplayAttributes.Shadow.RADIUS, 32f)
    .add(DisplayAttributes.Shadow.STRENGTH, 1f);
part.setAttribtues(map); //Send the attributes of the map to all players tracking the part


//-------------------------------------------------------------
//Send entity data changes to a player
PacketAttributeContainer container = new PacketAttributeContainer();
container.setAttribute(DisplayAttributes.GLOWING, false);

//The entityId can be the id of any eligible entity, even non-packet based entities
//In this case, the packet-based part's entity id is used
int entityId = part.getEntityId(); 

//Send the attribute update to a specific player
container.sendAttributes(player, entityId);