// VerbSubscription.js
(function () {
/*global adventurejs A*/
/**
* @ajspath adventurejs.Atom.VerbSubscription
* @augments adventurejs.VerbSubscription
* @class adventurejs.VerbSubscription
* @ajsnavheading FrameworkReference
* @param {String} game_name Name of top level game instance that is scoped to window.
* @param {String} name Instance name.
* @summary A standardized format for attaching verb subscriptions to assets.
* @classdesc
* <p>
* <strong>VerbSubscription</strong> is a special class
* that offers methods to manage which verbs are allowed
* to act on which assets. This is intended to provide
* very fine grained control over verb/noun interactions.
* Verb subscriptions are defined on assets at
* asset.dov[verb] and asset.iov[verb].
* <br><br>
* VerbSubscriptions and their values are passed down the
* inheritance chain. For example:
* <code>asset.dov.examine</code>
* is available on {@link adventurejs.Matter|Matter},
* and inherited by
* {@link adventurejs.Tangible|Tangible},
* which allows all Tangible
* subclasses to be examined.
**/
class VerbSubscription extends adventurejs.Atom {
constructor(name, game_name, context_id) {
super(name, game_name, context_id);
this.class = "VerbSubscription";
this.context_id = context_id || "";
/**
* <strong>automatically</strong> allows for some verbs to be performed automatically if context calls for it; for example, when unlocking a door in order to pass through it. This takes precedence over global settings.
* @var {Boolean} adventurejs.VerbSubscription#automatically
*/
this.automatically = true;
/**
* <strong>automatically_after_use</strong> if automatically is set true, this sets it so that a verb can only be applied automatically after a player has already used it manually. This is to prevent automatic use of tools from breaking puzzles. For example, imagine one door with many keys but only one that works; if choosing the right key is part of the puzzle, this option prevents players from simply saying "unlock door" and having the right key automatically selected for them.
* @var {Boolean} adventurejs.VerbSubscription#automatically_after_use
*/
this.automatically_after_use = true;
/**
* <strong>doBeforeTry</strong> is one of four verb phases that
* provide methods to override default verb behaviors. See
* <a href="Scripting_VerbPhases.html">Start Scripting: Verb Phases</a>
* for more information.
* @var {String} adventurejs.VerbSubscription#doBeforeTry
*/
this.doBeforeTry = null;
/**
* <strong>doAfterTry</strong> is one of four verb phases that
* provide methods to override default verb behaviors. See
* <a href="Scripting_VerbPhases.html">Start Scripting: Verb Phases</a>
* for more information.
* @var {String} adventurejs.VerbSubscription#doAfterTry
*/
this.doAfterTry = null;
/**
* <strong>doBeforeSuccess</strong> is one of four verb phases that
* provide methods to override default verb behaviors. See
* <a href="Scripting_VerbPhases.html">Start Scripting: Verb Phases</a>
* for more information.
* @var {String} adventurejs.VerbSubscription#doBeforeSuccess
*/
this.doBeforeSuccess = null;
/**
* <strong>doAfterSuccess</strong> is one of four verb phases that
* provide methods to override default verb behaviors. See
* <a href="Scripting_VerbPhases.html">Start Scripting: Verb Phases</a>
* for more information.
* @var {String} adventurejs.VerbSubscription#doAfterSuccess
*/
this.doAfterSuccess = null;
/**
* <strong>enabled</strong> allows changing the state of an asset's responsiveness to a given verb. If set false, a subscribed asset will not respond to the verb. This is useful for temporarily disabling verbs for specific assets; for example, if you had a door that could not be unlocked until another action was completed.
* @var {Boolean} adventurejs.VerbSubscription#enabled
*/
this.enabled = true;
/**
* <strong>inherited_from</strong> the name of the asset class this verb subscription is inherited from. Since these properties aren't distinctly documented, this is offered as a convenience method for tracking down inherited verb settings.
* @TODO this isn't currently working as envisioned
* @var {String} adventurejs.VerbSubscription#inherited_from
*/
this.inherited_from = "Asset";
/**
* <strong>name</strong> the name of the verb being subscribed to.
* @var {String} adventurejs.VerbSubscription#name
*/
this.name = "";
/**
* <strong>on_success</strong> is an optional parameter.
* It is set as a string by default, but authors may provide a
* string or array or function to be served by
* <a href="Scripting_StringArrayFunction.html">getStringOrArrayOrFunction()</a>.
* The resulting
* string will be appended to the verb's default success message.
* @var {String|*} adventurejs.VerbSubscription#on_success
* @getSAF
*/
this.on_success = "";
/**
* <strong>on_first_success</strong> is an optional parameter.
* It is set as a string by default, but authors may provide a string or
* array or function to be served by
* <a href="Scripting_StringArrayFunction.html">getStringOrArrayOrFunction()</a>.
* The resulting string will be appended to the verb's default
* success message.
* @var {String|*} adventurejs.VerbSubscription#on_first_success
* @getSAF
*/
this.on_first_success = "";
/**
* <strong>on_failure</strong> is an optional parameter.
* It is set as a string by default, but authors may provide a string or
* array or function to be served by
* <a href="Scripting_StringArrayFunction.html">getStringOrArrayOrFunction()</a>.
* The resulting string will be appended to the verb's
* default failure message.
* @var {String|*} adventurejs.VerbSubscription#on_failure
* @getSAF
*/
this.on_failure = "";
/**
* <strong>on_first_failure</strong> is an optional parameter.
* It is set as a string by default, but authors may provide a string or
* array or function to be served by
* <a href="Scripting_StringArrayFunction.html">getStringOrArrayOrFunction()</a>.
* The resulting string will be appended to the verb's
* default failure message.
* @var {String|*} adventurejs.VerbSubscription#on_first_failure
* @getSAF
*/
this.on_first_failure = "";
/**
* <strong>once</strong> if true, the verb can only be applied once to the asset. The verb subscription will be disabled after use.
* @var {Boolean} adventurejs.VerbSubscription#once
*/
this.once = false;
/**
* <strong>then_destroy</strong> allows author to specify that this asset should be destroyed after using. If then_destroy is set, the asset will be destroyed after a single use regardless of how <em class="code">once</em> is set. By default, then_destroy is set to a boolean. It may optionally be set to string or array or function subject to <a href="Scripting_StringArrayFunction.html">getStringOrArrayOrFunction()</a>. If any of those types are found, they will be called and returned as results.
* @var {Boolean|*} adventurejs.VerbSubscription#then_destroy
* @getSAF
*/
this.then_destroy = false;
/**
* <strong>with_anything</strong> pertains only to indirect
* objects. If true, this asset can be used as an indirect object
* of this verb with any direct object.
* @var {Boolean} adventurejs.VerbSubscription#with_anything
*/
this.with_anything = false;
/**
* <strong>with_assets</strong> allows author to specify
* particular assets that can interact with this one using the
* given verb. For example "unlock door with key" where the
* specified key is the only asset that can unlock door.
* @var {Array} adventurejs.VerbSubscription#with_assets
*/
this.with_assets = [];
// @TODO without_assets? exclude_assets?
/**
* <strong>with_classes</strong> allows author to specify
* particular classes that can interact with this asset using the
* given verb. For example "unlock door with skeleton key" where
* any instance of the class SkeletonKey can unlock door.
* @var {Array} adventurejs.VerbSubscription#with_classes
*/
this.with_classes = [];
// @TODO without_classes? exclude_classes?
/**
* <strong>with_nothing</strong> pertains only to
* direct objects. If true, the specified verb can be applied
* to the direct object without the use of any indirect object.
* @var {Boolean} adventurejs.VerbSubscription#with_nothing
*/
this.with_nothing = false;
/**
* <strong>with_params</strong> is used to contain a set
* of parameters that are specific to this particular verb.
* For example, plugIn includes <code>with_params.max_connections</code>
* for setting limits on how many other assets one asset can be plugged into.
* See any given verb's documentation to learn if it has any
* special parameters.
* @var {Object} adventurejs.VerbSubscription#with_params
*/
this.with_params = {};
/**
* <strong>with_prepositions</strong> allows author to
* explicitly permit certain prepositions to be used with a verb
* on this object. For instance:
* "knock over umbrella stand" might fail with a message of
* "you can't knock over the umbrella stand"; setting
* <code>umbrella_stand.dov.knock.with_prepositions = ["over"]</code>
* will allow the action to succeed.
* @var {Array} adventurejs.VerbSubscription#with_prepositions
*/
this.with_prepositions = [];
// @TODO without_prepositions? exclude_prepositions?
return this;
}
get context_id() {
return this._context_id;
}
set context_id(id) {
id = A.serialize(id);
this._context_id = id;
}
get context() {
return this.game.getAsset(this._context_id);
}
/**
* Enable this verb on its parent asset.
* @memberOf adventurejs.VerbSubscription
* @method adventurejs.VerbSubscription#enable
*/
enable() {
this.enabled = true;
}
/**
* Disable this verb on its parent asset.
* @memberOf adventurejs.VerbSubscription
* @method adventurejs.VerbSubscription#disable
*/
disable() {
this.enabled = false;
}
}
adventurejs.VerbSubscription = VerbSubscription;
})();