/*
 * Copyright 2014 Gabriel Harris-Rouquette
 *
 * 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 com.afterkraft.kraftrpg.api.skills;


public enum SkillCastResult {

    /**
     * Generic success. <b>(Success)</b>
     */
    NORMAL,
    /**
     * The caster is dead.
     */
    DEAD,
    /**
     * The caster can't use this skill.
     */
    NOT_AVAILABLE,
    /**
     * Can't pay mana cost.
     */
    LOW_MANA,
    /**
     * Can't pay health cost.
     */
    LOW_HEALTH,
    /**
     * Can't pay hunger (stamina) cost.
     */
    LOW_STAMINA,
    /**
     * Can't pay reagent (Item) cost.
     */
    MISSING_REAGENT,
    /**
     * The skill can't be used in combat, but you're in combat.
     */
    NO_COMBAT,
    // ------
    // Stalled
    /**
     * A Stalled use of the skill was started. <b>(Success)</b>
     */
    START_DELAY,
    /**
     * The Stalled use of the skill was cancelled.
     */
    EVENT_CANCELLED,
    /**
     * The skill can't be used due to something about the current Stalled
     * skill.
     */
    STALLING_FAILURE,
    // ------
    /**
     * The Global Cooldown is active.
     */
    ON_GLOBAL_COOLDOWN,
    /**
     * The skill is on cooldown.
     */
    ON_COOLDOWN,
    ON_WARMUP,
    INVALID_TARGET,
    FAIL,
    REMOVED_EFFECT,
    SKIP_POST_USAGE,
    UNTARGETTABLE_TARGET,
    /**
     * The skill has sent its own message, and the caller should not print
     * one.
     */
    CUSTOM_NO_MESSAGE,
    /**
     * The provided arguments do not make sense for the skill.
     */
    SYNTAX_ERROR
}

@@ -1758,74 +1758,368 @@
     
-INVALID_TARGET,%0A    FAIL,%0A    REMOVED_EFFECT,%0A    SKIP_POST_USAGE,
+/**%0A     * The skill failed.%0A     */%0A    FAIL,%0A    /**%0A     * XXX what is this%0A     */%0A    REMOVED_EFFECT,%0A    /**%0A     * XXX what is this%0A     */%0A    SKIP_POST_USAGE,%0A    /**%0A     * The skill has decided that the provided target is invalid.%0A     */%0A    INVALID_TARGET,%0A    /**%0A     * The skill has decided that the caster isn't allowed to target this.%0A     */
 %0A   

Add comments to last SkillCastResults