// east.js
// OK 09 2023
(function () {
  /*global adventurejs A*/
  "use strict";

  /**
   * @augments {adventurejs.Verb}
   * @class east
   * @ajsnode game.dictionary.verbs.east
   * @ajsconstruct MyGame.createVerb({ "name": "east", [...] });
   * @ajsconstructedby adventurejs.Dictionary#createVerb
   * @hideconstructor
   * @ajsinstanceof Verb
   * @ajsnavheading DirectionVerbs
   * @summary Verb meaning travel east.
   * @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; east</span>
   * You travel toward the rising sun and eventually die in horrible fire.
   * </pre>
   * <p>
   * Direction verb: go <strong>east</strong>.
   * To learn about {@link adventurejs.Exit|Exits},
   * see <a href="/doc/GetStarted_CreateAnExit.html">Create an Exit</a>.
   * </p>
   * @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
   */
  A.Preverbs.east = {
    name: "east",
    is_direction: true,
    is_compass_direction: true,
    synonyms: ["east", "e", "eastward"],
    adjectives: ["eastern", "easterly", "easternly"],
    article: "the",
    type: { direction: true },

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

    doSuccess: function (params) {
      this.game.tryTravel(this.name);
      return true;
    },
  };
})();