/*
 * MIT License
 *
 * Copyright (c) 2020 Azercoco & Technici4n
 *
 * 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.
 */

package aztech.modern_industrialization.machines.gui;

import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.resources.ResourceLocation;

/**
 * Server part of a synced component.
 *
 * @param <P> Parameters, synced to the client when the menu is opened.
 * @param <D> Data synced to the client when the menu is opened and when it changes. Must be equals-comparable.
 */
public interface GuiComponentServer<P, D> extends GuiComponent {
    P getParams();

    /**
     * Extracts the syncable data from the state of the component, block entity, etc.
     */
    D extractData();

    /**
     * Return the id of the component. Must match that of the {@code GuiComponentClient}
     * registered with {@code GuiComponentsClient#register}.
     */
    Type<P, D> getType();

    record Type<P, D>(
            ResourceLocation id,
            StreamCodec<? super RegistryFriendlyByteBuf, P> paramsCodec,
            StreamCodec<? super RegistryFriendlyByteBuf, D> dataCodec) {}
}
