TraitWithRestrictions.java

/*******************************************************************************
 * Copyright 2014 Tobias Welther
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package de.tobiyas.racesandclasses.traitcontainer.interfaces.markerinterfaces;

import de.tobiyas.racesandclasses.eventprocessing.eventresolvage.EventWrapper;

public interface TraitWithRestrictions extends Trait {

	/**
	 * The ConfigTotal-Path to the Min Level to use
	 */
	public static final String MIN_LEVEL_PATH = "minLevel";
	
	/**
	 * The ConfigTotal-Path to the Max Level to use
	 */
	public static final String MAX_LEVEL_PATH = "maxLevel";
	
	/**
	 * The Biomes to use.
	 */
	public static final String BIOME_PATH = "biomes";

	/**
	 * The items needed to be weared
	 */
	public static final String WEARING_PATH = "wearing";

	/**
	 * Trait works only in water
	 */
	public static final String ONLY_IN_WATER_PATH = "onlyInWater";

	/**
	 * Trait works only on Land
	 */
	public static final String ONLY_ON_LAND_PATH = "onlyOnLand";

	/**
	 * Trait works only in Lava
	 */
	public static final String ONLY_IN_LAVA_PATH = "onlyInLava";
	
	/**
	 * Trait works only in Lava
	 */
	public static final String ONLY_ON_SNOW = "onlyOnSnow";	
	
	/**
	 * Trait has a Cooldown
	 */
	public static final String COOLDOWN_TIME_PATH = "cooldown";
	
	/**
	 * Trait works only on Day.
	 */
	public static final String ONLY_ON_DAY_PATH = "onlyOnDay";
	
	/**
	 * Trait only works in the Night.
	 */
	public static final String ONLY_IN_NIGHT_PATH = "onlyInNight";

	/**
	 * Trait only when it is raining.
	 */
	public static final String ONLY_IN_RAIN_PATH = "onlyInRain";

	/**
	 * Trait only trigger when gotten damaged.
	 */
	public static final String ONLY_AFTER_DAMAGED_PATH = "onlyAfterDamaged";

	/**
	 * Trait only trigger when gotten damaged.
	 */
	public static final String ONLY_AFTER_NOT_DAMAGED_PATH = "onlyAfterNotDamaged";

	/**
	 * Trait only trigger when gotten damaged.
	 */
	public static final String ONLY_WHILE_SNEAKING_PATH = "onlyWhileSneaking";
	
	/**
	 * Trait only trigger when gotten damaged.
	 */
	public static final String ONLY_WHILE_NOT_SNEAKING_PATH = "onlyWhileNotSneaking";
	
	/**
	 * Trait only when standing on a certain block.
	 */
	public static final String ONLY_ON_BLOCK_PATH = "onlyOnBlock";
	
	
	/**
	 * Trait only when standing on a certain block.
	 */
	public static final String NOT_ON_BLOCK_PATH = "notOnBlock";
	
	/**
	 * Trait only when above elevation
	 */
	public static final String ABOVE_ELEVATION_PATH = "aboveElevation";
	
	/**
	 * Trait only when below elevation
	 */
	public static final String BELOW_ELEVATION_PATH = "belowElevation";
	
	/**
	 * The Path to the Display Name
	 */
	public static final String DISPLAY_NAME_PATH = "displayName";
	
	/**
	 * The Path to the Description Name
	 */
	public static final String DESCRIPTION_PATH = "description";
	
	/**
	 * The Path to the Description Name
	 */
	public static final String NEEDED_PERMISSION_PATH = "neededPermission";
	
	/**
	 * The Path to the min Uplink showing Name
	 */
	public static final String MIN_UPLINK_SHOW_PATH = "minUplinkShow";
	
	/**
	 * The Path to disable uplink Notices
	 */
	public static final String DISABLE_COOLDOWN_NOTICE_PATH = "disableCooldownNotice";	
	
	/**
	 * The Path to see if the Trait is visible in the lists.
	 */
	public static final String VISIBLE_PATH = "visible";
	
	/**
	 * The Path to see if only on a specific world.
	 */
	public static final String ONLY_IN_WORLDS_PATH = "onlyInWorlds";

	
	
	/**
	 * Checks the Restrictions of the Trait
	 * for a player passed.
	 * 
	 * @param wrapper The wrapper for the Event that accumulates all Information
	 * 
	 * @return returns null if may be used. Returns the Reason if not useable.
	 */
	public TraitRestriction checkRestrictions(EventWrapper wrapper);
	
	/**
	 * Returns the total uplink time in seconds
	 * 
	 * @return the time in seconds
	 */
	public int getMaxUplinkTime();
	
	
	/**
	 * This is triggered when the User has uplink on the Skill,
	 * But would be triggered.
	 * <br> Returning TRUE does NOT paste the Uplink message!
	 * 
	 * @param wrapper The wrapper for the Event that accumulates all Information
	 * 
	 * @return true to NOT display uplink message!
	 */
	public boolean triggerButHasUplink(EventWrapper wrapper);
	
	
	/**
	 * Returns if the Trait should notify it's user everytime on trigger for the Uplink.
	 * 
	 * @param wrapper The wrapper for the Event that accumulates all Information
	 * 
	 * @return true if should, false if not.
	 */
	public boolean notifyTriggeredUplinkTime(EventWrapper wrapper);
	
	/**
	 * checks if the Trait is in level range.
	 * 
	 * @param level to check
	 * 
	 * @return true if it is, false if not.
	 */
	public boolean isInLevelRange(int level);
	
	
	/**
	 * The Spell triggered but has Restrictions blocking it.
	 * <br>This is an notice for the Trait if something else needs to be checked that has a bypass.
	 * 
	 * @param The restriction that triggered.
	 * @param wrapper The event that was triggered.
	 */
	public void triggerButHasRestriction(TraitRestriction restriction, EventWrapper wrapper);
	
	/**
	 * Returns the Cooldown name for the Trait.
	 * 
	 * @return cooldown name of the Trait.
	 */
	public String getCooldownName();
	
	
	/**
	 * Returns the Min-Level
	 * 
	 * @return Min level.
	 */
	public int getMinLevel();
	
	/**
	 * Returns the Max-Level
	 * 
	 * @return Max level.
	 */
	public int getMaxLevel();
	
}