Getting/Saving Groups (Models)

Getting Saved DisplayEntityGroups (Models)

//Get a DisplayEntityGroup from a storage location (LOCAL, MONGODB, or MYSQL)
DisplayEntityGroup groupFromStorage = DisplayGroupManager.getGroup(LoadMethod.LOCAL, "groupTag");

//Get a DisplayEntityGroup from a File
DisplayEntityGroup groupFromFile = DisplayGroupManager.getGroup(File);

//Get a DisplayEntityGroup from an InputStream
DisplayEntityGroup groupFromStream = DisplayGroupManager.getGroup(InputStream);

//Get a DisplayEntityGroup stored in a plugin's resources
DisplayEntityGroup groupFromResources = DisplayGroupManager.getGroup(MyPlugin.getInstance(), "groupTag")

Spawning a SpawnedDisplayEntityGroup

//Spawn a group
DisplayEntityGroup savedGroup = yourMethodToGetADisplayEntityGroup();
SpawnedDisplayEntityGroup spawnedGroup = savedGroup.spawn(Location, GroupSpawnedEvent.SpawnReason.CUSTOM);

//The created group can be used for animations, used as entity equipment, etc.

//Spawn a group with GroupSpawnSettings, applying properties before it spawns
GroupSpawnSettings settings = new GroupSpawnSettings();
settings
            .setTeleportationDuration(2)
            .hideInteractionsByDefault(true);
SpawnedDisplayEntityGroup spawnedGroup = savedGroup.spawn(Location, GroupSpawnedEvent.SpawnReason.CUSTOM, settings);

Spawning a PacketDisplayEntityGroup (Packet-Based)

//Create a group, similar to a SpawnedDisplayEntityGroup, just with packet based parts
DisplayEntityGroup savedGroup = yourMethodToGetADisplayEntityGroup();
PacketDisplayEntityGroup packetGroup = savedGroup.createPacketGroup(spawnLocation, GroupSpawnedEvent.SpawnReason.CUSTOM);

//Player Visibility
packetGroup.showToPlayer(player, GroupSpawnedEvent.SpawnReason.CUSTOM); //Begin internal tracking of all parts in this group
packetGroup.hideFromPlayer(player); //Stop internal tracking of all parts in this group

//Automatically Show to Players
packetGroup.setAutoShow(true);

Get a SpawnedDisplayEntityGroup present in the Game World

//Get all registered SpawnedDisplayEntityGroups in the current play session
Set<SpawnedDisplayEntityGroup> allGroups = DisplayGroupManager.getSpawnedGroups();

//Get all registered SpawnedDisplayEntityGroups in a world
World world;
Set<SpawnedDisplayEntityGroup> worldGroups = DisplayGroupManager.getSpawnedGroups(world);

//Get all registered SpawnedDisplayEntityGroups in a Chunk
Chunk chunk;
Set<SpawnedDisplayEntityGroup> chunkGroups = DisplayGroupManager.getSpawnedGroups(chunk);

//Get all SpawnedDisplayEntityGroups in a radius around a location
Location location;
double searchRadius;
Set<SpawnedDisplayEntityGroup> nearbyGroups = DisplayGroupManager.getNearbySpawnedGroups(location, searchRadius);

//Get the SpawnedDisplayEntityGroup the closest to a location in a given radius
Location location;
double searchRadius;
Set<SpawnedDisplayEntityGroup> nearbyGroups = DisplayGroupManager.getNearestSpawnedGroup(location, searchRadius);

//Get a SpawnedDisplayEntityGroup that a Display entity may be part of
Display display;
GroupResult result = DisplayGroupManager.getSpawnedGroup(display); //Null if display has no group
SpawnedDisplayEntityGroup foundGroup = result.group();

//Get a SpawnedDisplayEntityGroup that a non-display entity may be part of
Entity entity; //Interaction or Mannequin
double searchRadius;
SpawnedDisplayEntityGroup foundGroup = DisplayGroupManager.getSpawnedGroup(entity, searchRadius);

Get a PacketDisplayEntityGroup present in the Game World

//Get all registered PacketDisplayEntityGroups in a World
World world;
Set<PacketDisplayEntityGroup> allGroups = PacketDisplayEntityGroup.getGroups(world);

//Get all registered PacketDisplayEntityGroups in a Chunk
Chunk chunk;
Set<PacketDisplayEntityGroup> allGroups = PacketDisplayEntityGroup.getGroups(chunk);

//----------Persistent Groups----------
//If a PacketDisplayEntityGroup is persistent it will have an ID used to get it
//The ID persists between game sessions
PacketDisplayEntityGroup packetGroup = yourMethodToGetAPacketDisplayEntityGroup();
String persistentId = packetGroup.getPersistentGlobalId();

//Get Group with Persistent Id
PacketDisplayEntityGroup foundGroup = PacketDisplayEntityGroup.getGroup(persistentId)

Unregister a group

//Groups should be unregistered after their purpose has been fulfilled.
//Unregistering groups prevents future usage.

//Unregister a SpawnedDisplayEntityGroup and despawn, forcing chunk loading to ensure entity removal
SpawnedDisplayEntityGroup spawnedGroup = yourMethodToGetASpawnedDisplayEntityGroup();
boolean despawn = true;
boolean force = false; //Whether chunks should be force loaded to despawn the parts
spawnedGroup.unregister(despawn, force);


//Unregister a PacketDisplayEntityGroup
PacketDisplayEntityGroup packetGroup = yourMethodToGetAPacketDisplayEntityGroup();
packetGroup.unregister();

Clone/Copy a group

//Create a clone of a group at a given location
Location cloningLocation;

SpawnedDisplayEntityGroup spawnedGroup = yourMethodToGetASpawnedDisplayEntityGroup();
SpawnedDisplayEntityGroup clonedSpawnedGroup = spawnedGroup.clone(cloningLocation);

PacketDisplayEntityGroup packetGroup = yourMethodToGetAPacketDisplayEntityGroup();
PacketDisplayEntityGroup clonedPacketGroup = packetGroup.clone(cloningLocation);

Serialize and Save a group

DisplayEntityGroup savedGroup; //The serializable version of a group

SpawnedDisplayEntityGroup spawnedGroup = yourMethodToGetASpawnedDisplayEntityGroup();
savedGroup = spawnedGroup.toDisplayEntityGroup();

PacketDisplayEntityGroup packetGroup = yourMethodToGetAPacketDisplayEntityGroup();
savedGroup = packetGroup.toDisplayEntityGroup();

//Save the group to a storage location (LOCAL in this case)
DisplayGroupManager.saveDisplayEntityGroup(LoadMethod.LOCAL, savedGroup, null);