INpcTraits.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * 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.jcwhatever.nucleus.providers.npc.traits;

import com.jcwhatever.nucleus.providers.kits.IKit;
import com.jcwhatever.nucleus.providers.npc.INpc;
import org.bukkit.entity.EntityType;

import javax.annotation.Nullable;
import java.util.Collection;

/**
 * Interface for a trait manager whose instances are paired
 * to an {@link com.jcwhatever.nucleus.providers.npc.INpc} instance.
 */
public interface INpcTraits {

    /**
     * Get the owning {@link INpc} instance.
     */
    INpc getNpc();

    /**
     * Determine if the NPC is vulnerable to damage.
     */
    boolean isVulnerable();

    /**
     * Change the NPC vulnerability setting.
     *
     * @param isVulnerable  True to make the Npc vulnerable to damage, otherwise false.
     *
     * @return  Self for chaining.
     */
    INpcTraits setVulnerable(boolean isVulnerable);

    /**
     * Get the NPC entity type.
     */
    EntityType getType();

    /**
     * Set the NPC entity type.
     *
     * @param type  The entity type.
     *
     * @return  Self for chaining.
     */
    INpcTraits setType(EntityType type);

    /**
     * Get the name of the skin to use.
     *
     * <p>If a custom skin is not set or the NPC is not capable of having a
     * custom skin set, then the NPC's name is returned.</p>
     *
     * @return  The name of the skin in use.
     */
    String getSkinName();

    /**
     * Set the skin name of the NPC.
     *
     * <p>This has no effect if the NPC is not capable of having its skin changed.</p>
     *
     * @param skinName  The name of the skin to use. Null to remove custom skin.
     *
     * @return  Self for chaining.
     */
    INpcTraits setSkinName(@Nullable String skinName);

    /**
     * Set the skin name of the NPC.
     *
     * <p>This has no effect if the NPC is not capable of having its skin changed.</p>
     *
     * @param skinName  The name of the skin to use.
     * @param fileName  The name of the file to import from or export to. If the file exists,
     *                  the skin data is imported, otherwise the skin data for the specified
     *                  skinName is exported. The implementation is responsible for the location
     *                  of the file.
     *
     * @return  Self for chaining.
     */
    INpcTraits setSkinName(String skinName, String fileName);

    /**
     * Determine if the NPC is shown in the player tab list.
     *
     * <p>If the NPC is not a player entity, this always returns false.</p>
     */
    boolean isShownInTabList();

    /**
     * Set the NPC shown in player tab list flag.
     *
     * <p>This has no effect if te NPC is not capable of being shown in the player tab list.</p>
     *
     * @param isShownInList  True to show in tab list, otherwise false.
     *
     * @return  Self for chaining.
     */
    INpcTraits setShownInTabList(boolean isShownInList);

    /**
     * Get the kit the NPC is spawned with.
     *
     * @return The {@link IKit} or null if one is not set.
     */
    @Nullable
    IKit getKit();

    /**
     * Set the kit the NPC is spawned with.
     *
     * <p>If the NPC is already spawned, the kit is also applied to the spawned entity.</p>
     *
     * @param kit  The {@link IKit} or null to remove kit.
     *
     * @return  Self for chaining.
     */
    INpcTraits setKit(@Nullable IKit kit);

    /**
     * Set the kit using the name of the kit.
     *
     * <p>Generally, the kit is pulled from the Nucleus kit manager, however the provider
     * implementation may differ.</p>
     *
     * @param kitName  The name of the kit or null to remove.
     *
     * @return  Self for chaining.
     */
    INpcTraits setKitName(@Nullable String kitName);

    /**
     * Get all of the NPC's traits.
     *
     * <p>The collection returned cannot be used to modify the internal collection.</p>
     */
    Collection<NpcTrait> all();

    /**
     * Add a new trait to the NPC.
     *
     * <p>If the trait is already added, the existing instance is returned.</p>
     *
     * @param name  The name of the trait type to add. The trait type must be registered with
     *              the NPC provider or the NPC's registry.
     *
     * @return  The instance of the trait or null if the trait type was not found.
     */
    @Nullable
    NpcTrait add(String name);

    /**
     * Add a new trait to the NPC.
     *
     * <p>If a trait of the same type is already added, no action is taken.</p>
     *
     * @param trait  The trait instance.
     *
     * @return  Self for chaining.
     */
    INpcTraits add(NpcTrait trait);

    /**
     * Get a trait from the NPC by trait type name.
     *
     * @param name  The name of the trait type.
     *
     * @return  The trait or null if not found.
     */
    @Nullable
    NpcTrait get(String name);

    /**
     * Determine if the NPC has a trait by the specified name.
     *
     * @param name  The name of the trait to check.
     */
    boolean has(String name);

    /**
     * Determine if the NPC has a trait by the specified name and if so,
     * is it enabled.
     *
     * @param name  The name of the trait to check.
     *
     * @return  True if the NPC has the trait and it is enabled. False if the NPC
     * does not have the trait or the trait is disabled.
     */
    boolean isEnabled(String name);

    /**
     * Remove a trait from the NPC.
     *
     * @param name  The name of the trait to remove.
     *
     * @return  True if the trait was found and removed.
     */
    boolean remove(String name);
}