// Character.js
(function () {
/*global adventurejs A*/
/**
* @ajspath adventurejs.Atom.Asset.Matter.Tangible.Character
* @augments adventurejs.Tangible
* @class adventurejs.Character
* @ajsconstruct MyGame.createAsset({ "class":"Character", "name":"foo", [...] })
* @ajsconstructedby adventurejs.Game#createAsset
* @ajsnavheading CharacterClasses
* @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 Base class for all character types.
* @tutorial Characters_NPCs
* @tutorial CreatePlayer
* @ajstangiblecontainer in
* @todo more methods, better example
* @classdesc
* <p>
* <strong>Character</strong> is anything that moves or speaks
* or takes or gives. {@link adventurejs.Player|Player} and
* {@link adventurejs.NPC|NPCs} are both Characters.
* Character can sense things, hold things, be asked things,
* be told things...
* </p>
* <h3 class="examples">Example:</h3>
* <pre class="display"><code class="language-javascript">MyGame.createAsset({
* "class": "Character",
* "name": "Yurtle",
* "synonyms": ["turtle"],
* "place": {in: "Pond"},
* })
* </code></pre>
*/
class Character extends adventurejs.Tangible {
constructor(name, game_name) {
super(name, game_name);
this.class = "Character";
this.is = new adventurejs.Character_Is("is", this.game_name, this.id);
this.can = new adventurejs.Character_Can("can", this.game_name, this.id);
this.setDOVs(["feed"]);
this.setIOVs(["throw", "take", "give", "hold", "tie"]);
this.posture = "stand";
this.aspects.in = new adventurejs.Aspect("in", this.game_name, this.id);
this.default_aspect = "in";
this.dont_use_articles = true;
this.name_is_proper = true;
// @TODO full gender / pronoun handling
this.gender = "female";
this.pronoun = "her";
this.possessive = "hers";
/**
* We can track the user's y position. This option sets the maximum distance that the
* player can reach vertically, ie when climbing an object like a tree. 1 is considered
* to be about the height of a person.
* @var {Boolean} adventurejs.Character#reach_height
* @default 1
*/
this.reach_height = 1;
/**
* We can track the user's x/z position. This option sets the maximum distance that the
* player can reach horizontally within a room. 0.33 is considered to be about arm's length.
* @var {Boolean} adventurejs.Character#reach_length
* @default .33
*/
this.reach_length = 0.33;
/**
* We can track the user's x/z position. This option sets the default distance that the
* player travels horizontally when moving within a room. 1 is considered to be about
* the height of a person.
* @var {Boolean} adventurejs.Character#stride_length
* @default .33
*/
this.stride_length = 0.33;
/**
* We can track the user's y position. This option sets the maximum distance that the
* player can travel vertically. 1 is considered to be about
* the height of a person.
* @var {Boolean} adventurejs.Character#jump_height
* @default 1
*/
this.jump_height = 1;
/**
* We can track the user's x/z position. This option sets the maximum distance that the
* player travels horizontally when moving within a room. 1 is considered to be about
* the height of a person.
* @var {Boolean} adventurejs.Character#jump_length
* @default 1
*/
this.jump_length = 1;
/**
* Generic message to return when an NPC is given
* a command that they can't act on. Can be left blank
* to use a default message.
* @var {String} adventurejs.Character#ignore_msg
* @default ""
*/
this.ignore_msg = "";
/**
* Object to keep track of assets known by the character.
* @var {String} adventurejs.Character#knows_about
* @default {}
*/
this.knows_about = {}; // ok
/**
* Object to keep track of assets seen by the character.
* @var {String} adventurejs.Character#has_seen
* @default {}
*/
this.has_seen = {}; // ok
/**
* Object to keep track of room assets visited by the character.
* @var {String} adventurejs.Character#has_been
* @default {}
*/
this.has_been = {}; // ok
/**
* Object to keep track of room assets visited by the character.
* @var {String} adventurejs.Character#nest
* @default {}
*/
this.nest = {};
}
/**
* Get / set nest. Nest is related to but differs from place.
* Non-character classes can be placed in any other asset.
* Character classes can only be placed in rooms, and nest
* in other assets. This is so they can be, for example,
* nested on a bicycle while in a room.
* The private var _nest is an
* object with two properties: aspect and asset.
* For example: { aspect:"in", asset:"room" }
* However, the public var place appears in the form
* { in: "room" }. This is to make it easier and more
* intuitive for authors to set asset nests.
* @var {Object} adventurejs.Character#nest
*/
get nest() {
return this._nest;
}
set nest(nest) {
if (Object(nest) !== nest) {
var msg = this.id + ".nest received a malformed value ";
this.game.log("L1428", "error", "critical", msg, "Tangible");
nest = {};
} else {
var keys = Object.keys(nest);
if (keys.length > 1) {
var msg =
this.id +
".nest received more than one location. Using the first. ";
for (var i = 0; i < keys.length; i++) {
msg += keys[i] + ", ";
}
nest = { [keys[0]]: nest[keys[0]] };
this.game.log("L1429", "error", "critical", msg, "Character");
}
if (keys.length === 1) {
// serialize asset name
nest[keys[0]] = A.serialize(nest[keys[0]]);
// verify asset
if ("string" !== typeof nest[keys[0]]) {
var msg = this.id + ".nest set to an invalid asset ";
this.game.log("L1430", "error", "critical", msg, "Tangible");
}
}
if (keys.length === 0) {
}
}
this._nest = nest;
}
/**
* Set whether character knows about an asset.
* @memberof adventurejs.Character
* @method adventurejs.Character#know
* @param {*} asset
*/
know(asset) {
if ("string" === typeof asset) {
asset = this.game.getAsset(asset);
}
if (!asset || !asset.id) return;
this.knows_about[asset.id] = true;
if (asset.linked_asset) {
let linked_asset = this.game.getAsset(asset.linked_asset);
if (linked_asset && linked_asset.id) {
this.knows_about[linked_asset.id] = true;
}
}
if (asset.aspects) {
for (let aspect in asset.aspects) {
if (aspect === "in" && asset.is.closed) continue; // @TODO transparency
if (asset.aspects[aspect].know_with_parent) {
var contents = asset.aspects[aspect].contents;
for (let i = 0; i < contents.length; i++) {
let nested_asset = this.game.getAsset(contents[i]);
this.knows_about[nested_asset.id] = true;
}
}
}
if (asset.hasVessel && asset.hasVessel()) {
let vessel = asset.getVessel();
if (vessel?.know_with_parent) this.knows_about[vessel.id] = true;
}
}
}
/**
* Ask whether character knows about an asset.
* @memberof adventurejs.Character
* @method adventurejs.Character#isKnown
* @param {*} asset
* @returns {Boolean}
*/
knowsAbout(asset) {
if ("string" === typeof asset) {
asset = this.game.getAsset(asset);
}
if (!asset) return false;
return true === this.knows_about[asset.id] || asset.is?.known
? true
: false;
}
/**
* Set whether character has seen an asset.
* @memberof adventurejs.Character
* @method adventurejs.Character#show
* @param {*} asset
*/
see(asset) {
if ("string" === typeof asset) {
asset = this.game.getAsset(asset);
}
if (!asset || !asset.id) return;
this.has_seen[asset.id] = true;
if (asset.linked_asset) {
let linked_asset = this.game.getAsset(asset.linked_asset);
if (linked_asset && linked_asset.id) {
this.has_seen[linked_asset.id] = true;
}
}
if (asset.aspects) {
for (let aspect in asset.aspects) {
if (aspect === "in" && asset.is.closed) continue; // @TODO transparency
if (asset.aspects[aspect].see_with_parent) {
let contents = asset.aspects[aspect].contents;
for (let i = 0; i < contents.length; i++) {
let nested_asset = this.game.getAsset(contents[i]);
this.has_seen[nested_asset.id] = true;
}
}
}
if (asset.hasVessel && asset.hasVessel()) {
let vessel = asset.getVessel();
if (vessel?.see_with_parent) this.has_seen[vessel.id] = true;
}
}
}
/**
* Ask whether character has seen an asset.
* @memberof adventurejs.Character
* @method adventurejs.Character#isSeen
* @param {*} asset
* @returns {Boolean}
*/
hasSeen(asset) {
if ("string" === typeof asset) {
asset = this.game.getAsset(asset);
}
if (!asset) return false;
return true === this.has_seen[asset.id] || asset.is?.seen ? true : false;
}
/**
* Set whether character has been in a room asset.
* @memberof adventurejs.Character
* @method adventurejs.Character#been
* @param {*} asset
*/
visit(asset) {
if ("string" === typeof asset) {
asset = this.game.getAsset(asset);
}
if (!asset || !asset.id) return;
// this.knows_about[asset.id] = true;
this.know(asset);
// this.has_seen[asset.id] = true;
this.see(asset);
this.has_been[asset.id] = true;
}
/**
* Ask whether character has been to an asset.
* @memberof adventurejs.Character
* @method adventurejs.Character#hasBeen
* @param {*} asset
* @returns {Boolean}
*/
hasBeen(asset) {
if ("string" === typeof asset) {
asset = this.game.getAsset(asset);
}
if (!asset) return false;
return true === this.has_been[asset.id] ? true : false;
}
/**
* Handle asset initialization for Character.
* @memberof adventurejs.Character
* @method adventurejs.Character#initialize
* @param {Object} game
* @returns {Boolean}
*/
initialize(game) {
super.initialize(game);
let room = this.getRoomAsset();
if (room) {
this.know(room);
this.see(room);
this.has_been[room.id] = true;
}
let place = this.getPlaceAsset();
if (place && !place.hasClass("Room")) {
// set nest to place and move player to room
this.nest = { [this._place.aspect]: this._place.asset };
this.place = { in: room.id };
}
let nest = this.getNestAsset();
if (nest && nest.hasClass("Room")) {
this.place = { in: nest.id };
this.nest = {};
}
return true;
} // p.initialize
/**
* Ask whether character is current player.
* @memberof adventurejs.Character
* @method adventurejs.Character#isPlayer
* @returns {Boolean}
*/
isPlayer() {
return this.id === this.game.getPlayer().id;
}
}
adventurejs.Character = Character;
})();