mirror of
https://github.com/GeyserMC/Geyser.git
synced 2024-08-14 23:57:35 +00:00
ce4866156d
Allows for creating custom entity definitions upon registration as well as modifying existing entity spawns to use custom entity identifiers.
58 lines
No EOL
2.1 KiB
Java
58 lines
No EOL
2.1 KiB
Java
/*
|
|
* 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);
|
|
} |