// Marker.js
(function () {
/*global adventurejs A*/
"use strict";
/**
* @ajspath adventurejs.Atom.Asset.Matter.Tangible.Thing.WritingImplement.Marker
* @augments adventurejs.WritingImplement
* @class adventurejs.Marker
* @ajsconstruct MyGame.createAsset({ "class":"Marker", "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 writing implement.
* @classdesc
* <p>
* <strong>Marker</strong> is a subclass of
* {@link adventurejs.WritingImplement|WritingImplement}.
* Marker and other WritingImplements have their
* <code class="property">iov.write</code>
* property set to true, which allows a player to write on things
* with <code class="property">asset.dov.write</code>
* set to true, such as {@link adventurejs.Paper|Paper}.
* </p>
* <p>
* All that distinguishes Marker from other WritingImplements
* is that ...
*
* </p>
* <h3 class="examples">Example:</h3>
* <pre class="display"><code class="language-javascript">MyGame.createAsset({
* class: "Marker",
* name: "dry erase marker",
* adjectives: [ "green" ],
* article: "a",
* place: { on: "table" },
* descriptions: { look: "It's an ordinary green dry erase marker. ", },
* });
* MyGame.createAsset({
* class: "Whiteboard",
* name: "whiteboard",
* descriptions: { look: "It's a large whiteboard. ", },
* place: { in: "Office" },
* });
* </code></pre>
* <p>
* The above example uses
* <code class="property">with_classes</code>
* to limit what a
* player can write on without having to write custom
* failure code for every object. To learn more, see
* <a href="/doc/Tangibles_Aspects.html">How to Use Aspects</a>.
* </p>
**/
class Marker extends adventurejs.WritingImplement {
constructor(name, game_name) {
super(name, game_name);
this.class = "Marker";
this.noun = "marker";
this.plural = "markers";
this.singlePluralPairs = [["marker", "markers"]];
this.group = ["writing implements"];
}
}
adventurejs.Marker = Marker;
})();