Pre-release
AdventureJS Docs Downloads
Score: 0 Moves: 0

Class:Tangible

Extends: adventurejs.Matter

Defined in: adventure/assets/Tangible.js, line 4

More info: AboutTangibles

Public Constructor:

MyGame.createAsset({ "class":"Tangible", "name":"foo", [...] })

Tangible is the base class for all Assets with physical properties in the game world, with the exception of Substances. All of the properties of Tangible are inherited by all of its subclasses, and most subclasses don't define new properties. Most subclasses are essentially convenience methods that set a group of properties particular to a type of object. In theory, an instance of almost any subclass could be made to behave like an instance of almost any other subclass, simply by setting the right properties. This provides the flexibility to mix and match properties to construct game assets with customized behaviors.

For example, Chair defines something you can sit on, and Bed defines something you can lie on, but perhaps you want to make something like a divan, that you can sit on and lie on. You could create a Chair and set asset.aspects.on.nest.can.lie property to true. 

MyGame.createAsset({
  class: "Chair",
  name: "divan",
  descriptions: {look:"A comfortable looking fainting couch. ",),
  aspects:
  {
    on: { nest: { can: { lie: true } } }
  }
});
This is a simple example of customizing an object, but hopefully it gives you an idea of how flexible the Tangible class is. Alternatively if you wanted to extensively customize your divan, you could define your own Divan class to extend Furniture.

Private Constructor:

var foo = new adventurejs.Tangible(game_name, name)

Though all in-game glasses use a standard constructor method under the hood, it's unlikely that you'd need to call it directly. To create an instance of the Tangible class, it must be defined in a game file as a generic object. That object will be used at runtime to construct a new game class instance, which will be validated and initialized before adding it to the Game. See above for the public constructor, or see Game#createAsset to learn more.

Parameters:

  • game_name String
    The name of the top level game object.
  • name String
    A name for the object, to be serialized and used as ID.
Inherited Overrides

Index

Methods:

Properties:

Methods Collapse all  |  Expand all

$can()

Defined in: adventure/asset/$can.js, line 6

Inherited from: adventurejs.Asset#$can

$can() is a general method for getting at asset properties stored in asset.can.
$contains(id) → {Boolean}

Defined in: adventure/assets/tangible/$contains.js, line 5

Parameters:

  • id String
Check whether this asset contains the specified asset. Works with tangibles and substances.

Returns:

Boolean
$is(property, asset)

Defined in: adventure/assets/tangible/$is.js, line 5

Overrides from: adventurejs.Matter#$is

Todos: Leaving open the possibility for other params.

Parameters:

  • property String
  • asset Object
$is() is a convenience method for authors that provides an easy way to test for various conditions.
  • assetA.$is("reservoir")
    asking, is this asset a substance reservoir such as a lake or desert?
  • assetA.$is("broken")
    asking, is this asset broken?
  • assetA.$is("carried")
    asking, is this asset in the player's inventory?
  • assetA.$is("closed")
    asking, is this asset closed?
  • assetA.$is("dead")
    asking, is this character dead?
  • assetA.$is("held", assetB)
    asking, is this asset held by that asset, as in a bannister held by player?
  • assetA.$is("holding", assetB)
    asking, is this asset holding that asset, as in player holding a rope?
  • assetA.$is("in"|"on"|"under"|"behind"|"attached", assetB)
    accepts any preposition, asking, is this asset in that aspect of that asset?
  • assetA.$is("inhands")
    asking, is this asset in the player's hands?
  • assetA.$is("known")
    asking, is this asset known by player?
  • assetA.$is("locked")
    asking, is this asset locked?
  • assetA.$is("nested in", assetB)
    nested in, specific to character classes, asking, is this asset nested in that asset?
  • assetA.$is("open")
    asking, is this asset open?
  • assetA.$is("plugged")
    asking, is this asset plugged?
  • assetA.$is("present")
    asking, is this asset present in player's location?
  • assetA.$is("reachable")
    asking, is this asset reachable by player?
  • assetA.$is("sealed")
    asking, is this asset sealed?
  • assetA.$is("takeable")
    asking, can this asset be taken?
  • assetA.$is("unlocked")
    asking, is this asset unlocked?
  • assetA.$is("unplugged")
    asking, is this asset unplugged?
  • assetA.$is("unsealed")
    asking, is this asset unsealed?
  • assetA.$is("visible")
    asking, is this asset visible to player?
  • assetA.$is("worn")
    asking, is this asset being worn?
  • assetA.$is("zipped")
    asking, is this asset zipped?
$moveTo(aspect, asset)

Defined in: adventure/assets/tangible/$moveTo.js, line 5

Parameters:

  • aspect String
  • asset Object
$moveTo is an author shortcut that is similar to moveTo but which bypasses onMoveThatToThis, avoiding the consequences of any verb actions.
$must()

Defined in: adventure/asset/$must.js, line 6

Inherited from: adventurejs.Asset#$must

$must() is a general method for getting at asset properties stored in asset.must.
$quirks() → {Boolean}

Defined in: adventure/asset/$quirk.js, line 6

Inherited from: adventurejs.Asset#$quirks

$quirk() is a general method for getting at asset properties stored in asset.quirks.

Returns:

Boolean
addAssetAt() → {Array}

Defined in: adventure/assets/tangible/addAssetAt.js, line 5

Add specified asset id to the contents of specified aspect on this asset. Returns contents if aspect exists, or null.

Returns:

Array
addWordsToLookup(words, type)

Defined in: adventure/asset/addWordsToLookup.js, line 5

Inherited from: adventurejs.Asset#addWordsToLookup

Parameters:

  • words Array
  • type String
addWordsToLookup() takes words associated with this asset and adds them to the global lookup table.
aliases()

Defined in: adventure/Asset.js, line 812

Inherited from: adventurejs.Asset#aliases

aliases() is a collection of method names that are meant for authors to use. Since they don't exist on all classes, we set up these aliases so that, if authors call them on classes they're not applicable to, they will politely return null instead of throwing a "not a function" error.
allowVerbOnce(verb, ov) → {Boolean}

Defined in: adventure/asset/allowVerbOnce.js, line 5

Inherited from: adventurejs.Asset#allowVerbOnce

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
allowVerbOnce is a method to check whether this asset is subscribed to allow the specified verb to act on it as only once.

Returns:

Boolean
allowVerbWithAnything(verb, ov) → {Boolean}

Defined in: adventure/asset/allowVerbWithAnything.js, line 5

Inherited from: adventurejs.Asset#allowVerbWithAnything

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
allowVerbWithAnything is a method to check whether this asset is subscribed to act as a direct object with the specified verb without any direct object.

Returns:

Boolean
allowVerbWithAsset(verb, asset, ov) → {Boolean}

Defined in: adventure/asset/allowVerbWithAsset.js, line 5

Inherited from: adventurejs.Asset#allowVerbWithAsset

Parameters:

  • verb String
    The name of a verb.
  • asset Object
    A game asset.
  • ov String
    Direct or indirect object of verb.
allowVerbWithAsset is a method to check whether this asset is subscribed to act as an object with the specified verb and object.

Returns:

Boolean
allowVerbWithNothing(verb, ov) → {Boolean}

Defined in: adventure/asset/allowVerbWithNothing.js, line 5

Inherited from: adventurejs.Asset#allowVerbWithNothing

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
allowVerbWithNothing is a method to check whether this asset is subscribed to act as a direct object with the specified verb without any indirect object. For example, "plug in computer" where when an outlet is implied but not defined.

Returns:

Boolean
allowVerbWithPreposition(verb, prep, ov) → {Boolean}

Defined in: adventure/asset/allowVerbWithPreposition.js, line 5

Inherited from: adventurejs.Asset#allowVerbWithPreposition

Parameters:

  • verb String
    A verb name.
  • prep String
    A preposition.
  • ov String
    Direct or indirect object of verb.
Return whether the specified preposition is explicitly allowed for this verb and object.

Returns:

Boolean
areAnscestorsClosed() → {Boolean}

Defined in: adventure/assets/tangible/areAnscestorsClosed.js, line 5

Checks to see if this asset's containing parent(s) is closed. Takes into account nesting doll situations and looks all the way up the chain. Useful for determining whether a player can interact with a nested object.

Returns:

Boolean
areAnscestorsKnown() → {Boolean}

Defined in: adventure/assets/tangible/areAnscestorsKnown.js, line 5

Checks to see if this asset and its containing parent(s) are known to player. Takes into account nesting doll situations and looks all the way up the chain. Useful for determining whether a player can "see" a nested object.

Returns:

Boolean
areAnscestorsOpen() → {Boolean}

Defined in: adventure/assets/tangible/areAnscestorsOpen.js, line 5

Checks to see if this asset's containing parent(s) is open. Takes into account nesting doll situations and looks all the way up the chain. Useful for determining whether a player can interact with a nested object.

Returns:

Boolean
areAnscestorsUnknown(nestlevel) → {Boolean}

Defined in: adventure/assets/tangible/areAnscestorsUnknown.js, line 5

Parameters:

  • nestlevel int
Checks to see if this asset or its containing parent(s) are unknown to player. Takes into account nesting doll situations and looks all the way up the chain. Useful for determining whether a player can "see" a nested object.

Returns:

Boolean
callAction(action, asset2, asset3, params) → {Boolean}

Defined in: adventure/asset/callAction.js, line 5

Inherited from: adventurejs.Asset#callAction

Parameters:

  • action string
  • asset2 string
    We use asset.name here instead of asset.id in support of authors, because we're never asking them to deal in IDs, only names. Hooks will only be defined by authors, so we let them use asset.name as their identifier. We do however make an effort to see if an id has been passed instead of a name, because Ivan.
  • asset3 string
  • params object
    Arbitrary parameter object.
Check if this asset has a general verb action or reaction for the specified event, or if the asset has an action for the specific asset. If either form is found, pass it to getStringOrArrayOrFunction and return the results. If the result returns false or null it will terminate the calling verb's default behavior.

Returns:

Boolean
canBePut(aspect, asset) → {Boolean}

Defined in: adventure/assets/tangible/canBePlacedInAspectOfAsset.js, line 5

Parameters:

  • aspect String
  • asset Object
Check whether this asset can be placed within the specified aspect of the specified asset. This takes into account the with_assets and with_classes properties.

Returns:

Boolean
canCharacterReachThatFromThis(object) → {Boolean}

Defined in: adventure/assets/tangible/canSubjectReachThatFromThis.js, line 5

Parameters:

  • object Object
Check whether that asset can be reached by player when nested in this asset.

Returns:

Boolean
canContainAssetAt(object) → {Boolean}

Defined in: adventure/assets/tangible/canContainAssetAt.js, line 5

Parameters:

  • object Object
Check whether this asset can be attached to specified other asset.

Returns:

Boolean
canContainSubstance() → {Boolean}

Defined in: adventure/assets/tangible/canContainSubstance.js, line 5

Determine whether asset can contain any substance.

Returns:

Boolean
canDoVerbAutomatically(verb) → {Boolean}

Defined in: adventure/asset/canDoVerbAutomatically.js, line 5

Inherited from: adventurejs.Asset#canDoVerbAutomatically

Parameters:

  • verb String
canDoVerbAutomatically is a method to check whether the specified verb can be performed automatically. Assumes that asset.dov[verb].enabled is true.

Returns:

Boolean
canNestPlayerAt(aspect) → {Boolean}

Defined in: adventure/assets/tangible/canNestPlayerAt.js, line 8

Parameters:

  • aspect String
    A Tangible Aspect ID.
Ask if player can nest in an aspect of this asset.

Returns:

Boolean
canSetVerbState(verb) → {Boolean}

Defined in: adventure/asset/canSetVerbState.js, line 5

Inherited from: adventurejs.Asset#canSetVerbState

Parameters:

  • verb String
canSetVerbState is a method to check whether the specified verb can set state on this asset. Assumes that asset.dov[verb].enabled is true

Returns:

Boolean
containsAnyAsset() → {Boolean}

Defined in: adventure/assets/tangible/containsAnyAsset.js, line 5

Check whether this asset contains any assets in any aspects.

Returns:

Boolean
containsAnyAssetAt(aspect) → {Boolean}

Defined in: adventure/assets/tangible/containsAnyAssetAt.js, line 5

Parameters:

  • aspect String
Check whether this asset contains any assets at the specified aspect.

Returns:

Boolean
containsAnySubstance() → {Boolean}

Defined in: adventure/assets/tangible/containsAnySubstance.js, line 5

Check whether this asset contains any substance.

Returns:

Boolean
containsAnySubstanceAt(aspect) → {Boolean}

Defined in: adventure/assets/tangible/containsAnySubstanceAt.js, line 5

Parameters:

  • aspect String
Check whether this asset contains any substance at specified aspect.

Returns:

Boolean
containsAsset(id) → {String}

Defined in: adventure/assets/tangible/containsAsset.js, line 5

Parameters:

  • id String
Check whether this asset contains the specified asset at any aspect.

Returns:

String
containsAssetAt(id, aspect) → {Boolean}

Defined in: adventure/assets/tangible/containsAssetAt.js, line 5

Parameters:

  • id String
  • aspect String
Check whether this asset contains the specified asset at the specified aspect.

Returns:

Boolean
containsSubstance(id) → {String}

Defined in: adventure/assets/tangible/containsSubstance.js, line 5

Parameters:

  • id String
Check whether this asset contains the specified substance.

Returns:

String
containsSubstanceAt(id, aspect) → {Boolean}

Defined in: adventure/assets/tangible/containsSubstanceAt.js, line 5

Parameters:

  • id String
  • aspect String
Check whether this asset contains the specified substance at the specified aspect.

Returns:

Boolean
destroy()

Defined in: adventure/assets/Tangible.js, line 1117

Overrides from: adventurejs.Matter#destroy

Remove this asset from the world before calling superclass.destroy.
didDoVerbs(verbs) → {Boolean}

Defined in: adventure/asset/didDoVerbs.js, line 5

Inherited from: adventurejs.Asset#didDoVerbs

Parameters:

  • verbs Array
didDoVerbs check whether any of the specified verbs has ever been applied to the asset as a direct object. This is a convenience method that relies on asset.didVerb()

Returns:

Boolean
didIoVerbs(verbs) → {Boolean}

Defined in: adventure/asset/didIoVerbs.js, line 5

Inherited from: adventurejs.Asset#didIoVerbs

Parameters:

  • verbs Array
didIoVerbs check whether any of the specified verbs has ever been applied to the asset as an indirect object. This is a convenience method that relies on asset.iDidVerb()

Returns:

Boolean
didVerb(verb, ov) → {Boolean}

Defined in: adventure/asset/didVerb.js, line 5

Inherited from: adventurejs.Asset#didVerb

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
didVerb is a method to check whether this asset was already used as an object by the specified verb.

$did is an alias for authors.

Returns:

Boolean
didVerbCount(verb, ov) → {Int}

Defined in: adventure/asset/didVerbCount.js, line 5

Inherited from: adventurejs.Asset#didVerbCount

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
didVerbCount is a method to get a count of times this asset was used as a direct object by the specified verb.

$didCount is an alias for authors.

Returns:

Int
findNestedAssetsWithClass(instanceClass) → {Array}

Defined in: adventure/assets/tangible/findNestedAssetsWithClass.js, line 5

Parameters:

  • instanceClass String
Find instances of specified class within this asset, for example find all coins within a purse. Returns an array of assets.

Returns:

Array
findNestedAssetsWithProperty(property) → {Array}

Defined in: adventure/assets/tangible/findNestedAssetsWithProperty.js, line 5

Parameters:

  • property String
Find assets that have a particular property, for example find all assets emitting light. Returns an array of assets.

Returns:

Array
findNestedIndirectObjects(verb, direct_object) → {Array}

Defined in: adventure/assets/tangible/findNestedIndirectObjects.js, line 5

Parameters:

  • verb String
    The name of a verb.
  • direct_object Object | String
    An asset or asset ID of a direct object that the player has tried to perform an indirect verb on.
Returns a list of assets nested in this asset, if any, that can perform the specified verb upon the specified asset as defined in the target asset.dov[verb].with_assets/with_classes property. Works with verbs including open & close, pick, lock & unlock, and seal & unseal.

Returns:

Array An array of indirect objects, if found.
get(property, qualifier)

Defined in: adventure/assets/tangible/$get.js, line 5

Parameters:

  • property String
  • qualifier String
Utility function that provides an easy way for authors to test for various conditions.
  • all - list all children in all aspects of this
  • allnested - list all descendents in all aspects of this
  • behind - list things behind this
  • in - list things in this
  • on - list things on this
  • under - list things under this
  • attached - list things attached to this
getAllContents() → {Array}

Defined in: adventure/assets/tangible/getAllContents.js, line 5

Returns an array of all content in any location

Returns:

Array
getAllNestedContents() → {Array}

Defined in: adventure/assets/tangible/getAllNestedContents.js, line 5

Get list of other assets nested within this one.

Returns:

Array
getAncestorId() → {String}

Defined in: adventure/assets/tangible/getAncestorId.js, line 5

Get the ID of this asset's topmost parent, excluding Room.

Returns:

String
getAnySubstanceThisContains() → {String}

Defined in: adventure/assets/tangible/getAnySubstanceThisContains.js, line 5

Get the substance, if any, contained in this asset.

Returns:

String
getAspectAt(aspect) → {Object|Null}

Defined in: adventure/assets/tangible/getAspectAt.js, line 5

Parameters:

  • aspect string
    The aspect to get.
Get aspect at specified preposition.

Returns:

Object | Null
getClassInheritance() → {Array}

Defined in: adventure/Atom.js, line 144

Inherited from: adventurejs.Atom#getClassInheritance

getClassInheritance is a utility method to get an asset's class inheritance chain. Returns a list of class names from high to low.

Returns:

Array
getClosedAnscestors() → {Array}

Defined in: adventure/assets/tangible/getClosedAnscestors.js, line 5

Get a list of this asset's containing parent(s) that are closed. Takes into account nesting doll situations and looks all the way up the chain. Useful for determining whether a player can interact with a nested object.

Returns:

Array
getContentsAt() → {Array}

Defined in: adventure/assets/tangible/getContentsAt.js, line 5

Returns an array of all content in the specified aspect.

Returns:

Array
getCountOfListableContentsAt(where) → {int}

Defined in: adventure/assets/tangible/getCountOfListableContentsAt.js, line 5

Parameters:

  • where String
Get a count of assets within this asset that are listable in this asset's description, for example when player examines this.

Returns:

int
getDepth() → {Float}

Defined in: adventure/assets/tangible/getDepth.js, line 5

Get this asset's depth.

Returns:

Float
getHeight() → {Float}

Defined in: adventure/assets/tangible/getHeight.js, line 5

Get this asset's height.

Returns:

Float
getListableContents() → {Array}

Defined in: adventure/assets/tangible/getListableContents.js, line 5

Get an array of assets within this asset that are listable in this asset's description, for example when player examines this.

Returns:

Array
getNestOrPlaceAsset() → {Boolean}

Defined in: adventure/assets/tangible/getNestOrPlaceAsset.js, line 5

Get asset's parent asset. If asset is character and nested, returns nest asset, otherwise returns room asset.

Returns:

Boolean
getNestOrPlacePreposition() → {Boolean}

Defined in: adventure/assets/tangible/getNestOrPlacePreposition.js, line 5

Get preposition of asset's parent aspect. If it's a character and is nested, returns nest asset preposition, otherwise returns room asset preposition.

Returns:

Boolean
getOpenOrClosed() → {Array}

Defined in: adventure/assets/tangible/getOpenOrClosed.js, line 5

Print a string representing open / closed state of this asset.

Returns:

Array
getPlaceAspect() → {Object|null}

Defined in: adventure/assets/tangible/getPlaceAspect.js, line 5

Returns the aspect object of this asset's parent asset or null.

Returns:

Object | null
getPlaceAsset() → {Object|Boolean}

Defined in: adventure/assets/tangible/getPlaceAsset.js, line 5

Get the object of this asset's parent asset.

Returns:

Object | Boolean
getPlaceAssetId() → {String}

Defined in: adventure/assets/tangible/getPlaceAssetId.js, line 5

Returns the ID of asset's parent or a blank string.

Returns:

String
getPlacePreposition() → {String}

Defined in: adventure/assets/tangible/getPlacePreposition.js, line 5

Returns the aspect id of this asset's parent asset, or a blank string.

Returns:

String
getPrettyPlacePreposition() → {String}

Defined in: adventure/assets/tangible/getPrettyPlacePreposition.js, line 5

Returns a printable version of the aspect id of this asset's parent asset. Intedned mostly for "attached" which should print as "attached to".

Returns:

String
getPrintableListOfContents(params) → {String}

Defined in: adventure/assets/tangible/getPrintableListOfContents.js, line 5

Parameters:

  • params Object
Get a printable list of assets within all Aspects of this asset, for example to append to asset description when player inputs "examine this". Returns a string.

Returns:

String
getRoomAsset() → {String}

Defined in: adventure/assets/tangible/getRoomAsset.js, line 5

Get the asset of the room this asset is in.

Returns:

String
getRoomId() → {String}

Defined in: adventure/assets/tangible/getRoomId.js, line 5

Get the ID of the room this asset is in.

Returns:

String
getRopesThatBlockTravel() → {Array}

Defined in: adventure/assets/tangible/getRopesThatBlockTravel.js, line 5

Check if player is holding a rope, or tied by a rope, that is tied at the other end, preventing player from leaving room. Return a list of assets that meet this qualification.

Returns:

Array
getSubstanceAt() → {String}

Defined in: adventure/assets/tangible/getSubstanceAt.js, line 5

Get the substance, if any, contained in this asset.

Returns:

String
getThingThisIsTiedToPlayerBy() → {Object}

Defined in: adventure/assets/tangible/getThingThisIsTiedToPlayerBy.js, line 5

Assuming this asset is tied to the player asset by means of a third thing, get that third thing. Returns an asset object.

Returns:

Object
getTiedThingsThatDragOnTravel() → {Array}

Defined in: adventure/assets/tangible/getTiedThingsThatDragOnTravel.js, line 5

Check if player is holding a rope, or tied by a rope, that is tied at the other end to an asset that can travel with player. Return a list of assets that meet this qualification.

Returns:

Array
getVerbConnectionCount(verb, to_ov) → {Int}

Defined in: adventure/asset/getVerbConnectionCount.js, line 5

Inherited from: adventurejs.Asset#getVerbConnectionCount

Parameters:

  • verb String
    The name of a verb.
  • to_ov String
    Connection to direct or indirect objects of verb.
Return the number of assets connected to this asset via the specified verb.

Returns:

Int
getVerbConnections(verb, to_ov) → {Array}

Defined in: adventure/asset/getVerbConnections.js, line 5

Inherited from: adventurejs.Asset#getVerbConnections

Parameters:

  • verb String
    The name of a verb.
  • to_ov String
    Connection to direct or indirect objects of verb.
Return an array of asset ids connected to this asset via the specified verb.

Returns:

Array
getVerbMaxConnections(verb, ov) → {Boolean}

Defined in: adventure/asset/getVerbMaxConnections.js, line 5

Inherited from: adventurejs.Asset#getVerbMaxConnections

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
Get the maximum number of connections allowed by the specified verb, inclusive of direct and indirect subscriptions.

Returns:

Boolean
getVerbParam(verb, param) → {*}

Defined in: adventure/asset/getVerbParam.js, line 5

Inherited from: adventurejs.Asset#getVerbParam

Parameters:

  • verb String
    The name of a verb.
  • param String
    The name of a param in with_params.
Return the value of the specified parameter in the specified verb subscription.

Returns:

*
getVerbState()

Defined in: adventure/asset/getVerbState.js, line 5

Inherited from: adventurejs.Asset#getVerbState

getVessel() → {Object|Null}

Defined in: adventure/assets/tangible/getVessel.js, line 5

Get substance container. This is dodgy because, in theory, any aspect can contain substance, but in practice we only use "in".

Returns:

Object | Null
getVesselAt(aspect) → {Object|Null}

Defined in: adventure/assets/tangible/getVesselAt.js, line 5

Parameters:

  • aspect string
    The aspect to check.
Get substance container at specified preposition.

Returns:

Object | Null
getVesselPreposition() → {String}

Defined in: adventure/assets/tangible/getVesselPreposition.js, line 5

Get this asset's substance location. This is somewhat ambiguous because in theory an asset can have multiple substance locations but in practice we clearly prefer 'in'.

Returns:

String
getWidth() → {Float}

Defined in: adventure/assets/tangible/getWidth.js, line 5

Get this asset's width.

Returns:

Float
getY() → {Float}

Defined in: adventure/assets/tangible/getY.js, line 5

Get this asset's global y.

Returns:

Float
getYBottom() → {Float}

Defined in: adventure/assets/tangible/getYBottom.js, line 5

Get this asset's global bottom y based on its y and height, which may be negative.

Returns:

Float
getYRange() → {Object}

Defined in: adventure/assets/tangible/getYRange.js, line 5

Get this asset's bottom y and top y based on its y and height, which may be negative.

Returns:

Object
getYTop() → {Float}

Defined in: adventure/assets/tangible/getYTop.js, line 5

Get this asset's global top y based on its y and height.

Returns:

Float
has()

Defined in: adventure/asset/$has.js, line 6

Inherited from: adventurejs.Asset#has

has is an alias to asset.isWithin() that reverses the direct and indirect objects, to test whether that asset is in this asset. 
if( MyGame.$('crown').$has('jewel') ){ // do stuff }
hasAction(hook_name, asset1_name, asset2_name) → {Boolean}

Defined in: adventure/asset/hasAction.js, line 5

Inherited from: adventurejs.Asset#hasAction

Parameters:

  • hook_name string
  • asset1_name string
    We use asset.name here instead of asset.id to make life slightly easier for authors. Asset IDs are formed from asset names, but generally we don't expect authors to be aware of IDs. Hooks will only be defined by authors, so let them use asset.name as their identifier. We do however make an effort to see if an id has been passed instead of a name.
  • asset2_name string
Check if this asset has a general verb action or reaction for the specified event, or if the asset has an action for the specific asset.

Returns:

Boolean
hasAspectAt(aspect) → {Boolean}

Defined in: adventure/assets/tangible/hasAspectAt.js, line 5

Parameters:

  • aspect String
Determine whether asset has an aspect at specified preposition.

Returns:

Boolean
hasClass(prop) → {Boolean}

Defined in: adventure/Atom.js, line 124

Inherited from: adventurejs.Atom#hasClass

Parameters:

  • prop String
    Name of the class to test for.
A method to test whether the Atom is an instance of a given class.

Returns:

Boolean
hasContentsAtAspect(aspect) → {Boolean}

Defined in: adventure/assets/tangible/hasContentsAtAspect.js, line 5

Parameters:

  • aspect String
Determine whether asset has contents at the specified aspect.

Returns:

Boolean
hasDescription(identifier) → {String|Boolean}

Defined in: adventure/asset/hasDescription.js, line 5

Inherited from: adventurejs.Asset#hasDescription

Parameters:

  • identifier String
See if asset has a description for an identifier, such as "look in book", where "in" has been defined as a key at asset.descriptions.in. "look" is always the default identifier.

Returns:

String | Boolean
hasDirectObjects(verb) → {Boolean}

Defined in: adventure/asset/hasDirectObjects.js, line 5

Inherited from: adventurejs.Asset#hasDirectObjects

Parameters:

  • verb String
hasDirectObjects is a method to check whether this asset has any particular direct objects specified by the author for use with the specified verb.

Returns:

Boolean
hasIndirectDescription(indirect_aspect, indirect_asset, direct_aspect) → {String|Boolean}

Defined in: adventure/asset/hasIndirectDescription.js, line 5

Inherited from: adventurejs.Asset#hasIndirectDescription

Deprecated
  • Yes

Todos: delete

Parameters:

  • indirect_aspect String
  • indirect_asset Object
  • direct_aspect String
Determine whether asset has an indirect description, such as "look at this through magnifying glass", where "through magnifying glass" becomes a key at asset.descriptions["through magnifying glass"]. "look" is always the default direct object description.

Returns:

String | Boolean
hasIndirectObjects(verb) → {Boolean}

Defined in: adventure/asset/hasIndirectObjects.js, line 5

Inherited from: adventurejs.Asset#hasIndirectObjects

Parameters:

  • verb String
hasIndirectObjects is a method to check whether this asset has any particular indirect objects specified by the author for use with the specified verb.

Returns:

Boolean
hasListableContents() → {Boolean}

Defined in: adventure/assets/tangible/hasListableContents.js, line 5

Todos: transparent containers

Check whether this asset has any listable contents.

Returns:

Boolean
hasPlace() → {Boolean}

Defined in: adventure/assets/tangible/hasPlace.js, line 5

Determine whether asset has a place.

Returns:

Boolean
hasPropertyOnAspectAt() → {Boolean}

Defined in: adventure/assets/tangible/hasPropertyOnAspectAt.js, line 5

Deprecated
  • this will likely go away
Determine whether asset has specified property on specified aspect. Useful for testing whether properties exist before trying to assign to them.

Returns:

Boolean
hasRopesThatBlockTravel() → {Boolean}

Defined in: adventure/assets/tangible/hasRopesThatBlockTravel.js, line 5

Determine if player is holding or tied by any ropes that block travel to other rooms.

Returns:

Boolean
hasTiedThingsThatDragOnTravel() → {Boolean}

Defined in: adventure/assets/tangible/hasTiedThingsThatDragOnTravel.js, line 5

Check if player is holding a rope, or tied by a rope, that is tied at the other end to an asset that can travel with player. Returns a boolean indicating whether any asset meets this qualification.

Returns:

Boolean
hasVerbMaxConnections(verb, to_ov) → {Boolean}

Defined in: adventure/asset/hasVerbMaxConnections.js, line 5

Inherited from: adventurejs.Asset#hasVerbMaxConnections

Todos: dov/iov or both

Parameters:

  • verb String
    The name of a verb.
  • to_ov String
    Connection to direct or indirect objects of verb.
Get whether the asset's specific verb connections are at the maximum set by verb.with_params.max_connections.

Returns:

Boolean
hasVerbParam(verb, param) → {*}

Defined in: adventure/asset/hasVerbParam.js, line 5

Inherited from: adventurejs.Asset#hasVerbParam

Parameters:

  • verb String
    The name of a verb.
  • param String
    The name of a param in with_params.
Return a boolean to indicate whether the specified parameter exists in the specified verb subscription.

Returns:

*
hasVessel() → {Boolean}

Defined in: adventure/assets/tangible/hasVessel.js, line 5

Determine whether asset has any aspect with a vessel.

Returns:

Boolean
hasVesselAtAspect(aspect) → {Boolean}

Defined in: adventure/assets/tangible/hasVesselAtAspect.js, line 5

Parameters:

  • aspect String
Determine whether asset has substance at an aspect at specified preposition.

Returns:

Boolean
iDidVerb(verb, ov) → {Boolean}

Defined in: adventure/asset/iDidVerb.js, line 5

Inherited from: adventurejs.Asset#iDidVerb

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
iDidVerb is a method to check whether this asset was already used as an indirect objecb by the specified verb.

$iDidDo is an alias for authors.

Returns:

Boolean
iDidVerbCount(verb, ov) → {Int}

Defined in: adventure/asset/iDidVerbCount.js, line 5

Inherited from: adventurejs.Asset#iDidVerbCount

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
iDidVerbCount is a method to get a count of times this asset was used as an indirect object by the specified verb.

$iDidCount is an alias for authors.

Returns:

Int
incrementDoVerbCount(verb, ov)

Defined in: adventure/asset/incrementDoVerbCount.js, line 5

Inherited from: adventurejs.Asset#incrementDoVerbCount

Parameters:

  • verb String
  • ov String
    "dov" or "iov" representing a direct or indirect object.
incrementDoVerbCount takes a verb and an object and updates this asset's count of the number of times the verb has acted upon it.
incrementTryVerbCount(verb, index)

Defined in: adventure/asset/incrementTryVerbCount.js, line 5

Inherited from: adventurejs.Asset#incrementTryVerbCount

Parameters:

  • verb String
  • index Int
incrementTryVerbCount takes a verb and an index and updates this asset's count of the number of times the verb has attempted upon it.
initialize(game) → {Boolean}

Defined in: adventure/assets/Tangible.js, line 1094

Overrides from: adventurejs.Matter#initialize

Parameters:

  • game Object
Inherited from superclass Asset. Tangible adds initialization methods that are used for all Tangible assets, including:
  • link related objects
  • register parts

Returns:

Boolean
isAttached(asset) → {boolean}

Defined in: adventure/assets/tangible/$isAttached.js, line 6

Parameters:

  • asset Object | String
    Can be string or object.
isAttached tests whether one asset is specifically in the behind aspect of another asset. This is a one-to-one check that doesn't take nesting into consideration. 
if( MyGame.$('trophy').$isAttached('plaque') ){ // do stuff }

Returns:

boolean
isBehind(asset) → {boolean}

Defined in: adventure/assets/tangible/$isBehind.js, line 6

Parameters:

  • asset Object | String
    Can be string or object.
isBehind tests whether one asset is specifically in the behind aspect of another asset. This is a one-to-one check that doesn't take nesting into consideration. 
if( MyGame.$('killer').$isBehind('curtain') ){ // do stuff }

Returns:

boolean
isConnectedToAnything(verb, to_ov) → {Boolean}

Defined in: adventure/asset/isConnectedToAnything.js, line 5

Inherited from: adventurejs.Asset#isConnectedToAnything

Parameters:

  • verb String
    The name of a verb.
  • to_ov String
    Direct or indirect object of verb.
Check whether this asset is currently connected to anything by a verb such as plugIn or tie. For example, if this asset is a computer plugged into an outlet, this method would return true.

Returns:

Boolean
isConnectedToAsset(verb, asset, to_ov) → {Boolean}

Defined in: adventure/asset/isConnectedToAsset.js, line 5

Inherited from: adventurejs.Asset#isConnectedToAsset

Parameters:

  • verb String
    The name of the verb to test.
  • asset Object | String
    A game asset or asset id to test.
  • to_ov String
    Connection to direct or indirect objects of verb.
Check whether this asset is currently connected as a direct object to the specified indirect object by the specified verb. For example, in the case of a computer plugged into an outlet, the computer would be the direct object, and calling this method on it would return true.

Returns:

Boolean
isConnectedToNothing(verb, ov) → {Boolean}

Defined in: adventure/asset/isConnectedToNothing.js, line 5

Inherited from: adventurejs.Asset#isConnectedToNothing

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
Check whether this asset is currently connected as an indirect object to nothing (aka null) by the specified verb. For example, in the case of a computer that can be plugged in, an author might prefer not to create a specific outlet into which to plug the computer. For that case we allow 'plug in computer', and write a null value to asset.is.connected_by.plugIn.to_iov to represent the computer's plugged in state.

Returns:

Boolean
isDOV(verb) → {Boolean}

Defined in: adventure/asset/isDOV.js, line 5

Inherited from: adventurejs.Asset#isDOV

Parameters:

  • verb String
isDOV is a method to check whether this asset is subscribed to allow the specified verb to act on it as a direct object.

Returns:

Boolean
isIn(asset) → {boolean}

Defined in: adventure/assets/tangible/$isIn.js, line 6

Parameters:

  • asset Object | String
    Can be string or object.
isIn tests whether one asset is specifically in the in aspect of another asset. This is a one-to-one check that doesn't take nesting into consideration. 
if( MyGame.$('rabbit').$isIn('hat') ){ // do stuff }

Returns:

boolean
isIOV(verb) → {Boolean}

Defined in: adventure/asset/isIOV.js, line 5

Inherited from: adventurejs.Asset#isIOV

Parameters:

  • verb String
isIOV is a method to check whether this asset is subscribed to allow the specified verb to act on it as an indirect object.

Returns:

Boolean
isOn(asset) → {boolean}

Defined in: adventure/assets/tangible/$isOn.js, line 6

Parameters:

  • asset Object | String
    Can be string or object.
isOn tests whether one asset is specifically in the on aspect of another asset. This is a one-to-one check that doesn't take nesting into consideration. 
if( MyGame.$('fishbowl').$isOn('credenza') ){ // do stuff }

Returns:

boolean
isOV(verb) → {Boolean}

Defined in: adventure/asset/isOV.js, line 5

Inherited from: adventurejs.Asset#isOV

Parameters:

  • verb String
isOV is a method to check whether this asset is subscribed to allow the specified verb to act on it as either a direct or indirect object.

Returns:

Boolean
isPlacedAtAspect() → {Boolean}

Defined in: adventure/assets/tangible/isPlacedAtAspect.js, line 5

Verify that asset is in the specified aspect. For example, cap.isPlacedAtAspect( 'attached' )

Returns:

Boolean
isPlacedAtAspectAndAsset(aspect, asset) → {Boolean}

Defined in: adventure/assets/tangible/isPlacedAtAspectAndAsset.js, line 5

Parameters:

  • aspect String
  • asset String
Determine whether asset has a place. Can be used to test against specific aspects and parent assets. For example, cap.isPlacedAtAspectAndAsset( 'attached', 'pen' )

Returns:

Boolean
isUnder(asset) → {boolean}

Defined in: adventure/assets/tangible/$isUnder.js, line 6

Parameters:

  • asset Object | String
    Can be string or object.
isUnder tests whether one asset is specifically in the under aspect of another asset. This is a one-to-one check that doesn't take nesting into consideration. 
if( MyGame.$('monster').$isUnder('bed') ){ // do stuff }

Returns:

boolean
isVerbState(verb) → {Boolean}

Defined in: adventure/asset/isVerbState.js, line 5

Inherited from: adventurejs.Asset#isVerbState

Parameters:

  • verb String
isVerbState is a method to check whether this asset already has state set by the specified verb.

Returns:

Boolean
isWithin(asset) → {boolean}

Defined in: adventure/assets/tangible/$isWithin.js, line 6

Parameters:

  • asset Object | String
    Can be string or object.
isWithin tests whether one asset is in (any aspect of) another asset. 
if( MyGame.$('jewel').$isWithin('crown') ){ // do stuff }

Returns:

boolean
isWithinYRange(asset) → {Boolean}

Defined in: adventure/assets/tangible/isWithinYRange.js, line 5

Parameters:

  • asset Object
Determine whether this asset's y position is within another asset's y range, aka its height from its y position.

Returns:

Boolean
iTriedVerb(verb, ov) → {Boolean}

Defined in: adventure/asset/iTriedVerb.js, line 5

Inherited from: adventurejs.Asset#iTriedVerb

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
iTriedVerb is a method to check whether it was attempted to use this asset as an indirect object by the specified verb.

$iTried is an alias for authors.

Returns:

Boolean
iTriedVerbCount(verb, ov) → {Boolean}

Defined in: adventure/asset/iTriedVerbCount.js, line 5

Inherited from: adventurejs.Asset#iTriedVerbCount

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
iTriedVerbCount is a method to get a count of times it was attempted to use this asset as an indirect object by the specified verb.

$iTryCount is an alias for authors.

Returns:

Boolean
linkRegisteredParts()

Defined in: adventure/assets/tangible/linkRegisteredParts.js, line 5

linkRegisteredParts does the bulk of the work for registerParts. The base method defined in Tangible is blank. Subclasses that can make use of it will override the method as needed.
moveFrom(asset) → {Boolean}

Defined in: adventure/assets/tangible/$moveFrom.js, line 5

Parameters:

  • asset Object
$moveFrom is an author shortcut that is similar to moveFrom but which bypasses onRemoveThatFromThis, avoiding the consequences of any verb actions.

Returns:

Boolean
moveFrom(asset) → {Boolean}

Defined in: adventure/assets/tangible/moveFrom.js, line 5

Parameters:

  • asset Object
moveFrom is an alias to onRemoveThatFromThis but with asset and this reversed purely for syntactic convenience.

Returns:

Boolean
moveTo(aspect, asset)

Defined in: adventure/assets/tangible/moveTo.js, line 5

Parameters:

  • aspect String
  • asset Object
moveFrom is an alias to onMoveThatToThis but with asset and this reversed purely for syntactic convenience.
onAddSubstanceToThis(asset)

Defined in: adventure/assets/tangible/onAddSubstanceToThis.js, line 5

Parameters:

  • asset Object
Called when a substance asset is added to this, providing an opportunity to override default behavior through the use of verb effect hook doAddSubstanceToThis.
onChangeGravity()

Defined in: adventure/assets/tangible/onChangeGravity.js, line 5

Called when there is a change in gravity, providing an opportunity to override default behavior through the use of verb effect hook doChangeGravity.
onChangeMoisture(asset)

Defined in: adventure/assets/tangible/onChangeMoisture.js, line 5

Todos: This should probably take a moisture value rather than an asset.

Parameters:

  • asset Object
Called when there is a change in moisture level, providing an opportunity to override default behavior through the use of verb effect hook doChangeMoisture.
onChangeTemperature()

Defined in: adventure/assets/tangible/onChangeTemperature.js, line 5

Called when there is a change in temperature, providing an opportunity to override default behavior through the use of verb effect hook doChangeTemperature.
onMoistenThisWithThat(asset)

Defined in: adventure/assets/tangible/onMoistenThisWithThat.js, line 5

Parameters:

  • asset Object
Called when an asset is moistened with a liquid substance, providing an opportunity to override default behavior through the use of verb effect hook doMoistenThisWithThat.
onMoveThatToThis(asset, where) → {Boolean}

Defined in: adventure/assets/tangible/onMoveThatToThis.js, line 5

Parameters:

  • asset Object
  • where String
Called when another asset is added to this. Provides opportunities to override default behavior through the use of verb reactions doMoveThisToThat and doMoveThatToThis.

Returns:

Boolean
onNestThatToThis(player) → {Boolean}

Defined in: adventure/assets/tangible/onNestThatToThis.js, line 5

Parameters:

  • player Object
Called when a player asset is nested to this. Provides an opportunity to override default behavior through the use of verb reactions doNestThatToThis.

Returns:

Boolean
onRemoveThatFromThis(asset) → {Boolean}

Defined in: adventure/assets/tangible/onRemoveThatFromThis.js, line 5

Parameters:

  • asset Object
Called when another asset is removed from this. Provides opportunities to override default behavior through the use of verb reactions doRemoveThisFromThat and doRemoveThatFromThis.

Returns:

Boolean
onSubtractSubstanceFromThis(asset)

Defined in: adventure/assets/tangible/onSubtractSubstanceFromThis.js, line 5

Parameters:

  • asset Object
Called when a substance is subtracted from this, providing an opportunity to override default behavior through the use of verb reactions doSubtractSubstanceFromThis.
onTieThisToThat(asset) → {Boolean}

Defined in: adventure/assets/tangible/onTieThisToThat.js, line 5

Parameters:

  • asset Object
Called when this asset is tied to another asset. Provides opportunities to override default behavior through the use of verb reactions doTieThisToThat and doTieThatToThis.

Returns:

Boolean
onUnnestThatFromThis(player) → {Boolean}

Defined in: adventure/assets/tangible/onUnnestThatFromThis.js, line 5

Parameters:

  • player Object
Called when player is unnested from this asset. Provides an opportunity to override default behavior through the use of verb reactions doUnnestThatFromThis.

Returns:

Boolean
onUntieThisFromThat(asset) → {Boolean}

Defined in: adventure/assets/tangible/onUntieThisFromThat.js, line 5

Parameters:

  • asset Object
Called when this asset is untied from another asset. Provides opportunities to override default behavior through the use of verb reactions doUntieThisFromThat and doUntieThatFromThis.

Returns:

Boolean
placePreventsNesting(player) → {Boolean}

Defined in: adventure/assets/tangible/placePreventsNesting.js, line 5

Parameters:

  • player Object
Check whether the specified asset can be nested to this while this is in its current location.

Returns:

Boolean
put(preposition, indirect_object)

Defined in: adventure/assets/tangible/$put.js, line 8

Parameters:

  • preposition String
  • indirect_object Object | String
    asset object or name/id
put places one asset inside another, bypassing onMoveThatToThis and subsequent doMoveThatToThis/doMoveThisToThat.
redirectVerb(oldVerb, newVerb)

Defined in: adventure/asset/redirectVerb.js, line 6

Inherited from: adventurejs.Asset#redirectVerb

Parameters:

  • oldVerb String
  • newVerb String
redirectVerb is a method for setting a verb redirect on this asset, such that when one verb is called on the asset, another verb will be called instead. Example: player enters "hit person", it is redirected to "slap person".
registerParts()

Defined in: adventure/assets/tangible/registerParts.js, line 5

registerParts is a shortcut method for use with complex objects that have interlinked parts. For example, a sink of class Drainable can have a faucet, a drain, and multiple handles, each of which interact with the base object or other objects in the collection in different ways. Registering parts with the base object offers an opportunity to create object references and share variables.
removeAssetAt() → {Array}

Defined in: adventure/assets/tangible/removeAssetAt.js, line 5

Remove specified asset id from the contents of specified aspect on this asset. Returns contents if aspect exists, or null.

Returns:

Array
removeThatFromThis(asset)

Defined in: adventure/assets/tangible/removeThatFromThis.js, line 5

Parameters:

  • asset Object
Removes an asset from another asset. It's not meant to be called directly, but is the last piece, or bedrock, of the removal process after checking for custom logic.
set(props) → {Object}

Defined in: adventure/Atom.js, line 112

Inherited from: adventurejs.Atom#set

Parameters:

  • props Object
    A generic object containing properties to copy to the Object instance.
Provides a chainable shortcut method for setting a number of properties on the instance.

Returns:

Object Returns the instance the method is called on (useful for chaining calls.)
setAllAspectsContentsKnown()

Defined in: adventure/assets/tangible/setAllAspectsContentsKnown.js, line 5

This function will try to set all aspect contents of this asset known.
setAllAspectsContentsSeen()

Defined in: adventure/assets/tangible/setAllAspectsContentsSeen.js, line 5

This function will try to set all visible aspect contents of this asset seen.
setAspectAt(aspect) → {Array}

Defined in: adventure/assets/tangible/setAspectAt.js, line 5

Parameters:

  • aspect string
    The aspect to add.
Add an aspect at the specified aspect on this asset.

Returns:

Array
setAspectContentsKnown()

Defined in: adventure/assets/tangible/setAspectContentsKnown.js, line 5

When player knows an asset, call this function to make its contents known. Generally, contents of behind/in/on/under are listed automatically and known, whereas attachments may go unlisted in room descriptions. This function is chiefly for setting is.known for attachments, but can be applied to any aspects.
setAspectContentsSeen()

Defined in: adventure/assets/tangible/setAspectContentsSeen.js, line 5

When player sees an asset, call this function to make its contents known. Generally, contents of behind/in/on/under are listed automatically and seen, whereas attachments may go unlisted in room descriptions. This function is chiefly for setting is.seen for attachments, but can be applied to any aspects.
setAttachmentsKnown()

Defined in: adventure/assets/tangible/setAttachmentsKnown.js, line 5

Attachments may go unlisted in room descriptions unlike other assets. It's assumed that the author will include them in their parent's description. For example "The desk has a drawer" where drawer is an attachment. When these assets go unlisted, they miss being marked as seen / known like other assets. This function explicitly sets attachments known / seen.
setDOV(verb, params)

Defined in: adventure/asset/setDOV.js, line 6

Inherited from: adventurejs.Asset#setDOV

Parameters:

  • verb String
  • params Object
setDOV is a passthrough to setVerbSubscription with direct object specified.
setDOVs(verb, params)

Defined in: adventure/asset/setDOVs.js, line 6

Inherited from: adventurejs.Asset#setDOVs

Parameters:

  • verb String
  • params Object
setDOVs is a passthrough to send multiple verbs to setVerbSubscription with direct object specified.
setIOV(verb, params)

Defined in: adventure/asset/setIOV.js, line 6

Inherited from: adventurejs.Asset#setIOV

Parameters:

  • verb String
  • params Object
setIOV is a passthrough to setVerbSubscription with indirect object specified.
setIOVs(verb, params)

Defined in: adventure/asset/setIOVs.js, line 6

Inherited from: adventurejs.Asset#setIOVs

Parameters:

  • verb String
  • params Object
setIOVs is a passthrough to send multiple verbs to setVerbSubscription with indirect object specified.
setIs(bool)

Defined in: adventure/asset/setIs.js, line 6

Inherited from: adventurejs.Asset#setIs

Parameters:

  • bool Boolean
Set asset.is.state.
setLinkedState(bool)

Defined in: adventure/asset/setLinkedState.js, line 6

Inherited from: adventurejs.Asset#setLinkedState

Parameters:

  • bool Boolean
setLinkedState sets an asset and its linked asset to the specified state.
setObjectOfVerbs(object_of, verb)

Defined in: adventure/asset/setObjectOfVerbs.js, line 6

Inherited from: adventurejs.Asset#setObjectOfVerbs

Parameters:

  • object_of String
  • verb String
setObjectOfVerbs is a convenience method that passes a list of verb names through to setVerbSubscription.
setPlace(aspect, asset_id) → {Object}

Defined in: adventure/assets/tangible/setPlace.js, line 5

Parameters:

  • aspect String
  • asset_id String
Set an asset's place, aka parent asset and aspect. This is how one thing is put inside another. cap.setPlace( 'attached', 'pen' );

Returns:

Object
setPosition(params) → {Object}

Defined in: adventure/assets/tangible/setPosition.js, line 5

Parameters:

  • params Object
Set this asset's global position.

Returns:

Object
setVerbState()

Defined in: adventure/asset/setVerbState.js, line 5

Inherited from: adventurejs.Asset#setVerbState

setVerbSubscription(object_of, verb, params)

Defined in: adventure/asset/setVerbSubscription.js, line 5

Inherited from: adventurejs.Asset#setVerbSubscription

Todos: phase out earlier version

Parameters:

  • object_of String
  • verb String | Object
    An early version takes a string, with separate params object. A later version takes an object that includes the verb name as an object key and params as value.
  • params Object
    An optional param that works with the earlier version.
setVerbSubscription constructs verb subscriptions at asset.dov / asset.iov. It's intended mostly as a private function, though it is available to authors. An early version takes a string with separate params object. A later version takes an object that includes the verb name as an object key and params as value. // valid (for now) early version this.setIOV('hold',{with_params:{max_connections:2}}); // valid later version with one verb this.setIOV( { hold: { with_params: { max_connections:2 } } } ); // valid later version with multiple verbs this.setIOVs([ { hold: { with_params: { max_connections:3 } } }, { smell: true }, ]);
setVerbSubscriptionsWithAssets(description) → {String}

Defined in: adventure/asset/setVerbSubscriptionsWithAssets.js, line 5

Inherited from: adventurejs.Asset#setVerbSubscriptionsWithAssets

Parameters:

  • description String
Link assets that connect via verb subscriptions. For example, imagine "hit target with sword", where we have target.dov.hit.with_assets:["sword"] This pass will set sword.iov.hit.with_assets:["target"] to ensure that both assets are in sync and either can be queried.

Returns:

String
setVerbWithAsset(verb, asset, ov) → {Boolean}

Defined in: adventure/asset/setVerbWithAsset.js, line 5

Inherited from: adventurejs.Asset#setVerbWithAsset

Parameters:

  • verb String
    The name of a verb.
  • asset Object
  • ov String
    Direct or indirect object of verb.
setVerbWithAsset is used to specify another asset that can be used as an object with this asset. For example, if this asset is a locking chest, chest.setVerbWithAsset('unlock', 'gold key', 'iov') would add the gold key as an indirect object of the chest.

Returns:

Boolean
setVerbWithClass(verb, klass, ov) → {Boolean}

Defined in: adventure/asset/setVerbWithClass.js, line 5

Inherited from: adventurejs.Asset#setVerbWithClass

Parameters:

  • verb String
    The name of a verb.
  • klass String
  • ov String
    Direct or indirect object of verb.
setVerbWithClass is a method to add an indirect object class to asset.dov[verb].with_classes.

Returns:

Boolean
setVesselAt(aspect) → {Array}

Defined in: adventure/assets/tangible/setVesselAt.js, line 5

Parameters:

  • aspect string
    The aspect to add.
Add a substance container at the specified aspect on this asset.

Returns:

Array
setX(value) → {Float}

Defined in: adventure/assets/tangible/setX.js, line 5

Parameters:

  • value Float
Set this asset's global x position.

Returns:

Float
setY(value) → {Float}

Defined in: adventure/assets/tangible/setY.js, line 5

Parameters:

  • value Float
Set this asset's global y position.

Returns:

Float
setZ(value) → {Float}

Defined in: adventure/assets/tangible/setZ.js, line 5

Parameters:

  • value Float
Set this asset's global x position.

Returns:

Float
toggleState(verb) → {Boolean}

Defined in: adventure/asset/toggleState.js, line 5

Inherited from: adventurejs.Asset#toggleState

Parameters:

  • verb String
Apply the specified verb's state change to the asset.

Returns:

Boolean
triedVerb(verb, ov) → {Boolean}

Defined in: adventure/asset/triedVerb.js, line 5

Inherited from: adventurejs.Asset#triedVerb

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
triedVerb is a method to check whether it was attempted to use this asset as a direct object by the specified verb.

$tried is an alias for authors.

Returns:

Boolean
triedVerbCount(verb, ov) → {Boolean}

Defined in: adventure/asset/triedVerbCount.js, line 5

Inherited from: adventurejs.Asset#triedVerbCount

Parameters:

  • verb String
    The name of a verb.
  • ov String
    Direct or indirect object of verb.
triedVerbCount is a method to get a count of times it was tried to use this asset as a direct object by the specified verb.

$triedCount is an alias for authors.

Returns:

Boolean
undestroy()

Defined in: adventure/asset/undestroy.js, line 6

Inherited from: adventurejs.Asset#undestroy

undestroy is called to return a destroyed asset to the game world.
unfasten() → {string}

Defined in: adventure/assets/tangible/unfasten.js, line 6

unfasten tries several methods for unfastening.

Returns:

string
unredirectVerb(oldVerb)

Defined in: adventure/asset/unredirectVerb.js, line 6

Inherited from: adventurejs.Asset#unredirectVerb

Parameters:

  • oldVerb String
unredirectVerb is a method for removing previously set verb redirects.
unsetDOV(verb)

Defined in: adventure/asset/unsetDOV.js, line 6

Inherited from: adventurejs.Asset#unsetDOV

Parameters:

  • verb String
unsetDOV is a passthrough to unsetVerbSubscription.
unsetDOVs(verbs)

Defined in: adventure/asset/unsetDOVs.js, line 6

Inherited from: adventurejs.Asset#unsetDOVs

Parameters:

  • verbs Array
unsetDOVs is a passthrough to unsetVerbSubscription.
unsetIOV(verb)

Defined in: adventure/asset/unsetIOV.js, line 6

Inherited from: adventurejs.Asset#unsetIOV

Parameters:

  • verb String
unsetIOV is a passthrough to unsetVerbSubscription.
unsetIOVs(verbs)

Defined in: adventure/asset/unsetIOVs.js, line 6

Inherited from: adventurejs.Asset#unsetIOVs

Parameters:

  • verbs Array
unsetIOVs is a passthrough to unsetVerbSubscription.
unsetVerbSubscription(object_of, verb)

Defined in: adventure/asset/unsetVerbSubscription.js, line 5

Inherited from: adventurejs.Asset#unsetVerbSubscription

Parameters:

  • object_of String
  • verb String
unsetVerbSubscription disables the use of the specified verb with this asset, if it has been previously set.
validate(game) → {Boolean}

Defined in: adventure/assets/Tangible.js, line 1030

Overrides from: adventurejs.Matter#validate

Parameters:

  • game Object
Inherited from superclass Asset. Tangible adds validation methods that are used for all Tangible assets, including:
  • check for implied dependencies and make them explicit
  • check for proper asset location
  • set parent associations

Returns:

Boolean
validateVerbConnections()

Defined in: adventure/asset/validateVerbConnections.js, line 5

Inherited from: adventurejs.Asset#validateVerbConnections

Validate any connections specified in the game file. Assets can subscribe to verbs with dov[verb] and some verbs can make connections between assets that they act upon. Connections are stored in asset.is.connected_by.verbname.to_iov["array of asset ids"]. Authors can preset connections in their game file, so we validate any preset connections here.

Properties  | 

absorption_quantity :Boolean

Defined in: adventure/assets/Tangible.js, line 336

Default value: 0

Set the amount of liquid an asset has absorbed. No particular logic has been implemented around absorption.
adjectives :Getter/Setter

Defined in: adventure/Asset.js, line 318

Inherited from: adventurejs.Asset#adjectives

A list of adjectives defined for this asset in the game file. Some asset classes may have predefined adjectives. If a class has predefined adjectives, and an author creates an instance of the class with custom adjectives, the custom adjectives will be appended to the predefined ones.
aperture :String

Defined in: adventure/assets/tangibles/Exit.js, line 295

Default value: ""

Set an ID representing an Aperture. Used chiefly for Exit class to set a physical component corresponding to the exit.
append_written_strings_to_description :Boolean

Defined in: adventure/assets/Tangible.js, line 430

Default value: false

Set whether strings written on this asset are appended to its description.
article_name :Getter

Defined in: adventure/Asset.js, line 400

Inherited from: adventurejs.Asset#article_name

Getter function returns asset name preceded either by definite article or indefinite article, depending on what's set for the asset's use_definite_article_in_lists property.
articlename :Getter

Defined in: adventure/Asset.js, line 414

Inherited from: adventurejs.Asset#articlename

Getter function returns asset name or proper name, depending on settings.
Articlename :Getter

Defined in: adventure/Asset.js, line 481

Inherited from: adventurejs.Asset#Articlename

Returns this.articlename with propercase.
articlename_is :Getter

Defined in: adventure/Asset.js, line 441

Inherited from: adventurejs.Asset#articlename_is

Getter function returns asset name or proper name plus is or are, depending on settings.
Articlename_is :Getter

Defined in: adventure/Asset.js, line 490

Inherited from: adventurejs.Asset#Articlename_is

Returns this.articlename_is with propercase.
articlename_isnt :Getter

Defined in: adventure/Asset.js, line 451

Inherited from: adventurejs.Asset#articlename_isnt

Getter function returns asset name or proper name plus isn't or aren't, depending on settings.
Articlename_isnt :Getter

Defined in: adventure/Asset.js, line 499

Inherited from: adventurejs.Asset#Articlename_isnt

Returns this.articlename_isnt with propercase.
articlename_was :Getter

Defined in: adventure/Asset.js, line 461

Inherited from: adventurejs.Asset#articlename_was

Getter function returns asset name or proper name plus was or were, depending on settings.
Articlename_was :Getter

Defined in: adventure/Asset.js, line 508

Inherited from: adventurejs.Asset#Articlename_was

Returns this.articlename_was with propercase.
articlename_wasnt :Getter

Defined in: adventure/Asset.js, line 471

Inherited from: adventurejs.Asset#articlename_wasnt

Getter function returns asset name or proper name plus wasn't or weren't, depending on settings.
Articlename_wasnt :Getter

Defined in: adventure/Asset.js, line 517

Inherited from: adventurejs.Asset#Articlename_wasnt

Returns this.articlename_wasnt with propercase.
aspects :Object

Defined in: adventure/assets/Tangible.js, line 70

Default value: {}

Containing object for Aspects, aka "in", "out", "under", "behind" etc.
buoyancy :float

Defined in: adventure/assets/Tangible.js, line 328

Default value: 0

Todos: Implement.

Set an asset's percent of buoyancy. No logic has been implemented around this.
can :Object

Defined in: adventure/Asset.js, line 48

Inherited from: adventurejs.Asset#can

can is a generalized container for asset boolean properties.
can.be_swung_at :Boolean

Defined in: adventure/assets/Tangible.js, line 405

Default value: true

Nested property of Can

Set whether this asset can be swung at another asset, as in swinging a bat at a ball.
collection :Getter/Setter

Defined in: adventure/Asset.js, line 182

Inherited from: adventurejs.Asset#collection

Collection is a special property that lets one object stand in for a group of objects. For example, object desk has three drawers: top_drawer, middle_drawer, bottom_drawer. desk_drawers is a scenery object attached to desk which intercepts player input like "examine drawers", so that author can return a response like "You see three drawers."
contains :Object

Defined in: adventure/assets/Tangible.js, line 983

Contains is a shortcut for creating a substance container and filling it with an infinite amount of a specified substance. It is the equivalent of this code: 
this.aspects.in = new adventurejs.Aspect( "in", this.game_name, this.id );
this.aspects.in.vessel = new adventurejs.Vessel( "in", game_name, this.id )
  .set({
    "volume": Infinity,
    "maxvolume": Infinity,
    "substance_id": substance_id,
  });


This is to make it easier and more intuitive for authors to set things like sand in a desert room or water in a swamp room, so that if player inputs "fill bowl with water", it can be assumed that the room is the source of the substance. When multiple substance containers are available, usually disambiguation occurs, but in the case of a room containing a substance, the room is assumed to be the source.
control_target_id :String

Defined in: adventure/assets/tangibles/things/GraduatedController.js, line 77

Default value: ""

Used by GraduatedController class to set target for the controller.
default_aspect :String

Defined in: adventure/assets/Tangible.js, line 102

Default value: "on"

It's possible for player to become nested to an asset without a specified preposition. In such cases, this default aspect is used.
definite_article :String

Defined in: adventure/Asset.js, line 213

Inherited from: adventurejs.Asset#definite_article

Default value: 'the'

The asset's preferred definite article. Can be overridden in game file.
definite_name :Getter

Defined in: adventure/Asset.js, line 359

Inherited from: adventurejs.Asset#definite_name

Getter function returns asset name preceded by its definite article, example: 'the asset'.
description :*

Defined in: adventure/Asset.js, line 546

Inherited from: adventurejs.Asset#description

An alias to descriptions.look.
descriptions :Object

Defined in: adventure/Asset.js, line 158

Inherited from: adventurejs.Asset#descriptions

A list of descriptions for a variety of contexts. Only description is required, all others are optional. Most of these apply only to Tangible Asset.
  • descriptions.description -
  • descriptions.brief - used for room descriptions if player has typed "brief"
  • descriptions.verbose - used for room descriptions if player has typed "verbose"
  • descriptions.listen - used if player types "listen" or "listen to thing"
  • descriptions.in - used if player types "look in thing"
  • descriptions.through - used if player types "look through thing"
  • descriptions.smell - used if player types "smell thing"
  • descriptions.taste - used if player types "taste thing"
  • descriptions.touch - used if player types "touch thing"
  • descriptions.careful - used if player types "carefully examine thing"
did :Object

Defined in: adventure/Asset.js, line 328

Inherited from: adventurejs.Asset#did

did is used to track which verbs have acted upon this object.
dimensions :Object

Defined in: adventure/assets/Tangible.js, line 548

Default value: {}

dimensions :Object

Defined in: adventure/assets/Tangible.js, line 569

Default value: {}

direction :String

Defined in: adventure/assets/tangibles/things/Aperture.js, line 78

Default value: ""

Todos: Use lookup table for this? In a GUI this would be a pull-down menu.

Set a direction for this asset. Chiefly used with Aperture class to set directions apertures. Takes a direction string, ie "north", "northeast", "down".
dont_use_articles :Boolean

Defined in: adventure/Asset.js, line 240

Inherited from: adventurejs.Asset#dont_use_articles

Default value: false

An option to prevent definite/indefinite articles from appearing before an asset name. Used chiefly for characters, to prevent phrases such as "the Mrs. Beasley". Can be overridden in game file.
dov :Boolean

Defined in: adventure/Asset.js, line 62

Inherited from: adventurejs.Asset#dov

Default value: {}

dov is a container for direct object verb subscriptions.
emits :Boolean

Defined in: adventure/assets/Tangible.js, line 496

Default value: false

Todos: Write logic for this.

Set properties for a variety of things a tangible asset can emit.
exclude_from_lookup :Boolean

Defined in: adventure/Asset.js, line 132

Inherited from: adventurejs.Asset#exclude_from_lookup

Default value: false

Almost all assets will be listed in the world_lookup table that is used to find assets from player input , with some exceptions, such as SceneryZones.
exit :String

Defined in: adventure/assets/tangibles/things/Aperture.js, line 87

Default value: ""

Set an ID representing an Exit. Used chiefly for Aperture class to set an exit corresponding to an aperture.
game :Getter

Defined in: adventure/Atom.js, line 103

Inherited from: adventurejs.Atom#game

Returns the top level game object. Use this.game.
image :String

Defined in: adventure/Asset.js, line 342

Inherited from: adventurejs.Asset#image

image is used to store the id of an image in game.image_lookup that is associated with this asset.
indefinite_article :String

Defined in: adventure/Asset.js, line 221

Inherited from: adventurejs.Asset#indefinite_article

Default value: 'a'

The asset's preferred indefinite article. Can be overridden in game file.
indefinite_name :Getter

Defined in: adventure/Asset.js, line 386

Inherited from: adventurejs.Asset#indefinite_name

Getter function returns asset name preceded by its indefinite article, example: 'an asset'.
iov :Boolean

Defined in: adventure/Asset.js, line 80

Inherited from: adventurejs.Asset#iov

Default value: {}

iov is a container for direct object verb subscriptions.
is :Object

Defined in: adventure/Asset.js, line 37

Inherited from: adventurejs.Asset#is

is is a generalized container for asset states. Many states are / can be stored here. A chief benefit of this is being able to get specific states by testing asset.is.state. Note that there is also an asset.$is() method which is related to this, but is a distinct function.
is.abstract :Boolean

Defined in: adventure/Asset_Is.js, line 88

Inherited from: adventurejs.Asset#is.abstract

Default value: false

Nested property of Is

Abstractions are universally available and bypass reachability tests.
is.buttoned :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 142

Default value: false

Nested property of Is

Set whether this asset is buttoned.
is.carried :Getter

Defined in: adventure/assets/Tangible_Is.js, line 362

Nested property of Is

Get whether this asset is carried by player.
is.closed :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 164

Default value: false

Nested property of Is

Set whether this asset is closed.
is.cold_source :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 225

Default value: false

Nested property of Is

Set whether asset is a cold source.
is.collection :Boolean

Defined in: adventure/Asset_Is.js, line 48

Inherited from: adventurejs.Asset#is.collection

Default value: true

Nested property of Is

Set whether object is a collection of other object IDs.
is.connected_by :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 239

Default value: {}

Nested property of Is

Set whether asset is connected by verbs to other assets.
is.deep_nest :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 195

Default value: false

Nested property of Is

Set whether player can nest inside this asset when this asset is in an aspect of another asset (as opposed to being a direct child of a room). For example, a carousel horse might be on a carousel platform.
is.destroyed :Boolean

Defined in: adventure/Asset_Is.js, line 33

Inherited from: adventurejs.Asset#is.destroyed

Default value: false

Nested property of Is

Set to true when an object is removed from the game by destruction.
is.distant :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 104

Default value: false

Nested property of Is

Set whether this asset is distant. Originally meant to help define scenery assets, but mostly superseded by other scenery handling and no logic has been written for it.
is.extant :Boolean

Defined in: adventure/Asset_Is.js, line 41

Inherited from: adventurejs.Asset#is.extant

Default value: true

Nested property of Is

Set to true when an object is in the game.
is.false_nest :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 204

Default value: false

Nested property of Is

is.fixed :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 149

Default value: false

Nested property of Is

Set whether this asset is fixed in its place, such as drawers in a desk. (This may be redundant to can_be_taken.)
is.global :Boolean

Defined in: adventure/Asset_Is.js, line 79

Inherited from: adventurejs.Asset#is.global

Default value: false

Nested property of Is

Almost all tangible assets have a singular location. Global assets are available in all locations in order to catch player input.
is.heat_source :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 218

Default value: false

Nested property of Is

Set whether asset is a heat source.
is.hidden :Getter|Boolean

Defined in: adventure/assets/Tangible_Is.js, line 49

Default value: false

Nested property of Is

Todos: add logic to test conditions?

Set whether this asset is hidden.
is.hollow :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 74

Default value: false

Nested property of Is

Set whether this asset is hollow. Used to determine whether player can look in asset.
is.inhands :Getter

Defined in: adventure/assets/Tangible_Is.js, line 371

Nested property of Is

Get whether this asset is in player's hands.
is.initialized :Boolean

Defined in: adventure/Asset_Is.js, line 62

Inherited from: adventurejs.Asset#is.initialized

Default value: false

Nested property of Is

Used at runtime to keep track of asset's initialization state.
is.known :Boolean

Defined in: adventure/Asset_Is.js, line 26

Inherited from: adventurejs.Asset#is.known

Default value: false

Nested property of Is

Used to track whether player knows about an asset.
is.light_source :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 211

Default value: false

Nested property of Is

Set whether asset is a light source.
is.listed_in_parent :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 97

Default value: true

Nested property of Is

Set whether this asset is listed in its context's description.
is.listed_in_room :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 81

Default value: true

Nested property of Is

Set whether this asset is listed in the current room description.
is.locked :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 157

Default value: false

Nested property of Is

Set whether this asset is locked.
is.nameless :Boolean

Defined in: adventure/Asset_Is.js, line 69

Inherited from: adventurejs.Asset#is.nameless

Default value: false

Nested property of Is

Almost all assets are given a name which is then used to create their id, with some exceptions. For example, exit ids are generated by taking the name of the exit's room + the exit's direction.
is.on :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 232

Default value: false

Nested property of Is

Set whether asset is on.
is.on :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 246

Default value: false

Nested property of Is

Set whether asset is plural, such as shoes.
is.plugged :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 35

Inherited from: adventurejs.Asset#is.plugged

Default value: false

Nested property of Is

Set whether this asset is plugged, like a drain.
is.pluggedIn :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 42

Inherited from: adventurejs.Asset#is.pluggedIn

Default value: false

Nested property of Is

Set whether this asset is plugged in, like an appliance.
is.plural :Boolean

Defined in: adventure/Asset_Is.js, line 105

Inherited from: adventurejs.Asset#is.plural

Default value: false

Nested property of Is

Define whether an asset is plural, as opposed to singular, in the sense of eyeglasses vs a drinking glass. Used to help select pronouns.
is.present :Getter

Defined in: adventure/assets/Tangible_Is.js, line 351

Nested property of Is

Get whether this asset is present in the current room.
is.reachable :Getter

Defined in: adventure/assets/Tangible_Is.js, line 380

Nested property of Is

Get whether this asset is reachable by player.
is.reservoir :Getter

Defined in: adventure/assets/Tangible_Is.js, line 342

Nested property of Is

Get whether this asset has a vessel that is a reservoir.
is.screwed :Boolean|Int

Defined in: adventure/assets/Tangible_Is.js, line 128

Default value: false

Nested property of Is

Set whether this asset is screwed.
is.sealed :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 171

Default value: false

Nested property of Is

Set whether this asset is sealed.
is.singleton :Boolean

Defined in: adventure/Asset_Is.js, line 95

Inherited from: adventurejs.Asset#is.singleton

Default value: false

Nested property of Is

Todos: Have only applied this to several special global assets, and have not implemented any code around it. Is it still useful?

Meant for use to distinguish some assets as being singular in the game world.
is.supported :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 64

Default value: false

Nested property of Is

Set whether this asset is supported. Used in conjuction with can.swing_on_if_holding_and_supported to determine whether player can swing on the asset in its current state. Meant for assets like two-ended ropes which must be tied to a supporting structure.
is.takeable :Getter

Defined in: adventure/assets/Tangible_Is.js, line 398

Nested property of Is

Get whether this asset is takeable by player.
is.typing_target :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 57

Default value: false

Nested property of Is

Set whether this asset is a typing target, as in a screen for a keyboard.
is.unleavable :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 178

Default value: false

Nested property of Is

Set whether player can leave this asset. Useful for keeping player from leaving, such as if they're on a carousel horse while the carousel is in motion.
is.unlisted_but_list_children :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 88

Default value: false

Nested property of Is

Set whether this asset's children are listed in the current room description. Meant for situations where a context asset is part of the room description, to avoid listing the context asset twice.
is.validated :Boolean

Defined in: adventure/Asset_Is.js, line 55

Inherited from: adventurejs.Asset#is.validated

Default value: false

Nested property of Is

Used at runtime to keep track of asset's validation state.
is.viewport :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 187

Default value: false

Nested property of Is

Set whether this asset can be looked through, like a window or a telescope.
is.visible :Getter

Defined in: adventure/assets/Tangible_Is.js, line 389

Nested property of Is

Get whether this asset is visible by player.
is.watertight :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 112

Default value: false

Nested property of Is

Todos: Write logic for this. Is this the same as airtight?

Set whether this asset is watertight. No logic has been written for this.
is.worn :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 121

Default value: false

Nested property of Is

Set whether this asset is being worn by player or other characters.
is.zipped :Boolean

Defined in: adventure/assets/Tangible_Is.js, line 135

Default value: false

Nested property of Is

Set whether this asset is zipped.
list_group :int

Defined in: adventure/assets/Tangible.js, line 656

Default value: 0

Todos: Implement this or remove it.

Meant for handling screen output, by breaking listed items into subgroups to be divided into paragraphs, but not implemented.
location_required :Boolean

Defined in: adventure/assets/Tangible.js, line 522

Default value: false

Set whether this asset must have a location. Chiefly for use with Aperture class. Apertures must have a location because they're tied to Exits. Other assets can exist without a location, though unlocated tangible assets won't be available to player.
location_unneccessary :Boolean

Defined in: adventure/assets/Tangible.js, line 531

Default value: false

Explicitly set whether this asset can exist without a location. Chiefly for use with Room class. Rooms will not have a location.
min_light_required_to_see :float

Defined in: adventure/assets/Tangible.js, line 539

Default value: 0.5

Todos: Write logic for this in selectVisible.js

Set the minimum light required to see this asset. Meant for situations with variable lighting where some objects might be hidden in shadow.
must :Object

Defined in: adventure/Asset.js, line 55

Inherited from: adventurejs.Asset#must

must is a generalized container for asset boolean properties.
must.hold_to_read :Boolean

Defined in: adventure/assets/Tangible_Must.js, line 54

Default value: false

Nested property of Must

Set whether this asset must be held to be read, as with a small book.
must.hold_to_see_through :Boolean

Defined in: adventure/assets/Tangible_Must.js, line 33

Default value: false

Nested property of Must

Set whether this asset must be held to look through, as with a telescope.
must.hold_to_see_with :Boolean

Defined in: adventure/assets/Tangible_Must.js, line 26

Default value: false

Nested property of Must

Set whether this asset must be held to look with, as with a binocular.
must.let_go_after_swing :Boolean

Defined in: adventure/assets/Tangible_Must.js, line 61

Default value: false

Nested property of Must

Set whether player will let go of this asset after swinging on it. Meant for situations such as when player swings from a vine and lets go upon landing.
must.wear_to_see_through :Boolean

Defined in: adventure/assets/Tangible_Must.js, line 47

Default value: false

Nested property of Must

Set whether this asset must be worn to look through, as with glasses.
must.wear_to_see_with :Boolean

Defined in: adventure/assets/Tangible_Must.js, line 40

Default value: false

Nested property of Must

Set whether this asset must be worn to look with, as with glasses.
Name :String

Defined in: adventure/Atom.js, line 90

Inherited from: adventurejs.Atom#Name

Name returns the name of the class instance with the first character uppercased.
name_is_proper :Boolean

Defined in: adventure/Asset.js, line 197

Inherited from: adventurejs.Asset#name_is_proper

Default value: false

Used to determine whether to display a name or proper name.
noun :String

Defined in: adventure/Asset.js, line 250

Inherited from: adventurejs.Asset#noun

noun is a string representing the type of asset this is, for example 'mug' or 'rock'. Players can input this word to refer to any asset of its type.
on_tie_to_drag_behind_rope :Boolean

Defined in: adventure/assets/Tangible.js, line 455

Default value: false

If player uses a rope in inventory to tie to an object that is not in inventory, this sets whether the object gets dragged behind when player leaves the current room.
on_tie_to_this_take_this :Boolean

Defined in: adventure/assets/Tangible.js, line 446

Default value: false

Set whether this is taken into player inventory when another asset is tied to it. For example, on tying a string that is in inventory to a tin can that is not in inventory, it's assumed that player would then pick up the can.
parts :Array

Defined in: adventure/assets/Tangible.js, line 752

Default value: []

Some Tangible subclasses come pre-coded to handle certain "parts", classes which can automatically be registered with each other to form complex associations. For example, a Sink can have matching Faucet, FaucetHandles, Drain and Plug. Not all classes have parts. See each class's documentation header for "Can have parts:" and "Can be part of:". The registerParts() method is called during initialization. Set up parts like so: 
MyGame.createAsset({
  class: "Sink",
  name: "sink",
  place: { in: "Bathroom" },
  descriptions:{
    look: function()
    {
      return "A pedestal sink with porcelain handles and
      a stainless steel faucet. Its drain appears to be
      $( sink drain is| open or| closed ). ";
    }
  },
  parts: [
    // each of these is a name of another Asset
    "hot water handle",
    "cold water handle",
    "faucet",
    "drain",
    "plug"
  ],
});
place :Object

Defined in: adventure/assets/Tangible.js, line 880

Get / set place. The private var _place is an object with two properties: aspect and asset. For example: { aspect:"in", asset:"room" } However, the public var place appears in the form { in: "room" }. This is to make it easier and more intuitive for authors to set asset places.
player_can_exit :Boolean

Defined in: adventure/assets/Tangible.js, line 289

Default value: false

Set whether player can go off (aka get off) this asset. Used for Rooms.
player_knows_its_hidden :Boolean

Defined in: adventure/assets/Tangible.js, line 320

Default value: false

Set whether player knows a thing is hidden. Useful if player is the one doing the hiding, or if player has found an object but not picked it up.
plural :String

Defined in: adventure/Asset.js, line 289

Inherited from: adventurejs.Asset#plural

plural is a string representing multiple assets of this type, for example 'swords'. Players can input this word to refer to groups of assets.
position :Object

Defined in: adventure/assets/Tangible.js, line 623

Default value: {x:0,y:0,z:0}

XYZ coordinates. Defaults to 0,0,0. It's safe to ignore these if you don't want to use them. They can be used for things like:
  • managing reachability of objects that are on top of other things
  • managing reachability of objects in the room while player is climbing or standing atop a thing
  • dividing a room up into reachable/unreachable spaces
  • managing player depth in an underwater location
  • managing player position while flying/floating/levitating
Here's an example of how to set an object's position. 
MyGame.createAsset({
  class: "Stalactite",
  name: "stalactite",
  place: { on: "Colossal Cave" },
  descriptions: {look: "It clings tight to the ceiling. ",},
  height: -2,
  position: { x:0, y:5, z:0 },
});
Also see related height.
possessive :String

Defined in: adventure/Asset.js, line 267

Inherited from: adventurejs.Asset#possessive

possessive is a string representing the generic possessive pronoun.
posture_position :Boolean

Defined in: adventure/assets/Tangible.js, line 303

Default value: "default"

A string that describes the position the Asset is in, ex "resting" for most non-Character Assets, or "lying", "sitting", "standing" etc for Characters. this.game.dictionary.getStringLookup( type, value ). Can be referenced in custom code through MyGame.dictionary.getStringLookup( type, value ).
print_bold :Boolean

Defined in: adventure/Asset.js, line 102

Inherited from: adventurejs.Asset#print_bold

Default value: false

Set to true to have an object's name be printed bold.
print_class :String

Defined in: adventure/Asset.js, line 124

Inherited from: adventurejs.Asset#print_class

Default value: ""

Set an arbitrary string to apply CSS classes to an object's name whenever it is printed.
print_italic :Boolean

Defined in: adventure/Asset.js, line 109

Inherited from: adventurejs.Asset#print_italic

Default value: false

Set to true to have an object's name be printed italic.
print_open_or_closed :Boolean

Defined in: adventure/assets/Tangible.js, line 868

Default value: false

Get a string representing open / closed state of this asset.
print_style :String

Defined in: adventure/Asset.js, line 116

Inherited from: adventurejs.Asset#print_style

Default value: ""

Set an arbitrary string to apply CSS styles to an object's name whenever it is printed.
pronoun :String

Defined in: adventure/Asset.js, line 259

Inherited from: adventurejs.Asset#pronoun

pronoun is a string representing the generic pronoun.
propername :String

Defined in: adventure/Asset.js, line 204

Inherited from: adventurejs.Asset#propername

The asset's proper name, as provided in the game file. Assets can have both a name and a proper name. Used chiefly for characters, so that, for example, an asset can be both 'cat' and 'Mister Whiskers'.
proxy :Getter

Defined in: adventure/Asset.js, line 536

Inherited from: adventurejs.Asset#proxy

Return a proxy if this asset has one. Most will not. Exits have Apertures as proxies.
quirks :Object

Defined in: adventure/Asset.js, line 91

Inherited from: adventurejs.Asset#quirks

quirks is a container for setting how to handle ambiguous verbs based on context. For example, if player inputs "stand" while sitting in a chair with quirks.stand_means_get_off set to true, player will get off the chair, as opposed to trying to stand in place on the chair.
quirks.climb_means_go_on :Boolean

Defined in: adventure/assets/Tangible.js, line 110

Default value: false

Nested property of Quirks

Set whether 'climb' means 'go on', which might apply to assets such as stairs and ladders.
quirks.climb_means_stand_on :Boolean

Defined in: adventure/assets/Tangible.js, line 119

Default value: false

Nested property of Quirks

Set whether 'climb' means 'stand on', which might apply to furniture and things like boulders which players can stand on.
quirks.flick_means_toggle :Boolean

Defined in: adventure/assets/Tangible.js, line 274

Default value: false

Nested property of Quirks

Set whether verb 'flick' means 'toggle', as with a switch.
quirks.flip_means_toggle :Boolean

Defined in: adventure/assets/Tangible.js, line 242

Default value: false

Nested property of Quirks

Set whether verb 'flip' means 'toggle', as with a switch.
quirks.get_off_means_go_down :Boolean

Defined in: adventure/assets/Tangible.js, line 171

Default value: false

Nested property of Quirks

Set whether 'get off' means to scale down, which might apply to things such as trees. Scaling is subject to scale_incremement, which, along with object.dimensions.height, sets how many turns it takes a player to climb up or down an object.
quirks.get_on_means_go_up :Boolean

Defined in: adventure/assets/Tangible.js, line 162

Default value: false

Nested property of Quirks

Set whether 'get on' means to scale up, which might apply to things such as trees.
quirks.get_up_means_get_off :Boolean

Defined in: adventure/assets/Tangible.js, line 153

Default value: false

Nested property of Quirks

Set whether 'get up' means 'go off' (aka 'get off'), which might apply to furniture such as chairs or beds.
quirks.in_means_on :Boolean

Defined in: adventure/assets/Tangible.js, line 182

Default value: false

Nested property of Quirks

If set to true, "in" and "on" become interchangeable for some verbs. Intended chiefly for things like chairs where "sit in chair" and "sit on chair" can be interpreted to mean the same thing.
quirks.jump_means_jump_off :Boolean

Defined in: adventure/assets/Tangible.js, line 210

Default value: false

Nested property of Quirks

Set whether 'jump' means 'jump off' as in jumping off a tree.
quirks.jump_means_jump_on :Boolean

Defined in: adventure/assets/Tangible.js, line 202

Default value: true

Nested property of Quirks

Set whether 'jump' means 'jump on' as in jumping up and down on a bed.
quirks.let_go_of_means_go_down :Boolean

Defined in: adventure/assets/Tangible.js, line 487

Default value: false

Nested property of Quirks

Set whether 'let go of' means 'go down', as in the case of player being suspended by a rope above a pit, where letting go means moving to a new Room.
quirks.let_go_of_means_go_off :Boolean

Defined in: adventure/assets/Tangible.js, line 478

Default value: false

Nested property of Quirks

Set whether 'let go of' means 'get off', as in the case of assets that the player is suspended from, such as hanging from a rope.
quirks.look_with_means_look_through :Boolean

Defined in: adventure/assets/Tangible.js, line 393

Default value: false

Nested property of Quirks

Set whether "look with" is equivalent to "look through". For example, in the case of a telescope, "look with telescope" is equivalent to "look through telescope". In the case of a window, you can look through it, but not look with it. In the case of a candle, you can look with it, but not look through it.
quirks.pick_means_unlock :Boolean

Defined in: adventure/assets/Tangible.js, line 344

Default value: false

Nested property of Quirks

Set whether 'pick' means 'unlock'. This is provided to give authors the option to choose whether pick and unlock are treated as distinct verbs.
quirks.point_means_aim :Boolean

Defined in: adventure/assets/Tangible.js, line 666

Default value: false

Nested property of Quirks

Set whether verb point means aim for this asset. If so, point verb will redirect to aim.
quirks.press_means_toggle :Boolean

Defined in: adventure/assets/Tangible.js, line 250

Default value: false

Nested property of Quirks

Set whether verb 'press' means 'toggle', as with a switch.
quirks.pull_means_open :Boolean

Defined in: adventure/assets/Tangible.js, line 128

Default value: false

Nested property of Quirks

Set whether 'pull' means 'open', which might apply to drawers.
quirks.pull_means_open :Boolean

Defined in: adventure/assets/Tangible.js, line 136

Default value: false

Nested property of Quirks

Set whether 'pull' means 'open', which might apply to drawers.
quirks.pull_means_toggle :Boolean

Defined in: adventure/assets/Tangible.js, line 266

Default value: false

Nested property of Quirks

Set whether verb 'pull' means 'toggle', as with a switch.
quirks.push_means_toggle :Boolean

Defined in: adventure/assets/Tangible.js, line 258

Default value: false

Nested property of Quirks

Set whether verb 'push' means 'toggle', as with a switch.
quirks.put_means_pour :Boolean

Defined in: adventure/assets/Tangible.js, line 192

Default value: false

Nested property of Quirks

If set to true, "put" means "pour" for some verbs. Intended chiefly for things like "put syrup on pancakes" which is a common phrasing where clearly the speaker means to pour.
quirks.stand_means_get_off :Boolean

Defined in: adventure/assets/Tangible.js, line 144

Default value: false

Nested property of Quirks

Set whether 'stand' means 'go off' (aka 'get off'), which might apply to furniture such as chairs.
quirks.step_on_means_stamp_on :Boolean

Defined in: adventure/assets/Tangible.js, line 225

Default value: false

Nested property of Quirks

Set whether player can step on this asset.
quirks.step_on_means_stand_on :Boolean

Defined in: adventure/assets/Tangible.js, line 233

Default value: false

Nested property of Quirks

Set whether verb 'step on' means 'stand on', as with a skateboard or some types of furniture.
quirks.take_means_hold :Boolean

Defined in: adventure/assets/Tangible.js, line 470

Default value: false

Nested property of Quirks

Set whether 'take' means 'hold', as in the case of hanging ropes.
quirks.write_on_means_write_in :Boolean

Defined in: adventure/assets/Tangible.js, line 414

Default value: false

Nested property of Quirks

Set whether this asset can be written in like a book.
redirected_verbs :Boolean

Defined in: adventure/Asset.js, line 350

Default value: {}

redirected_verbs is an object used for storing verb redirections via redirectVerb().
registerableClasses :Object

Defined in: adventure/assets/Tangible.js, line 803

Default value: {}

registered_parts :Object

Defined in: adventure/assets/Tangible.js, line 795

Default value: {}

short_name :Getter

Defined in: adventure/Asset.js, line 373

Inherited from: adventurejs.Asset#short_name

Getter/setter returns a short name for the asset, if one has been given, or the full name if not.
show_things_this_is_tied_to_in_description :Boolean

Defined in: adventure/assets/Tangible.js, line 463

Default value: true

Set whether this asset's description includes things that it is tied to.
singlePluralPairs :Array

Defined in: adventure/Asset.js, line 277

Inherited from: adventurejs.Asset#singlePluralPairs

singlePluralPairs is a collection of strings representing the singular and plural forms of this asset, for example ['mug', 'mugs']. Players can use the singular to refer to a single asset or the plural to refer to a group of assets. These are stored in pairs so we can check for correspondence between the forms.
split_name_for_world_lookup :Boolean

Defined in: adventure/Asset.js, line 141

Inherited from: adventurejs.Asset#split_name_for_world_lookup

Default value: true

Object names are split into individual words for the world_lookup table. For example, given an object named "crystal sword", adventurejs creates lookup table entries for "crystal" and "sword". This lets the game recognize either word as player input, such as "get crystal" or "swing sword".

But, an author might want to name a thing, eg, "hole in the ground", in which case we wind up with lookup table entries for "hole" and "in" and "the" and "ground", which is likely to lead to bad input parsing. To avoid name splitting, set split_name_for_world_lookup to false. The object's full name will still be added to the lookup.
things_player_can_climb_to_from_this :Array

Defined in: adventure/assets/Tangible.js, line 282

Default value: []

Set list of other assets that player can climb to from this.
things_player_can_jump_to_from_this :Array

Defined in: adventure/assets/Tangible.js, line 218

Default value: []

List of other assets player can jump to while nested within this asset.
things_player_can_reach_from_this :Array

Defined in: adventure/assets/Tangible.js, line 676

Default value: []

When player is nested within an aspect of an asset, other assets may not be reachable. things_player_can_reach_from_this helps manage reachability. For example, if player is on a ladder, things on the ground might not be reachable. But, a player seated on a chair at a desk should be able to reach the desk and anything on it. Use this property to explicitly make some things reachable from other things.

things_player_can_reach_from_this is a broad catchall that covers all nesting options. What this means is that players can reach assets in this list no matter how they are nested within this asset. Going back to the example of the chair and desk, if the chair has this property set thusly... 
this.things_player_can_reach_from_this = [ 'desk' ];
...it means that the player, seated in the chair, can reach any part of the desk: not just stuff that's on it, but also stuff under it or behind it. That might be fine for your purposes. Or, you might want more granular control. Let's say there's an electrical outlet under the desk, and you want that players shouldn't be able to reach it without actually crawling under the desk. If you need that kind of precision, you can manage reachability for each aspect of an asset. For more information about that, see Aspect.things_player_can_reach_from_this_aspect and Aspect.things_player_can_reach_from_positions_of_this_aspect.
things_player_can_reach_from_top_of_this :Array

Defined in: adventure/assets/Tangible.js, line 705

Default value: []

When player is nested within an asset, other assets may not be reachable. For example, if player is on a ladder, things on the ground won't be reachable. Use this property to explicitly list things that player can reach while nested at the top of asset. For example, perhaps there is a window that player should only be able to reach from the top of a ladder. things_player_can_reach_from_top_of_this allows that to be set. For example: 
this.things_player_can_reach_from_top_of_this = [ 'window' ];
things_player_can_reach_from_this is a convenience method for a common situation. If you need more control over reachability from specific positions within an aspect, like left/right/front/back, you can manage that at the aspect level. For more information about that, see Aspect.things_player_can_reach_from_this_aspect and Aspect.things_player_can_reach_from_positions_of_this_aspect.
things_player_can_reach_from_top_of_this :Array

Defined in: adventure/assets/Tangible.js, line 728

Default value: []

When player is nested within an asset, other assets may not be reachable. For example, if player is on a ladder, things on the ground won't be reachable. Use this property to explicitly list things that player can reach while nested at the bottom of asset. For example, perhaps there is an alcove at the bottom of a pit, with a ladder leading down, where player should only be able to reach the alcove from the bottom of the ladder. things_player_can_reach_from_bottom_of_this allows that to be set. For example: 
this.things_player_can_reach_from_bottom_of_this = [ 'alcove' ];
things_player_can_reach_from_bottom_of_this is a convenience method for a common situation. If you need more control over reachability from specific positions within an aspect, like left/right/front/back, you can manage that at the aspect level. For more information about that, see Aspect.things_player_can_reach_from_this_aspect and Aspect.things_player_can_reach_from_positions_of_this_aspect.
things_player_can_swing_to_across_this :Getter/Setter

Defined in: adventure/assets/Tangible.js, line 849

Default value: false

things_player_can_swing_to_from_this :Array

Defined in: adventure/assets/Tangible.js, line 296

Default value: []

List of other assets that player can swing to while nested within this asset.
to_be :Getter

Defined in: adventure/Asset.js, line 580

Inherited from: adventurejs.Asset#to_be

Getter function returns singular or plural form of "to be" depending on asset.is.plural property.
tried :Object

Defined in: adventure/Asset.js, line 335

Inherited from: adventurejs.Asset#tried

tried is used to track which verbs have been tried upon this object.
typing_target_id :String

Defined in: adventure/assets/Tangible.js, line 437

Default value: ""

Set the ID of a target asset for this asset to type on, as in a screen for a keyboard.
use_definite_article_in_lists :Boolean

Defined in: adventure/Asset.js, line 229

Inherited from: adventurejs.Asset#use_definite_article_in_lists

Default value: false

A preference for how an asset's name appears when it is printed in certain contexts. Chiefly used for room names. For example, you might name a room 'Sitting Room', but want it to appear as 'the Sitting Room' in some contexts for narrative clarity. Can be overridden in game file.
use_once_message :Boolean

Defined in: adventure/assets/Tangible.js, line 353

Default value: false

Set a message to print for asset's single use.
written_strings :Array

Defined in: adventure/assets/Tangible.js, line 423

Default value: []

List of strings that have been written on this asset.