Pre-release
AdventureJS Docs Downloads
Score: 0 Moves: 0
// Whiteboard.js
(function () {
  /* global AdventureJS A */

  /**
   * @ajspath AdventureJS.Atom.Asset.Matter.Tangible.Thing.WritingSurface.Whiteboard
   * @augments AdventureJS.Assets.WritingSurface
   * @class AdventureJS.Assets.Whiteboard
   * @ajsconstruct MyGame.createAsset({ "class":"Whiteboard", "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 whiteboard that can be written on and erased.
   * @tutorial Tangibles_AboutTangibles
   * @ajsdemo WritingDemo, Office, Playroom, Classroom, Library, Scorecard
   * @ajscss Styles
   * @classdesc
   * <p>
   * <strong>Whiteboard</strong> is a subclass of
   * {@link AdventureJS.Assets.WritingSurface|WritingSurface} with
   * asset.dov.write.enabled and
   * asset.dov.erase.enabled set to true.
   * <code class="property">asset.dov.write</code>
   * allows it to receive strings using the
   * {@link AdventureJS.Dictionary.Verb|Verb} {@link write}.
   * <code class="property">asset.dov.erase</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 Whiteboard's
   * <code class="property">append_written_strings_to_description</code>
   * property set to true, anything written
   * on it can be included in the Whiteboard's description.
   * </p>
   * <div class="display">
   * <div class="ajs-player-input">&gt; write "I am good at business" on whiteboard</div>
   * <div class="ajs-p">You write "I am good at business" on the whiteboard with the chalk.</div>
   *
   * <div class="ajs-player-input">&gt; examine whiteboard</div>
   * <div class="ajs-p">It's a big whiteboard. Written on it is a phrase: "I am good at business".</div>
   * </div>
   * <h3 class="examples">Example:</h3>
   * <pre class="display"><code class="language-javascript">MyGame.createAsset({
   *   class: "Whiteboard",
   *   name: "whiteboard",
   *   descriptions: { look: "It's a big office-style whiteboard. ", },
   *   place: { in: "Office" },
   * });
   * </code></pre>
   **/
  class Whiteboard extends AdventureJS.Assets.WritingSurface {
    constructor(name, game_name, context_id = "", id = "") {
      super(name, game_name, context_id, id);
      this.class = "Whiteboard";

      this.synonyms = ["whiteboard", "white board"];
      this.setDOV({
        erase: { with_classes: ["WhiteboardEraser"], with_nothing: true },
      });
      this.setIOV({
        write: { with_classes: ["WhiteboardMarker"] },
      });
      this.setIOV({
        draw: { with_classes: ["WhiteboardMarker"] },
      });
      this.unsetDOV("get", "take");
    }
  }
  AdventureJS.Assets.Whiteboard = Whiteboard;
})();