Trait.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 java.util.List;
import java.util.Map;
import java.util.Set;

import de.tobiyas.racesandclasses.datacontainer.traitholdercontainer.AbstractTraitHolder;
import de.tobiyas.racesandclasses.eventprocessing.eventresolvage.EventWrapper;
import de.tobiyas.racesandclasses.playermanagement.player.RaCPlayer;
import de.tobiyas.racesandclasses.traitcontainer.interfaces.TraitResults;
import de.tobiyas.racesandclasses.traitcontainer.interfaces.annotations.configuration.TraitConfigurationNeeded;
import de.tobiyas.racesandclasses.traitcontainer.interfaces.annotations.configuration.TraitEventsUsed;
import de.tobiyas.racesandclasses.traitcontainer.interfaces.annotations.configuration.TraitInfos;
import de.tobiyas.racesandclasses.util.traitutil.TraitConfiguration;
import de.tobiyas.racesandclasses.util.traitutil.TraitConfigurationFailedException;

public interface Trait extends Comparable<Trait>, SkillTreeTrait {
	
	/**
	 * This method is called when the Trait is load the first time.
	 * <br>
	 * <br>IMPORTATNT: This method has to be annotated with {@link TraitInfos}
	 * <br>For Example: @TraitInfos(traitName="DummyTrait", category="Useless")
	 */
	public void importTrait();
	
	
	/**
	 * This method is called after creation of the Trait.
	 * <br>The {@link AbstractTraitHolder} is already set to this time.
	 * <br>The ConfigTotal is already set.
	 * <br>
	 * <br>IMPORTATNT: This method has to be annotated with {@link TraitEventsUsed}
	 * <br>For Example: @TraitEventsUsed(registerdClasses = {EntityDamageByEntityDoubleEvent.class})
	 */
	public void generalInit();
	
	
	/**
	 * Indicates that the Trait is beeing destroyed and should unregister all stuff allocated.
	 */
	public void deInit();
	
	
	/**
	 * Returns the name of the Trait
	 * <br>This must be a atomar Action! 
	 * <br>Always return a String that is NO variable!!!
	 * 
	 * @return Name of the Trait.
	 */
	public String getName();
	
	
	/**
	 * gets a string representation of the Configuration
	 * @return
	 */
	public String getPrettyConfiguration();
	
	

	/**
	 * Sets the Configuration of the Trait
	 * 
	 * <br>IMPORTATNT: This method has to be annotated with {@link TraitConfigurationNeeded}
	 * <br>For Example: @TraitConfigurationNeeded({ @TraitConfigurationField("value", "Integer.class") })
	 * 
	 * @param map to set the config with.
	 * 
	 * @throws throws an ConfigTotal Exception if something gone wrong with configuring.
	 */
	public void setConfiguration(TraitConfiguration configurationMap) throws TraitConfigurationFailedException;
	
	
	/**
	 * Returns a list of optional ConfigTotal fields.
	 * 
	 * @return the List of optional ConfigTotal Fields.
	 */
	public List<String> getOptionalConfigFields();
	
	/**
	 * Returns the ConfigTotal passed in {@link #setConfiguration(Map)}.
	 * 
	 * @return the map of the config already passed.
	 */
	public TraitConfiguration getCurrentconfig();
	
	/**
	 * The general modify that is called, when the event wanted triggered.
	 * 
	 * @param event the event that triggered the Trait
	 * 
	 * @return the Trait result.
	 */
	public TraitResults trigger(EventWrapper wrapper);
	
	
	/**
	 * Indecates if the same trait, but with different config is better.
	 * 
	 * @param trait
	 * @return
	 */
	public boolean isBetterThan(Trait trait);

	
	/**
	 * Setter for the TraitHolder.
	 * This is called after Init.
	 * 
	 * @param abstractTraitHolder
	 */
	public void addTraitHolder(AbstractTraitHolder abstractTraitHolder);
	
	
	/**
	 * Returns the TraitHolders that this Trait belongs to.
	 * @return
	 */
	public Set<AbstractTraitHolder> getTraitHolders();


	/**
	 * Checks if the Trait can be triggered.
	 * <br>Already checked are: 
	 * <br>* Trait belongs to the Player.
	 * <br>* If Trait has any Uplink / Mana Restrictions
	 * 
	 * @param wrapper that is to be triggered
	 * 
	 * @return true if all Trait preconditions are checked
	 */
	public boolean canBeTriggered(EventWrapper wrapper);
	
	
	/**
	 * Returns if the Trait is Stackable.
	 * 
	 * This means a player can have this Trait more that 1 time.
	 * 
	 * @return true if stackable, false if not.
	 */
	public boolean isStackable();
	
	/**
	 * Returns the Display name of the Trait.
	 * <br>The DisplayName is by default the TraitName
	 * 
	 * @return the DisplayName of the Trait.
	 */
	public String getDisplayName();
	
	/**
	 * Returns if the Trait is visible.
	 * 
	 * @return returns true if visible.
	 */
	public boolean isVisible();


	/**
	 * Returns true if the Trait is bindable.
	 * 
	 * @return false if not bindable.
	 */
	public boolean isBindable();
	
	/**
	 * The Trait gets triggered by the bind action.
	 * 
	 * @param player that used the Trait
	 * @return the reuslt of the Trigger.
	 */
	public TraitResults triggerOnBind(RaCPlayer player);


	/**
	 * This trait names replaces other traits.
	 * @return the traits this trait replaces.
	 */
	public List<String> getReplacesOtherTraits();
}