// lock.js
// OK 09 2023
(function () {
/*global adventurejs A*/
"use strict";
/**
* @augments {adventurejs.Verb}
* @class lock
* @ajsnode game.dictionary.verbs.lock
* @ajsconstruct MyGame.createVerb({ "name": "lock", [...] });
* @ajsconstructedby adventurejs.Dictionary#createVerb
* @hideconstructor
* @ajsinstanceof Verb
* @ajsnavheading OpenCloseVerbs
* @ajscaninferindirect true
* @summary Verb meaning lock an asset.
* @tutorial Scripting_VerbSubscriptions
* @tutorial Verbs_VerbAnatomy
* @tutorial Verbs_VerbProcess
* @tutorial Verbs_ModifyVerbs
* @tutorial Verbs_WriteVerbs
* @classdesc
* <pre class="display border outline">
* <span class="input">> lock handcuff with key</span>
* You lock the pair of handcuffs with the little silver key,
* effectively shackling yourself to the campus railing. It's
* a mark of your privilege that you think this will stop the
* bulldozers, which roll right over you on their way to
* demolish the University Hall. You have died. But such a
* noble death! One day the University bards will write ballads
* about your heroic failure.
* </pre>
*
* <p>
* <strong>Lock</strong> a
* {@link adventurejs.Tangible|Tangible}
* {@link adventurejs.Asset|Asset}.
* Requires that the lock has
* asset.dov.lock.enabled set to true and its
* <a class="code" href="/doc/adventurejs.Tangible.html#property_is_locked">is.locked</a>
* property set to false. If the lock requires a key,
* verb will soft prompt for one.
* </p>
* @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
* @ajsdemo OpenGame, SittingRoom, Library, Playground, Objects
*/
A.Preverbs.lock = {
name: "lock",
prettyname: "lock",
past_tense: "locked",
synonyms: ["lock"],
state: "locked",
related: ["unlock", "pick"],
state_strings: { state: "locked", unstate: "unlocked" },
state_string: "locked",
unstate_string: "unlocked",
/**
* @ajsverbstructures
* @memberof lock
*/
accepts_structures: ["verb noun", "verb noun preposition noun"],
/**
* @memberof lock
* @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 lock
* @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 lock
* @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 soft_prompt_for_asset;
var asset_in_player;
var results;
var msg = "";
// parsed sentence structure: verb
if (input.hasStructure("verb")) {
}
// parsed sentence structure: verb noun
if (input.hasStructure("verb noun")) {
} // verb noun
// verb enabled?
if (!direct_object.isDOV(this.name)) {
this.game.debug(
`F1346 | ${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(
`F1347 | ${this.name}.js | ${
direct_object.id
}.is.${this.getState()} is ${direct_object.isState(this.name)}`,
);
msg += `${direct_object.Articlename} is already ${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(
`F1824 | ${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(
`F1348 | ${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 false;
}
// infer indirect object?
results = this.tryToInferIndirectObject(direct_object, true);
if (results.prompt) {
this.game.debug(`F1706 | ${this.name}.js | soft prompt for noun2 `);
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
// parsed 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(
`F1343 | ${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(
`F1344 | ${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(
`F1903 | ${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(
`F1809 | ${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 autoclose;
this.game.debug(`F1350 | ${this.name}.js | print doSuccess `);
// apply state changes
this.setState(direct_object, true);
// update incidental verb count
if (!direct_object.is.closed) {
direct_object.setClosed(); //is.closed = true;
direct_object.incrementDoVerbCount("close", 1);
autoclose = true;
}
// compose output
msg += `$(We) ${autoclose ? "close and " : ""} ${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 += `. `;
// print output
this.handleSuccess(msg, direct_object);
return true;
},
};
})(); // lock