spacetac/src/scripts/game/actions/BaseAction.ts

module SpaceTac.Game {
    "use strict";

    // Base class for action definitions
    export class BaseAction {
        // Identifier code for the type of action
        code: string;

        // Boolean at true if the action needs a target
        needs_target: boolean;

        // Create the action
        constructor(code: string, needs_target: boolean) {
            this.code = code;
            this.needs_target = needs_target;
        }

        // Check basic conditions to know if the ship can use this action at all
        //  Method to reimplement to set conditions
        canBeUsed(battle: Battle, ship: Ship): boolean {
            return true;
        }

        // Method to check if a target is applicable for this action
        //  Will call checkLocationTarget or checkShipTarget by default
        checkTarget(battle: Battle, ship: Ship, target: Target): Target {
            if (!this.canBeUsed(battle, ship)) {
                return null;
            } else if (target) {
                if (target.ship) {
                    return this.checkShipTarget(battle, ship, target);
                } else {
                    return this.checkLocationTarget(battle, ship, target);
                }
            } else {
                return null;
            }
        }

        // Method to reimplement to check if a space target is applicable
        //  Must return null if the target can't be applied, an altered target, or the original target
        checkLocationTarget(battle: Battle, ship: Ship, target: Target): Target {
            return null;
        }

        // Method to reimplement to check if a ship target is applicable
        //  Must return null if the target can't be applied, an altered target, or the original target
        checkShipTarget(battle: Battle, ship: Ship, target: Target): Target {
            return null;
        }

        // Apply an action, returning true if it was successful
        apply(battle: Battle, ship: Ship, target: Target): boolean {
            if (this.canBeUsed(battle, ship)) {
                target = this.checkTarget(battle, ship, target);
                if (!target && this.needs_target) {
                    return false;
                }
                return this.customApply(battle, ship, target);
            } else {
                return false;
            }
        }

        // Method to reimplement to apply a action
        protected customApply(battle: Battle, ship: Ship, target: Target): boolean {
            return false;
        }
    }
}