// unlock.js
// OK 09 2023
(function () {
/*global adventurejs A*/
"use strict";
/**
* @augments {adventurejs.Verb}
* @class unlock
* @ajsnode game.dictionary.verbs.unlock
* @ajsconstruct MyGame.createVerb({ "name": "unlock", [...] });
* @ajsconstructedby adventurejs.Dictionary#createVerb
* @hideconstructor
* @ajsinstanceof Verb
* @ajsnavheading OpenCloseVerbs
* @ajscaninferindirect true
* @summary Verb meaning unlock, as in "unlock door with key".
* @tutorial Scripting_VerbSubscriptions
* @tutorial Verbs_VerbAnatomy
* @tutorial Verbs_VerbProcess
* @tutorial Verbs_ModifyVerbs
* @tutorial Verbs_WriteVerbs
* @classdesc
* <pre class="display border outline">
* <span class="input">> unlock heart with love</span>
* You unlock the heart stone with the loving key. The
* chamber's dim lighting immediately brightens into a pulsating
* glow. The sense of forboding that had descended upon you lifts
* too. You feel yourself buoyed with positive emotion. In fact...
* whoa... you look down to find your feet rising from the ground.
* </pre>
*
* <p>
* <strong>Unlock</strong> a
* {@link adventurejs.Tangible|Tangible}
* {@link adventurejs.Asset|Asset}.
* Requires that the lock has
* asset.dov.unlock.enabled set to true and its
* <a class="code" href="/doc/adventurejs.Tangible.html#property_is_locked">is.locked</a>
* property set to true.
* If the lock requires a key, verb will soft prompt for one.
* </p>
*
* tryUnlockThis
* tryUnlockThisWithThat
* tryUnlockThatWithThis
* doUnlockThis
* doUnlockThisWithThat
* doUnlockThatWithThis
* @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
* @ajsdemo OpenGame, SittingRoom, Library, Playground, Objects
*/
A.Preverbs.unlock = {
name: "unlock",
prettyname: "unlock",
past_tense: "unlocked",
synonyms: ["unlock"],
unstate: "locked",
related: ["lock", "pick"],
/**
* @ajsverbstructures
* @memberof unlock
*/
accepts_structures: ["verb noun", "verb noun preposition noun"],
/**
* @memberof unlock
* @ajsverbphrase
* phrase1:
* {
* accepts_noun: true,
* requires_noun: true,
* noun_must_be:
* {
* known: true,
* tangible: true,
* present: true,
* visible: true,
* reachable: true,
* },
* },
*/
phrase1: {
accepts_noun: true,
requires_noun: true,
noun_must_be: {
known: true,
tangible: true,
present: true,
visible: true,
reachable: true,
},
},
/**
* @memberof unlock
* @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 unlock
* @ajsverbparams
* with_params: {},
*/
with_params: {},
doTry: function () {
var input = this.game.getInput();
var direct_object = input.getAsset(1);
var indirect_object = input.getAsset(2);
var indirect_preposition = input.getPreposition(2);
var player = this.game.getPlayer();
var results;
var msg = "";
// be nice and redirect to pick if appropriate
if (
direct_object?.isDOV("pick") &&
indirect_object &&
direct_object.DOVallowWithAsset("pick", indirect_object.id)
) {
this.game.dictionary.doVerb("pick");
return null;
}
// parsed sentence structure: verb
if (input.hasStructure("verb")) {
}
// parsed sentence structure: verb noun
if (input.hasStructure("verb noun")) {
} // verb noun
// can be direct object of verb?
if (!direct_object.isDOV(this.name)) {
if (direct_object.isDOV("pick")) {
this.game.dictionary.doVerb("pick");
return null;
}
this.game.debug(
`F1464 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.enabled is false `,
);
msg += `${direct_object.Articlename} can't be ${this.past_tense}. `;
this.handleFailure(msg);
return false;
}
// verb state?
if (this.hasState() && direct_object.isState(this.name)) {
this.game.debug(
`F1465 | ${this.name}.js | ${
direct_object.id
}.is.${this.getState()} is false`,
);
msg += `${direct_object.Articlename} isn't ${this.getState()}. `;
this.handleFailure(msg);
return false;
}
// single use direct object?
if (
direct_object.DOVallowOnce(this.name) &&
direct_object.DOVdidDo(this.name)
) {
this.game.debug(
`F1831 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.once and ${direct_object.id}.dov.${this.name}.did_do `,
);
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.DOVallowWithNothing(this.name)) {
return true;
}
// indirect objects available?
if (!direct_object.DOVhasIndirectObjects(this.name)) {
this.game.debug(
`F1466 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_nothing is false `,
);
msg += `$(We) don't know of anything that unlocks ${direct_object.articlename}. `;
this.handleFailure(msg);
return false;
}
// infer indirect object?
results = this.tryToInferIndirectObject(direct_object, true);
if (results.prompt) {
this.game.debug(`F1757 | ${this.name}.js | soft prompt for noun2 `);
msg += input.verb_params.auto_open
? `${direct_object.Articlename} is locked. `
: ``;
msg += `What would $(we) like to ${this.name} ${direct_object.articlename} with? `;
this.handleFailure(msg);
return false;
} else if (results.success) {
indirect_object = results.indirect_object;
indirect_preposition = "with";
}
} // verb noun
// sentence structure: verb noun preposition noun
if (input.hasStructure("verb noun preposition noun")) {
// works with any indirect object?
if (direct_object.DOVallowWithAnything(this.name)) {
return true;
}
// indirect object not required?
if (direct_object.DOVallowWithNothing(this.name)) {
this.game.debug(
`F1696 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_nothing `,
);
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.DOVallowWithAsset(this.name, indirect_object)) {
this.game.debug(
`F1698 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_assets/with_classes 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(
`F1913 | ${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.IOVallowOnce(this.name) &&
indirect_object.IOVdidDo(this.name)
) {
this.game.debug(
`F1817 | ${this.name}.js | ${indirect_object.id}.iov.${
this.name
}.once and ${indirect_object.id}.iov.${this.name}.do_count is ${
indirect_object.iov[this.name].do_count
} `,
);
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 direct_object = input.getAsset(1);
var direct_preposition = input.getPreposition(1);
var indirect_object = input.getAsset(2);
var indirect_preposition = input.getPreposition(2);
var player = this.game.getPlayer();
var results;
var msg = "";
var auto_open = false;
this.game.debug(`F1468 | ${this.name}.js | print doSuccess `);
// parsed sentence structure: verb
if (input.hasStructure("verb")) {
}
// parsed sentence structure: verb noun
if (input.hasStructure("verb noun")) {
} // verb noun
if (input.verb_params.auto_open) {
direct_object.setClosed(false); //is.closed = false;
direct_object.incrementDoVerbCount("open", 1);
auto_open = true;
}
// parsed sentence structure: verb noun
if (input.hasStructure("verb noun")) {
} // verb noun
// sentence structure: verb noun preposition noun
if (input.hasStructure("verb noun preposition noun")) {
} // verb noun preposition noun
// apply state changes
this.setState(direct_object, false);
// compose output
msg += `$(We) ${this.name}`;
msg += `${direct_preposition ? " " + direct_preposition : ""}`;
msg += `${direct_object ? " " + direct_object.articlename : ""}`;
msg += `${indirect_preposition ? " " + indirect_preposition : ""}`;
msg += `${indirect_object ? " " + indirect_object.articlename : ""}`;
msg += auto_open ? ` and open it` : ``;
msg += `. `;
// printable contents?
if (auto_open && direct_object.hasContentsAtAspect("in")) {
msg += direct_object.getPrintableListOfContentsAt("in");
}
// print output
this.handleSuccess(msg, direct_object);
return true;
},
};
})(); // unlock