// brief.js
// OK 09 2023
(function () {
  /* global AdventureJS A */

  /**
   * @augments {AdventureJS.Dictionary.Verb}
   * @class brief
   * @ajsnode game.dictionary.verbs.brief
   * @ajsconstruct MyGame.createVerb({ "name": "brief", [...] });
   * @ajsconstructedby AdventureJS.Dictionary#createVerb
   * @hideconstructor
   * @ajsinstanceof Verb
   * @ajsnavheading UtilityVerbs
   * @summary Verb meaning show brief room descriptions.
   * @tutorial BasicVerbs_Subscriptions
   * @tutorial Reference_HowAVerbIsBuilt
   * @tutorial Reference_HowAVerbWorks
   * @tutorial AdvancedVerbs_ModifyVerbs
   * @tutorial AdvancedVerbs_ModifyVerbs
   * @classdesc
   * <div class="display">
   * <div class="ajs-player-input">&gt; brief</div>
   * <div class="ajs-p">Ok, I'll show shorter room descriptions.</div>
   * </div>
   * <p>
   * <strong>brief</strong> displays short {@link AdventureJS.Assets.Room|Room}
   * descriptions if the author has provided them.
   * </p>
   */
  A.Dictionary.VerbDefinitions.brief = {
    name: "brief",
    synonyms: [],

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

    do: function () {
      var input = this.game.getInput();
      var verb_phrase = input.verb_phrase;
      if (this.game.settings.verbosity > this.game.settings.min_verbosity) {
        this.game.settings.verbosity -= 1;
      }
      var msg = "Ok, I'll try to show shorter room descriptions. ";
      if (msg) this.game.print(msg, input.output_class);
      return true;
    },
  };
})();