com.sucy.skill.api.util.FlagManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proskillapi Show documentation
A Minecraft Bukkit plugin aiming to provide an easy code API and skill editor for all server owners to create unique and fully custom classes and skills.
There is a newer version: 1.3.1-R1
Show newest version
/**
 * SkillAPI
 * com.sucy.skill.api.util.FlagManager
 * 
 * The MIT License (MIT)
 * 

 * Copyright (c) 2014 Steven Sucy
 * 

 * 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.sucy.skill.api.util;

import org.bukkit.entity.LivingEntity;

import java.util.HashMap;
import java.util.Map;

/**
 * The manager for temporary entity flag data
 */
public class FlagManager {
    private static final Map data = new HashMap<>();

    /**
     * Retrieves the flag data for an entity. This creates new data if
     * no existing data is found.
     *
     * @param entity entity to retrieve the data for
     * @return the flag data for the entity
     */
    public static FlagData getFlagData(LivingEntity entity) {
        return getFlagData(entity, true);
    }

    /**
     * Retrieves the flag data for an entity, optionally creating new data
     * if none currently exists. If set to false, this will return null
     * if no data currently exists.
     *
     * @param entity entity to get the flag data for
     * @param create whether to create new data if it doesn't exist
     * @return the flag data for an enemy
     */
    public static FlagData getFlagData(LivingEntity entity, boolean create) {
        if (entity == null) {
            return null;
        }
        if (!data.containsKey(entity.getEntityId()) && create) {
            data.put(entity.getEntityId(), new FlagData(entity));
        }
        return data.get(entity.getEntityId());
    }

    /**
     * Adds a flag to an entity
     *
     * @param entity entity to add the flag to
     * @param flag   the flag to add
     * @param ticks  the duration to add the flag for
     */
    public static void addFlag(LivingEntity entity, String flag, int ticks) {
        FlagData data = getFlagData(entity, true);
        if (data != null) {
            data.addFlag(flag, ticks);
        }
    }

    /**
     * Removes the flag from an entity
     *
     * @param entity entity to remove the flag from
     * @param flag   flag to remove
     */
    public static void removeFlag(LivingEntity entity, String flag) {
        FlagData data = getFlagData(entity, false);
        if (data != null) {
            data.removeFlag(flag);
        }
    }

    /**
     * Checks whether the entity has the given flag
     *
     * @param entity the entity to check for
     * @param flag   the flag to check for
     * @return true if the flag is active on the entity, false otherwise
     */
    public static boolean hasFlag(LivingEntity entity, String flag) {
        return entity != null && data.containsKey(entity.getEntityId()) && getFlagData(entity, false).hasFlag(flag);
    }

    /**
     * Retrieves the time left on a flag for an entity
     *
     * @param entity entity to get the time for
     * @param flag   flag to get the time for
     * @return time left on the flag in seconds for the entity
     */
    public static int getTimeLeft(LivingEntity entity, String flag) {
        if (entity == null) {
            return 0;
        }
        return data.containsKey(entity.getEntityId()) ? getFlagData(entity).getSecondsLeft(flag) : 0;
    }

    /**
     * Clears the flags for an entity
     *
     * @param entity entity to clear the flags for
     */
    public static void clearFlags(LivingEntity entity) {
        if (entity == null) {
            return;
        }
        FlagData result = data.remove(entity.getEntityId());
        if (result != null) {
            result.clear();
        }
    }
}