GeyserMC/Geyser
GeyserMC/Geyser
4
4
Fork 3
mirror of https://github.com/GeyserMC/Geyser.git synced 2024-08-14 23:57:35 +00:00
Code Issues 103 Projects Releases Wiki Activity

Add support for custom entities in the API

Browse source 
Allows for creating custom entity definitions upon registration as well as modifying existing entity spawns to use custom entity identifiers.
This commit is contained in:
RednedEpic 2023-05-09 11:46:06 -05:00
parent ed21a10101
commit ce4866156d
129 changed files with 1292 additions and 523 deletions
Download patch file Download diff file Expand all files Collapse all files

112
api/src/main/java/org/geysermc/geyser/api/entity/EntityDefinition.java Normal file
View file

@ -0,0 +1,112 @@
/*
* Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @author GeyserMC
* @link https://github.com/GeyserMC/Geyser
*/
package org.geysermc.geyser.api.entity;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.geysermc.geyser.api.GeyserApi;
/**
* Holds information about an entity that remains constant no matter
* its properties. This is typically data such as its identifier,
* its height/width, offset, etc.
*/
public interface EntityDefinition {
/**
* Gets the identifier of this entity.
*
* @return the identifier of this entity
*/
@NonNull
EntityIdentifier entityIdentifier();
/**
* Gets the width of this entity.
*
* @return the width of this entity
*/
float width();
/**
* Gets the height of this entity.
*
* @return the height of this entity
*/
float height();
/**
* Gets the offset of this entity.
*
* @return the offset of this entity
*/
float offset();
static Builder builder() {
return GeyserApi.api().provider(Builder.class);
}
interface Builder {
/**
* Sets the identifier of this entity.
*
* @param identifier the identifier of this entity
* @return the builder
*/
Builder identifier(@NonNull EntityIdentifier identifier);
/**
* Sets the width of this entity.
*
* @param width the width of this entity
* @return the builder
*/
Builder width(float width);
/**
* Sets the height of this entity.
*
* @param height the height of this entity
* @return the builder
*/
Builder height(float height);
/**
* Sets the offset of this entity.
*
* @param offset the offset of this entity
* @return the builder
*/
Builder offset(float offset);
/**
* Builds the entity definition.
*
* @return the entity definition
*/
EntityDefinition build();
}
}

97
api/src/main/java/org/geysermc/geyser/api/entity/EntityIdentifier.java Normal file
View file

@ -0,0 +1,97 @@
/*
* Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @author GeyserMC
* @link https://github.com/GeyserMC/Geyser
*/
package org.geysermc.geyser.api.entity;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.geysermc.geyser.api.GeyserApi;
/**
* Represents the data sent over to a client regarding
* an entity's identifier.
*/
public interface EntityIdentifier {
/**
* Gets whether this entity has a spawn egg or not.
*
* @return whether this entity has a spawn egg or not
*/
boolean hasSpawnEgg();
/**
* Gets the entity's identifier that is sent to the client.
*
* @return the entity's identifier that is sent to the client.
*/
@NonNull
String identifier();
/**
* Gets whether the entity is summonable or not.
*
* @return whether the entity is summonable or not
*/
boolean isSummonable();
@NonNull
static Builder builder() {
return GeyserApi.api().provider(Builder.class);
}
interface Builder {
/**
* Sets whether the entity has a spawn egg or not.
*
* @param spawnEgg whether the entity has a spawn egg or not
* @return the builder
*/
Builder spawnEgg(boolean spawnEgg);
/**
* Sets the entity's identifier that is sent to the client.
*
* @param identifier the entity's identifier that is sent to the client
* @return the builder
*/
Builder identifier(String identifier);
/**
* Sets whether the entity is summonable or not.
*
* @param summonable whether the entity is summonable or not
* @return the builder
*/
Builder summonable(boolean summonable);
/**
* Builds the entity identifier.
*
* @return the entity identifier
*/
EntityIdentifier build();
}
}

68
api/src/main/java/org/geysermc/geyser/api/event/bedrock/SessionDefineEntitiesEvent.java Normal file
View file

@ -0,0 +1,68 @@
/*
* Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @author GeyserMC
* @link https://github.com/GeyserMC/Geyser
*/
package org.geysermc.geyser.api.event.bedrock;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.geysermc.event.Event;
import org.geysermc.geyser.api.connection.GeyserConnection;
import org.geysermc.geyser.api.entity.EntityDefinition;
import org.geysermc.geyser.api.entity.EntityIdentifier;
import org.geysermc.geyser.api.event.connection.ConnectionEvent;
import java.util.List;
/**
* Called when Geyser sends a list of available entities to the
* Bedrock client. This will typically contain all the available
* entities within vanilla, but can be modified to include any custom
* entity defined through a resource pack.
*/
public abstract class SessionDefineEntitiesEvent extends ConnectionEvent {
private final List<EntityIdentifier> identifiers;
public SessionDefineEntitiesEvent(@NonNull GeyserConnection connection, @NonNull List<EntityIdentifier> identifiers) {
super(connection);
this.identifiers = identifiers;
}
/**
* Gets the list of entity identifiers.
*
* @return the list of entity identifiers
*/
@NonNull
public List<EntityIdentifier> entityIdentifiers() {
return this.identifiers;
}
/**
* Registers a new entity identifier for the player.
*
* @param entityIdentifier the entity identifier to register
* @return {@code true} if the entity identifier was registered, {@code false} otherwise
*/
public abstract boolean register(@NonNull EntityIdentifier entityIdentifier);
}

94
api/src/main/java/org/geysermc/geyser/api/event/java/ServerSpawnEntityEvent.java Normal file
View file

@ -0,0 +1,94 @@
/*
* Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @author GeyserMC
* @link https://github.com/GeyserMC/Geyser
*/
package org.geysermc.geyser.api.event.java;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.geysermc.geyser.api.connection.GeyserConnection;
import org.geysermc.geyser.api.entity.EntityDefinition;
import org.geysermc.geyser.api.event.connection.ConnectionEvent;
import java.util.UUID;
/**
* Called when the downstream server spawns an entity.
*/
public class ServerSpawnEntityEvent extends ConnectionEvent {
private final int entityId;
private final UUID uuid;
private EntityDefinition entityDefinition;
public ServerSpawnEntityEvent(@NonNull GeyserConnection connection, int entityId, @Nullable UUID uuid,
@NonNull EntityDefinition entityDefinition) {
super(connection);
this.entityId = entityId;
this.uuid = uuid;
this.entityDefinition = entityDefinition;
}
/**
* Gets the entity id of the entity being spawned.
*
* @return the entity id of the entity being spawned
*/
public int entityId() {
return this.entityId;
}
/**
* Gets the uuid of the entity being spawned.
*
* @return the uuid of the entity being spawned
*/
@Nullable
public UUID uuid() {
return this.uuid;
}
/**
* Gets the entity definition sent to the connection
* when the entity is spawned.
*
* @return the entity definition sent to the connection
* when the entity is spawned
*/
@NonNull
public EntityDefinition entityDefinition() {
return this.entityDefinition;
}
/**
* Sets the entity definition sent to the connection
* when the entity is spawned.
*
* @param entityDefinition the entity definition sent to the connection
* when the entity is spawned
*/
public void entityDefinition(@NonNull EntityDefinition entityDefinition) {
this.entityDefinition = entityDefinition;
}
}

2
api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCustomItemsEvent.java
View file

@ -36,7 +36,7 @@ import java.util.Map;
/**
* Called on Geyser's startup when looking for custom items. Custom items must be registered through this event.
*
* <p>
* This event will not be called if the "add non-Bedrock items" setting is disabled in the Geyser config.
*/
public interface GeyserDefineCustomItemsEvent extends Event {

58
api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineEntitiesEvent.java Normal file
View file

@ -0,0 +1,58 @@
/*
* Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @author GeyserMC
* @link https://github.com/GeyserMC/Geyser
*/
package org.geysermc.geyser.api.event.lifecycle;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.geysermc.event.Event;
import org.geysermc.geyser.api.entity.EntityDefinition;
import java.util.List;
/**
* Called when entities are defined within Geyser.
* <p>
* This event can be used to add custom entities to Geyser.
* Entity definitions can be created using the builder provided
* inside of {@link EntityDefinition}.
*/
public interface GeyserDefineEntitiesEvent extends Event {
/**
* Gets the list of entity definitions.
*
* @return the list of entity definitions
*/
@NonNull
List<EntityDefinition> entityDefinitions();
/**
* Registers a new entity definition.
*
* @param entityDefinition the entity definition to register
* @return {@code true} if the entity definition was registered, {@code false} otherwise
*/
boolean register(@NonNull EntityDefinition entityDefinition);
}