// examine.js

(function () {
  /*global adventurejs A*/

  /**
   * @augments {adventurejs.Verb}
   * @class examine
   * @ajsnode game.dictionary.verbs.examine
   * @ajsconstruct MyGame.createVerb({ "name": "examine", [...] });
   * @ajsconstructedby adventurejs.Dictionary#createVerb
   * @hideconstructor
   * @ajsinstanceof Verb
   * @ajsnavheading SensationVerbs
   * @summary Verb meaning examine an asset.
   * @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; examine foot</span>
   * You examine the elephant's foot. Among the numerous black
   * umbrellas parked in it, one yellow umbrella stands out.
   * </pre>
   * <p>
   * <strong>Examine</strong> an {@link adventurejs.Asset|Asset}
   * returns a description of the Asset. Examine extends core verb
   * <a href="look.html">look</a>, passing queries through to look.
   * Why is examine a passthrough verb rather than a core verb?
   * Though the word "examine" is a bedroock convention
   * of text adventures, the word "look" isn't a universal way of
   * interacting with things. Let's imagine that you want to make a game
   * about a sightless character; you might, for example, repurpose
   * examine to extend <a href="feel.html">feel</a> instead.
   * </p>
   * @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
   */
  A.Preverbs.examine = {
    name: "examine",
    prettyname: "examine",
    past_tense: "examined",
    synonyms: ["examine", "x"],
    type: { sensory: true },
    extends: { look: true },
    gerund: "examining",

    /**
     * @ajsverbstructures
     * @memberof examine
     * Examine asset with/through asset is the same as look at asset with/through asset.
     * Examples:
     * examine asset with x-ray machine
     * examine slide through microscope
     * examine water in bucket
     */
    accepts_structures: [
      "verb noun", // examine asset
      "verb preposition noun", // examine in drain // bad grammar, but allowed
      "verb noun preposition noun", // examine asset in asset, examine asset with/through asset
      "verb noun preposition noun preposition noun", // examine asset in asset with/through asset
      // examine water on slide through microscope
    ],

    /**
     * @ajsadverbs
     * @memberof examine
     */
    accepts_adverbs: ["carefully"],

    /**
     * @memberof examine
     * @ajsverbphrase
     * phrase1:
     * {
     *   accepts_noun:true,
     *   requires_noun:true,
     *   noun_must_be:
     *   {
     *     known: true,
     *     matter: true,
     *     present: true,
     *     visible: true,
     *   },
     * },
     */
    phrase1: {
      accepts_noun: true,
      requires_noun: true,
      noun_must_be: {
        known: true,
        matter: true,
        present: true,
        visible: true,
      },
      accepts_preposition: true,
      accepts_preposition_without_noun: true,
    },

    /**
     * @memberof examine
     * @ajsverbphrase
     * phrase2:
     * {
     *   accepts_noun:true,
     *   noun_must_be:
     *   {
     *     known: true,
     *     matter: true,
     *     present: true,
     *     visible: true,
     *   },
     *   accepts_preposition:true,
     *   requires_preposition:true,
     * },
     */
    phrase2: {
      accepts_noun: true,
      noun_must_be: {
        known: true,
        matter: true,
        present: true,
        visible: true,
      },
      accepts_preposition: true,
      requires_preposition: true,
    },

    /**
     * @memberof examine
     * @ajsverbparams
     * with_params: {
     * },
     */
    with_params: {
      must_be_worn: false,
      must_be_held: false,
    },

    msgNoObject: "What did you want to examine?",

    doTry: function () {
      var input = this.game.getInput();
      var verb_phrase = input.verb_phrase;
      input.setPreposition(1, "at");
      input.updateStructure();
      return this.game.dictionary.doVerb("look");
    }, // doTry

    doSuccess: function () {
      return this.handleSuccess();
    },
  };
})(); // examine