// forward.js
(function () {
  /*global adventurejs A*/

  /**
   * @augments {adventurejs.Verb}
   * @class forward
   * @ajsnode game.dictionary.verbs.forward
   * @ajsconstruct MyGame.createVerb({ "name": "forward", [...] });
   * @ajsconstructedby adventurejs.Dictionary#createVerb
   * @hideconstructor
   * @ajsinstanceof Verb
   * @ajsnavheading DirectionVerbs
   * @summary Verb meaning to move forward.
   * @tutorial Scripting_VerbSubscriptions
   * @tutorial Verbs_VerbAnatomy
   * @tutorial Verbs_VerbProcess
   * @tutorial Verbs_ModifyVerbs
   * @tutorial Verbs_WriteVerbs
   * @classdesc
   * <pre class="display border outline">
   * <span class="input">&gt; forward</span>
   * You march bravely forward, sweating in your woolen
   * band uniform, weighed down by your heavy sousaphone.
   * Why-oh-why did you choose a brass instrument?
   * </pre>
   * <p>
   * Direction verb: go <strong>forward</strong>. Because forward is a relative
   * direction, it's assumed that there probably won't be a forward exit, though
   * it does support one. The verb logic looks for a fore exit first,
   * which would be forward in nautical terms, then looks for a forward exit,
   * then defaults to telling the player they move forward. Useful if you want
   * to let a player navigate a dungeon using relative directions.
   * To learn about {@link adventurejs.Exit|Exits},
   * see <a href="/doc/GetStarted_CreateAnExit.html">Create an Exit</a>.
   * </p>
   * @ajsverbreactions doRemoveThisFromThat, doRemoveThatFromThis, doMoveThisToThat, doMoveThatToThis
   * @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
   */
  A.Preverbs.forward = {
    name: "forward",
    is_direction: true,
    is_relative_direction: true,
    synonyms: ["forward", "forwards"],
    type: { direction: true },
    adjective: "forward",
    article: "",

    /**
     * @ajsverbstructures
     * @memberof forward
     */
    accepts_structures: ["verb"],

    doTry: function () {
      var results;
      if (this.game.getCurrentRoom().exits.fore) {
        results = this.game.tryTravel("fore");
        if (!results) {
          this.handleFailure();
        }
      } else if (this.game.getCurrentRoom().exits.forward) {
        results = this.game.tryTravel("forward");
        if (!results) {
          this.handleFailure();
        }
        return results;
      }
      return true;
    },

    doSuccess: function () {
      // compose output
      var msg = `$(We) move ${this.name} a bit. `;

      // print output
      return this.handleSuccess(msg);
    },
  };
})();