// close.js
// OK 09 2023
(function () {
/*global adventurejs A*/
/**
* @augments {adventurejs.Verb}
* @class close
* @ajsnode game.dictionary.verbs.close
* @ajsconstruct MyGame.createVerb({ "name": "close", [...] });
* @ajsconstructedby adventurejs.Dictionary#createVerb
* @hideconstructor
* @ajsinstanceof Verb
* @ajsnavheading OpenCloseVerbs
* @ajscaninferdirect true
* @ajsstate closed
* @summary Verb meaning close a tangible asset.
* @ajssynonyms close, shut
* @tutorial Scripting_VerbSubscriptions
* @tutorial Verbs_VerbAnatomy
* @tutorial Verbs_VerbProcess
* @tutorial Verbs_ModifyVerbs
* @tutorial Verbs_WriteVerbs
* @classdesc
* <pre class="display border outline">
* <span class="input">> close can of snakes</span>
* You close the can of snakes, though you can never put the snakes back in the can.
* </pre>
* <p>
* Close a {@link adventurejs.Tangible|Tangible}
* {@link adventurejs.Asset|Asset}.
* Requires that the Asset has
* asset.dov.close.enabled set to true
* and asset.is.closed is false.
* </p>
* @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
* @ajsdemo OpenGame, SittingRoom, Library, Playground, Objects
*/
A.Preverbs.close = {
name: "close",
prettyname: "close",
past_tense: "closed",
synonyms: ["close", "shut"],
state: "closed",
related: ["open"],
state_strings: { state: "closed", unstate: "open" },
state_string: "closed",
unstate_string: "open",
enqueue_collections: true,
gerund: "closing",
/**
* @ajsverbstructures
* @memberof close
*/
accepts_structures: ["verb noun", "verb noun preposition noun"],
/**
* @memberof close
* @ajsverbphrase
* phrase1:
* {
* accepts_noun: true,
* noun_must_be:
* {
* known: true,
* tangible: true,
* present: true,
* visible: true,
* reachable: true,
* },
* },
*/
phrase1: {
accepts_noun: true,
noun_must_be: {
known: true,
tangible: true,
present: true,
visible: true,
reachable: true,
},
},
/**
* @memberof close
* @ajsverbphrase
* phrase2:
* {
* accepts_noun: true,
* noun_must_be:
* {
* in_inventory: true,
* known: true,
* },
* accepts_preposition: true,
* requires_preposition: true,
* accepts_these_prepositions: ["with"],
* },
*/
phrase2: {
accepts_noun: true,
noun_must_be: {
in_inventory: true,
known: true,
},
accepts_preposition: true,
requires_preposition: true,
accepts_these_prepositions: ["with"],
},
/**
* @memberof close
* @ajsverbparams
* with_params: {},
*/
with_params: {},
doTry: function () {
var input = this.game.getInput();
var subject = input.getSubject();
var verb_phrase = input.verb_phrase;
var direct_object = input.getAsset(1);
var indirect_object = input.getAsset(2);
var indirect_preposition = input.getPreposition(2);
var indirect_inferred;
var results;
var msg = "";
// sentence structure: verb
if (input.hasStructure("verb")) {
}
// sentence structure: verb noun
if (input.hasStructure("verb noun")) {
} // verb noun
// has direct object got a registered drain asset?
// if so use that as direct object
if (direct_object.registered_parts?.Drain) {
direct_object = this.game.getAsset(
direct_object.registered_parts.Drain
);
if (!direct_object) return null;
input.setAsset(1, direct_object);
input.setInferred(1, true);
// this.game.printInferred(`${direct_object.name}`);
}
// if it's a drain, did player input "close drain"?
if (direct_object.isDOV("plug") && !direct_object.is.plugged) {
this.game.debug(
`D1368 | ${this.name}.js | ${direct_object.id}.dov.plug, doVerb plug `
);
return this.game.dictionary.doVerb("plug");
}
// verb enabled?
if (!direct_object.isDOV(this.name)) {
this.game.debug(
`D1241 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.enabled is false `
);
msg += `${direct_object.Articlename} can't be ${this.state}. `;
this.handleFailure(msg);
return null;
}
// verb state?
if (this.hasState() && direct_object.isVerbState(this.name)) {
this.game.debug(
`D1242 | ${this.name}.js | ${
direct_object.id
}.is.${this.getState()} is ${direct_object.isVerbState(this.name)}`
);
msg += `${direct_object.Articlename_is} already ${this.getState()}. `;
this.handleFailure(msg);
return null;
}
// single use direct object?
if (
direct_object.allowVerbOnce(this.name, "dov") &&
direct_object.didVerb(this.name, "dov")
) {
this.game.debug(
`D1822 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.once and ${direct_object.id}.did.${this.name}.directly `
);
msg += `${direct_object.Articlename} has already been ${this.past_tense}. `;
this.handleFailure(msg);
return false;
}
// sentence structure: verb noun
if (input.hasStructure("verb noun")) {
// indirect object required?
if (direct_object.allowVerbWithNothing(this.name, "dov")) {
return true;
}
// indirect objects available?
if (!direct_object.hasIndirectObjects(this.name)) {
this.game.debug(
`D1403 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_nothing is false `
);
msg += `$(We) $(don't) know of a way to ${this.name} ${direct_object.articlename}. `;
this.handleFailure(msg);
return null;
}
// infer indirect object?
results = this.tryToInferIndirectObject({
direct_object: direct_object,
context: subject,
handle_input: true,
});
if (results.prompt) {
this.game.debug(`D1704 | ${this.name}.js | soft prompt for noun2 `);
msg += `What would $(we) like to ${this.name} ${direct_object.articlename} with? `;
this.handleFailure(msg);
return null;
} else if (results.success) {
indirect_object = results.indirect_object;
indirect_preposition = "with";
indirect_inferred = true;
input.setAsset(2, indirect_object);
input.setPreposition(2, indirect_preposition);
input.setStructure("verb noun preposition noun");
this.game.printInferred(
`${indirect_preposition} ${indirect_object.articlename}`
);
}
} // verb noun
// sentence structure: verb noun preposition noun
if (input.hasStructure("verb noun preposition noun")) {
// works with any indirect object?
if (direct_object.allowVerbWithAnything(this.name, "dov")) {
return true;
}
// indirect object not required?
if (direct_object.allowVerbWithNothing(this.name, "dov")) {
this.game.debug(
`D1691 | ${this.name}.js | ${direct_object.id} can't be ${this.state} by ${indirect_object.id} `
);
msg += `$(We) can't ${this.name} ${direct_object.articlename} ${indirect_preposition} ${indirect_object.articlename}. `;
this.handleFailure(msg);
return null;
}
// indirect object usable with direct object?
if (
!direct_object.allowVerbWithAsset(this.name, indirect_object, "dov")
) {
this.game.debug(
`D1693 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_assets does not include ${indirect_object.id} `
);
msg += `$(We) can't ${this.name} ${direct_object.articlename} ${indirect_preposition} ${indirect_object.articlename}. `;
this.handleFailure(msg);
return null;
}
// can indirect object be used?
if (!indirect_object.isIOV(this.name)) {
this.game.debug(
`D1899 | ${this.name}.js | ${indirect_object.id}.iov.${this.name}.enabled is false `
);
msg += `$(We) can't ${this.name} anything ${indirect_preposition} ${indirect_object.articlename}. `;
this.handleFailure(msg);
return false;
}
// single use indirect object?
if (
indirect_object.allowVerbOnce(this.name, "iov") &&
indirect_object.iDidVerb(this.name, "iov")
) {
this.game.debug(
`D1806 | ${this.name}.js | ${indirect_object.id}.iov.${
this.name
}.once and ${indirect_object.id}.did.${this.name}.indirectly is ${
indirect_object.did[this.name].indirectly
} `
);
msg += `${indirect_object.Articlename} has already been used to ${this.name} something. `;
this.handleFailure(msg);
return null;
}
} // verb noun preposition noun
return true;
},
doSuccess: function () {
var input = this.game.getInput();
var subject = input.getSubject();
var verb_phrase = input.verb_phrase;
var direct_object = input.getAsset(1);
var direct_preposition = input.getPreposition(1);
var indirect_object = input.getAsset(2);
var indirect_preposition = input.getPreposition(2);
var msg = "";
var results;
// apply state changes
this.setState(direct_object, true);
// compose output
msg +=
`$(We) ${this.agree()}` +
`${direct_preposition ? " " + direct_preposition : ""}` +
`${direct_object ? " " + direct_object.articlename : ""}` +
`${indirect_preposition ? " " + indirect_preposition : ""}` +
`${indirect_object ? " " + indirect_object.articlename : ""}` +
`. `;
// print output
return this.handleSuccess(msg, direct_object);
},
};
})(); // close