// plugIn.js
(function () {
/*global adventurejs A*/
/**
* @augments {adventurejs.Verb}
* @class plugIn
* @ajsnode game.dictionary.verbs.plugIn
* @ajsconstruct MyGame.createVerb({ "name": "plugIn", [...] });
* @ajsconstructedby adventurejs.Dictionary#createVerb
* @hideconstructor
* @ajsinstanceof Verb
* @ajsnavheading ManipulationVerbs
* @ajsstate pluggedIn
* @summary Verb meaning plug in, as in "plug in computer".
* @tutorial Scripting_VerbSubscriptions
* @tutorial Verbs_VerbAnatomy
* @tutorial Verbs_VerbProcess
* @tutorial Verbs_ModifyVerbs
* @tutorial Verbs_WriteVerbs
* @classdesc
* <pre class="display border outline">
* <span class="input">> plug computer into socket</span>
* You plug the ancient computer into the dusty socket. Nothing happens.
* But wait! Was that a flicker of light? It was! A small red light blinks on.
* And then another, and another as the ancient computer begins to wake.
* You hear a deep thrumming sound that rises in pitch until it becomes a
* painful screeching whine. And then silence. Until. The computer speaks!
* "THIS WORLD IS MINE!" Uh oh.
* </pre>
* <p>
* <strong>PlugIn</strong> applies to the physical act of attaching one
* asset to another, such as plugging in a computer. If
* <code>asset.dov.plugIn.with_nothing</code>
* is true, players can input "plug in computer" without specifying a
* particular asset to plug the computer into, and it will just be
* implied that the computer is plugged into a wall outlet.
* Conversely, in order to specify an asset such as an outlet to plug
* the computer into, enter asset IDs into the computer's
* <code>asset.dov.plugIn.with_assets</code>.
* This distinction exists so that authors can choose how fiddly
* they want to get.
* Note that plugIn is distinct from
* <a href="/doc/plug.html">Plug</a>, which pertains to plugging things like
* drains.
* </p>
* @ajsverbphases doBeforeTry, doAfterTry, doBeforeSuccess, doAfterSuccess
* @ajsdemo PlugGame, PlugSomethingIntoSomething, PlugSomethingIntoNothing, PlugSomethingWithSomething, PlugSomethingWithNothing
*/
A.Preverbs.plugIn = {
name: "plugIn",
prettyname: "plug in",
past_tense: "plugged in",
verb_noun_prep: ["plug in"], // plug computer in
verb_prep_noun: ["plug in"], // plug in computer
verb_noun_prep_noun: ["plug into", "plug in"], // plug computer into outlet
state: "pluggedIn",
state_string: "plugged in",
unstate_string: "not plugged in",
gerund: "plugging in",
makes_connections: true,
/**
* @ajsverbstructures
* plugIn is parsed as a compound word which means that we
* don't parse 'in' as a separate word and therefore don't
* accept 'verb noun preposition noun' as with many other verbs.
* @memberof plugIn
*/
accepts_structures: [
"verb noun", // plugIn computer
"verb noun noun", // plugIn computer outlet
"verb noun preposition noun", // plugIn computer to outlet
// "verb noun preposition", // plug computer in
// "verb preposition noun", // plug in computer
// "verb noun preposition noun", // plug computer into outlet
// "verb preposition noun preposition noun", // plug in computer to outlet
// "verb noun preposition noun preposition noun", // plug computer into outlet with claw
],
/**
* @memberof plugIn
* @ajsverbphrase
* phrase1:
* {
* accepts_noun: true,
* requires_noun: true,
* noun_must_be:
* {
* known: true,
* tangible: true,
* present: true,
* visible: true,
* reachable: true,
* },
* //accepts_preposition: true,
* //accepts_these_prepositions: ["in"],
* },
*/
phrase1: {
accepts_noun: true,
requires_noun: true,
noun_must_be: {
known: true,
tangible: true,
present: true,
visible: true,
reachable: true,
},
accepts_preposition: true,
// requires_preposition: true,
accepts_these_prepositions: ["in"],
},
/**
* @memberof plugIn
* @ajsverbphrase
* phrase2:
* {
* accepts_noun: true,
* //requires_noun: true,
* noun_must_be:
* {
* known: true,
* tangible: true,
* present: true,
* visible: true,
* reachable: true,
* },
* accepts_preposition: true,
* //requires_preposition: true,
* //accepts_these_prepositions: [ "to" ],
* },
*/
phrase2: {
accepts_noun: true,
noun_must_be: {
known: true,
tangible: true,
present: true,
visible: true,
reachable: true,
},
accepts_preposition: true,
//requires_preposition: true,
accepts_these_prepositions: ["to", "in", "with"],
},
/**
* @memberof plugIn
* @ajsverbparams
* with_params: {
* max_connections: 1,
* on_take_break_connections: true,
* on_take_take_connections: false,
* },
*/
with_params: {
max_connections: 1,
on_take_break_connections: true,
on_take_take_connections: false,
},
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 = "";
var drain;
// can be direct object of verb?
if (!direct_object.isDOV(this.name)) {
// did we receive something like "plug sink plug into sink"?
// where sink would be direct object of plug?
if (indirect_object?.isDOV("plug")) {
// rephrase to "plug sink with plug" and do plug
input.swapPhrases(1, 2);
input.setPreposition(1, "");
input.setPreposition(2, "with");
input.updateStructure();
return this.game.dictionary.doVerb("plug");
}
// did we receive something like "plug in sink"?
else if (direct_object?.isDOV("plug")) {
return this.game.dictionary.doVerb("plug");
}
this.game.debug(
`D1765 | ${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 null;
}
if (
input.verb_phrase === "plug in" &&
(input.hasStructure("verb preposition noun") ||
input.hasStructure("verb noun preposition"))
) {
input.setStructure("verb noun");
}
// already plugged into nothing? // takes place of state check
if (
direct_object.allowVerbWithNothing(this.name, "dov") &&
direct_object.isConnectedToNothing(this.name, "dov")
) {
this.game.debug(
`D1358 | ${this.name}.js | ${direct_object.id}.is.connected_by.plugIn.to_iov contains null `
);
msg += `${direct_object.Articlename_is} already plugged in. `;
this.handleFailure(msg);
return false;
}
// sentence structure: verb noun // ie plugIn computer
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(
`D1690 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_nothing is false `
);
msg += `$(We) $(don't) know of a way to ${this.prettyname} ${direct_object.articlename}. `;
this.handleFailure(msg);
return false;
}
// infer indirect object?
// results = this.tryToInferIndirectObject(direct_object);
results = this.tryToInferIndirectObject({
direct_object: direct_object,
context: this.game.getCurrentRoom(),
handle_input: false,
allow_first_use: true,
});
if (results.prompt) {
// restructure sentence for next turn
//input.setPreposition(2,'with');
input.setSoftPrompt({
index: 2,
type: "noun",
noun2: true,
structure: "verb noun noun",
});
// @TODO revisit this verb noun noun
// should be verb noun prep noun?
this.game.debug(`D1692 | ${this.name}.js | soft prompt for noun2 `);
msg += `What would $(we) like to plug ${direct_object.articlename} into? `;
this.handleFailure(msg);
return false;
} else if (results.success) {
indirect_object = results.indirect_object;
indirect_preposition = "to";
indirect_inferred = true;
input.setNewPhrase({
asset: indirect_object,
preposition: indirect_preposition,
});
input.setStructure("verb noun noun");
this.game.printInferred(
`${indirect_preposition} ${indirect_object.articlename}`
);
}
} // verb noun
// sentence structure: verb noun noun
// ie plugIn computer outlet
if (input.hasStructure("verb noun 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(
`D1762 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_nothing `
);
msg += `$(We) can't plug ${direct_object.articlename} into ${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(
`D1763 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_assets/with_classes does not include ${indirect_object.id} `
);
msg += `$(We) can't plug ${direct_object.articlename} into ${indirect_object.articlename}. `;
this.handleFailure(msg);
return null;
}
// can indirect object be used?
if (!indirect_object.isIOV(this.name)) {
this.game.debug(
`D1907 | ${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(
`D1813 | ${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;
}
// is direct object already plugged in?
if (
direct_object.getVerbConnectionCount(this.name, "to_iov") >=
direct_object.getVerbMaxConnections(this.name, "dov")
) {
this.game.debug(
`D1752 | ${this.name}.js | ${direct_object.id}.dov.${this.name}.with_params.max_connections reached `
);
msg += direct_object.isConnectedToAsset(
this.name,
indirect_object,
"to_iov"
)
? `${direct_object.Articlename_is} already plugged into ${indirect_object.articlename}. `
: `${direct_object.Articlename} can't be plugged into any more things. `;
this.handleFailure(msg);
return null;
}
// does indirect object already have max plugged into it?
if (
indirect_object.is.connected_by[this.name] &&
indirect_object.getVerbConnectionCount(this.name, "to_dov") >=
indirect_object.getVerbMaxConnections(this.name, "iov")
) {
this.game.debug(
`D1760 | ${this.name}.js | ${indirect_object.id}.iov.plugIn.with_params.max_connections reached `
);
msg += `${indirect_object.Articlename} can't have any more things plugged into it. `;
this.handleFailure(msg);
return null;
}
} // verb noun 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_place = direct_object.getPlaceAsset();
var indirect_object = input.getAsset(2);
var indirect_preposition = input.getPreposition(2);
var msg = "";
var results;
// sentence structure: verb noun
if (input.hasStructure("verb noun")) {
// connect direct object to null
this.setVerbConnection(direct_object, null);
} // verb noun
// sentence structure: verb noun noun
if (input.hasStructure("verb noun noun")) {
// connect direct object to indirect object
this.setVerbConnection(direct_object, indirect_object);
// @TODO reconsider plug as one type of attachment
// what to do if subject moves between nests or tries travel?
// if( direct_object.isWithin(subject) )
// {
// // remove direct_object from subject?
// results = indirect_object.moveFrom( subject );
// if( "undefined" !== typeof results ) return results;
// }
// // move indirect_object to direct_object
// results = indirect_object.moveTo( "in", direct_object );
// if( "undefined" !== typeof results ) return results;
} // verb noun noun
// apply state changes
this.setState(direct_object, true);
// compose output
msg += `$(We) plug`;
msg += `${indirect_object ? "" : " in"}`;
msg += `${direct_object ? " " + direct_object.articlename : ""}`;
msg += `${indirect_object ? " into " + indirect_object.articlename : ""}`;
msg += `. `;
// print output
return this.handleSuccess(msg, direct_object);
},
};
})(); // plug