ViaVersion/common/src/main/java/com/viaversion/viaversion/rewriter/meta/MetaHandlerEvent.java

/*
 * This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
 * Copyright (C) 2016-2021 ViaVersion and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.viaversion.viaversion.rewriter.meta;

import com.viaversion.viaversion.api.connection.UserConnection;
import com.viaversion.viaversion.api.minecraft.entities.EntityType;
import com.viaversion.viaversion.api.minecraft.metadata.Metadata;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.List;

public interface MetaHandlerEvent {

    /**
     * Returns the user connection the metadata is sent to.
     *
     * @return user connection
     */
    UserConnection user();

    /**
     * Returns the entity id of the entity.
     *
     * @return entity id
     */
    int entityId();

    /**
     * Returns the entity type of the entity the metadata belongs to.
     *
     * @return entity type of the entity
     */
    EntityType entityType();

    /**
     * Returns the metadata index.
     *
     * @return return meta index
     */
    int index();

    /**
     * Sets the metadata index.
     *
     * @param index new metadata index
     */
    void setIndex(int index);

    /**
     * Returns the metadata by the given index if present.
     *
     * @param index metadata index
     * @return metadata by index if present
     */
    @Nullable Metadata getMetaByIndex(int index);

    /**
     * Returns the metadata.
     * Do NOT call {@link Metadata#setId(int)} and instead use {@link MetaHandlerEvent#setIndex(int)}.
     *
     * @return return metadata
     */
    Metadata meta();

    /**
     * Prevents other handlers from being called with this metadata entry and removes it from the list.
     */
    void cancel();

    /**
     * Returns whether this metadata entry should be removed.
     *
     * @return true if cancelled/removed
     */
    boolean cancelled();

    /**
     * Returns an immutable metadata view.
     *
     * @return immutable metadata list
     * @see #cancel()
     * @see #createExtraMeta(Metadata)
     */
    List<Metadata> metadataList();

    /**
     * Returns additionally created metadata.
     * May be null; use {@link #createExtraMeta(Metadata)} for adding metadata.
     *
     * @return additionally created metadata if present
     */
    @Nullable List<Metadata> extraMeta();

    /**
     * Adds the given metadata to the metadata list.
     * This metadata will not be passed through handlers of the current loop.
     *
     * @param metadata metadata
     */
    void createExtraMeta(Metadata metadata);

    /**
     * Clears the additional metadata.
     */
    void clearExtraMeta();
}