// WritingSurface.js
(function () {
  /*global adventurejs A*/
  "use strict";

  /**
   * @ajspath adventurejs.Atom.Asset.Matter.Tangible.Thing.WritingSurface
   * @augments adventurejs.Thing
   * @class adventurejs.WritingSurface
   * @ajsconstruct MyGame.createAsset({ "class":"WritingSurface", "name":"foo", [...] })
   * @ajsconstructedby adventurejs.Game#createAsset
   * @ajsnavheading WritingClasses
   * @param {String} game_name The name of the top level game object.
   * @param {String} name A name for the object, to be serialized and used as ID.
   * @summary A surface that can be written on and erased.
   * @classdesc
   * <p>
   * <strong>WritingSurface</strong> is a subclass of
   * {@link adventurejs.Thing|Thing} with its
   * <code class="property">asset.dov.write.enabled</code> and
   * <code class="property">asset.dov.erase.enabled</code> properties set to true.
   * <code class="property">asset.dov.write.enabled</code> allows it to receive
   * strings using the
   * {@link adventurejs.Verb|Verb} {@link write}.
   * <code class="property">asset.dov.erase.enabled</code>
   * allows it to be erased and
   * <code class="property">asset.dov.erase.with_nothing</code>
   * allows it to be erased without an eraser.
   * With WritingSurface's
   * <code class="property">append_written_strings_to_description</code>
   * property set to true, anything written
   * on it can be included in the WritingSurface's description.
   * </p>
   * <pre class="display border outline">
   * <span class="input">&gt; write "I will not poop in class" on blackboard
   * You write "I will not poop in class" on the blackboard with the chalk.
   *
   * <span class="input">&gt; examine blackboard
   * It's a big blackboard. Written on it is a phrase: "I will not poop in class".
   * </pre>
   * <h3 class="examples">Example:</h3>
   * <pre class="display"><code class="language-javascript">MyGame.createAsset({
   *   class: "Blackboard",
   *   name: "blackboard",
   *   descriptions: { look: "It's a big gradeschool-style blackboard. ", },
   *   place: { in: "Schoolroom" },
   * });
   * </code></pre>
   **/
  class WritingSurface extends adventurejs.Thing {
    constructor(name, game_name) {
      super(name, game_name);
      this.class = "WritingSurface";

      this.setDOVs(["write", "erase"]);

      this.append_written_strings_to_description = true;
    }
  }
  adventurejs.WritingSurface = WritingSurface;
})();