com.github.juliarn.npclib.api.Platform Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of npc-lib-api Show documentation
Abstract NPC-Library for Minecraft 1.8+ Servers
The newest version!
/*
 * This file is part of npc-lib, licensed under the MIT License (MIT).
 *
 * Copyright (c) 2022-2023 Julian M., Pasqual K. and contributors
 *
 * 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 com.github.juliarn.npclib.api;

import com.github.juliarn.npclib.api.event.manager.NpcEventManager;
import com.github.juliarn.npclib.api.log.PlatformLogger;
import com.github.juliarn.npclib.api.profile.ProfileResolver;
import com.github.juliarn.npclib.api.protocol.PlatformPacketAdapter;
import java.util.Optional;
import java.util.function.Consumer;
import org.jetbrains.annotations.NotNull;

public interface Platform {

  boolean debug();

  @NotNull E extension();

  @NotNull PlatformLogger logger();

  @NotNull NpcEventManager eventManager();

  @NotNull NpcTracker npcTracker();

  @NotNull ProfileResolver profileResolver();

  @NotNull PlatformTaskManager taskManager();

  @NotNull Npc.Builder newNpcBuilder();

  @NotNull PlatformVersionAccessor versionAccessor();

  @NotNull PlatformWorldAccessor worldAccessor();

  @NotNull PlatformPacketAdapter packetFactory();

  @NotNull Optional actionController();

  interface Builder {

    @NotNull Builder debug(boolean debug);

    @NotNull Builder extension(@NotNull E extension);

    @NotNull Builder logger(@NotNull PlatformLogger logger);

    @NotNull Builder eventManager(@NotNull NpcEventManager eventManager);

    @NotNull Builder npcTracker(@NotNull NpcTracker npcTracker);

    @NotNull Builder taskManager(@NotNull PlatformTaskManager taskManager);

    @NotNull Builder profileResolver(@NotNull ProfileResolver profileResolver);

    @NotNull Builder worldAccessor(@NotNull PlatformWorldAccessor worldAccessor);

    @NotNull Builder versionAccessor(@NotNull PlatformVersionAccessor versionAccessor);

    @NotNull Builder packetFactory(@NotNull PlatformPacketAdapter packetFactory);

    @NotNull Builder actionController(@NotNull Consumer decorator);

    @NotNull Platform build();
  }
}