Using Parts (Group Entities)

ActiveParts are every individual entity in an ActiveGroup

Parts come in 5 entity types

• BLOCK (Block Display)

• ITEM (Item Display)

• TEXT (Text Display)

• INTERACTION (Interaction Entity)

• MANNEQUIN (Mannequin Entity)

Getting the Parts (entities) of an ActiveGroup

ActiveGroup<?> group = yourMethodToGetAGroup();
SpawnedDisplayEntityGroup spawnedGroup; //subclass of ActiveGroup
PacketDisplayEntityGroup packetGroup; //subclass of ActiveGroup

//Get all parts in a group
List<ActivePart> parts = group.getParts();

//Get a list of parts by their part type
SpawnedDisplayEntityPart.PartType itemType = SpawnedDisplayEntityPart.PartType.ITEM;
List<ActivePart> itemParts = group.geParts(type);

//Get a list of all display entity parts (BLOCK, ITEM, TEXT)
List<ActivePart> displayEntityParts = group.getDisplayParts();

//Get a list of all parts with a specified part tag
List<ActivePart> taggedParts = group.getParts("tag");

//Get a list of all parts containing at least one of the part tags in a given collection
Collection<String> tags = List.of("tag1", "tag2");
List<ActivePart> multiTaggedParts = group.getParts(tags);

Add/Remove a part to/from a group

ActivePart part = yourMethodToGetAPart();
SpawnedDisplayEntityPart spawnedPart; //subclass of ActivePart
PacketDisplayEntityPart packetPart; //subclass of ActivePart

//Remove a part, making it invalid for later use
//Optionally kill the part if it is a SpawnedDisplayEntityPart
boolean killEntity = true;
spawnedPart.remove(killEntity)
packetPart.remove();

//Add a part to a group. The part's class must correspond to the group
//SpawnedDisplayEntityPart -> SpawnedDisplayEntityGroup
//PacketDisplayEntityPart -> PacketDisplayEntityGroup
ActiveGroup<?> group = yourMethodToGetAGroup();
group.addPart(part);

//Add an entity to a group. If the group is packet-based, a PacketDisplayEntityPart 
//representative of the entity will be created.
//THE ENTITY MUST BE AN ELIGIBLE PART ENTITY. (See top of page)
Entity entity = yourMethodToGetAnEntity();
group.addEntity(entity);

Manipulate Any Part Entity (Some Methods)

ActivePart part = yourMethodToGetAPart();

//Move a part entity along a vector.
//In this case, the translation will be upwards from the part's current translation.
//If the part is a display it will be translated, otherwise it will be teleported.
float distance = 12;
int durationInTicks = 15;
int delayInTicks = 2;
Direction direction = Direction.UP;

part.translate(distance, durationInTicks, delayInTicks, direction);

//SAFELY Translate a part along a vector
Vector vector = new Vector(1, 2, 1);
part.translate(distance, durationInTicks, delayInTicks, vector);

//Get the part's translation from its group's origin
//Null if the part is ungrouped or if the part is a Display Entity
part.getNonDisplayTranslation();

Manipulate Display Entities (Some Methods)

ActivePart part = yourMethodToGetAPart();

//Set the billboard of a display part
part.setBillboard(Display.Billboard.VERTICAL);

//Set the view range of a display part
part.setViewRange(15);

//Set the glow color of a display part
Color color = Color.RED;
part.setGlowColor(color);

//Each of these, and other Display Entity methods, have corresponding getter methods

Manipulate Interaction Entities

ActivePart part = yourMethodToGetAPart();

//Set Interaction Dimensions
float height = 1.5f;
float width = 2f;
part.setInteractionHeight(height);
part.setInteractionWidth(width);

//Set Interaction responsiveness
boolean isResponsive = false;
part.setInteractionResponsive(isResponsive);

//Each of these Interaction methods have corresponding getter methods

Manipulate Mannequin Entities (Some Methods)

ActivePart part = yourMethodToGetAPart();

//Set the Mannequin's Profile (Skin)
PlayerProfile profile = yourMethodToGetAProfile();
part.setMannequinProfile(profile);

//Set the Mannequin's description/belowname text
Component description;
part.setMannequinBelowName(description);

//Set the Mannequin's Custom Name
Component customName;
boolean customNameVisible;

part.customName(customName);
part.customNameVisible(customNameVisible);

//Set the Mannequin's Pose
Pose pose = Pose.SWIMMING;
part.setMannequinPose(pose);

//Set the Mannequin's Equipment
EquipmentSlot slot = EquipmentSlot.CHEST;
ItemStack item = new ItemStack(Material.DIAMOND_CHESTPLATE);
part.setMannequinEquipment(slot, item);

//Each of these, and other Mannequin methods, have corresponding getter methods