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

Class:Collection

constructor description methods properties

Extends: adventurejs.Scenery

Defined in: adventure/assets/tangibles/scenery/Collection.js, line 5

More info: Collections

Constructor:

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

Description

Collection provides a way to perform some verbs on a specific group of related objects. In the example below, a Desk has three Drawers. Each drawer can be open or closed. A player might input something like examine drawers. Normally, that would lead to a disambiguation prompt such as Which did {we} mean? 1. The top drawer, 2. the middle drawer, or 3. the bottom drawer? Here, we've made a collection for the three drawers lets players refer to the three drawers as one object. 

MyGame.createAsset({
  class: "Desk",
  name: "desk",
  place: { in: "Office" },
  descriptions: {
    look: function()
    {
      return "It's a heavy wooden desk. It has three drawers
      stacked vertically. The top drawer is { top drawer [is] open [or] closed },
      the middle drawer is { middle drawer [is] open [or] closed },
      and the bottom drawer is { bottom drawer [is] open [or] closed }."
    },
  },
  adjectives: "wooden, heavy",
});
MyGame.createAsset({
  class: "Drawer",
  name: "top drawer",
  synonyms: "top desk drawer, top drawer lock, lock",
  descriptions: { look: "The top drawer is { top drawer [is] open [or] closed }. ", },
  adjectives: "desk",
  place: { attached: "desk" },
  dov: {
    unlock: { with_assets: ['tiny brass key'], },
  },
  is: { locked: true, listed: false },
});
MyGame.createAsset({
  class: "Drawer",
  name: "middle drawer",
  synonyms: "middle desk drawer",
  descriptions: { look: "The middle drawer is { middle drawer [is] open [or] closed }. ", },
  adjectives: "desk",
  place: { attached: "desk" },
  is: { listed: false },
});
MyGame.createAsset({
  class: "Drawer",
  name: "bottom drawer",
  synonyms: "bottom desk drawer",
  descriptions: { look: "The bottom drawer is { bottom drawer [is] open [or] closed }. ", },
  adjectives: "desk",
  place: { attached: "desk" },
  is: { listed: false },
});
MyGame.createAsset({
  class: "Collection",
  name: "desk drawers",
  place: { attached: "desk" },
  collection: "top drawer, middle drawer, bottom drawer",
  synonyms: [ "drawers", "three drawers" ],
  is: { listed: false },
  descriptions: {
    look: function()
    {
      var openCount = [];
      var closedCount = [];
      var complicatedMsg = "The desk has three drawers stacked vertically. ";   *
      MyGame.$("top drawer").is.closed ?
        closedCount.push( "top drawer" ) : openCount.push( "top drawer" );
      MyGame.$("middle drawer").is.closed ?
        closedCount.push( "middle drawer" ) : openCount.push( "middle drawer" );
      MyGame.$("bottom drawer").is.closed ?
        closedCount.push( "bottom drawer" ) : openCount.push( "bottom drawer" );

      if( 0 === openCount.length )
      {
        complicatedMsg += "All three are closed.";
      }
      else if( 0 === closedCount.length )
      {
        complicatedMsg += "All three are open.";
      }
      else if ( 2 == openCount.length )
      {
        complicatedMsg += "The "
        + openCount[ 0 ]
        + " and the "
        + openCount[ 1 ]
        + " are open. The "
        + closedCount[ 0 ]
        + " is closed. ";
      }
      else if ( 2 == closedCount.length )
      {
        complicatedMsg += "The "
        + closedCount[ 0 ]
        + " and the "
        + closedCount[ 1 ]
        + " are closed. The "
        + openCount[ 0 ]
        + " is open. ";
      }
      return complicatedMsg
    },
  },
});

In the "desk drawers" Collection, take special note of these lines:

name: "desk drawers",
  synonyms: [ "drawers", "three drawers" ],
  collection: "top drawer, middle drawer, bottom drawer",
  place: { attached: "desk" },
  is: { listed: false },
  • collection is set to a list of the items that the Collection represents. This is important, because some Verb actions will be forwarded to the items in the list. In this example, open drawers will try to open each drawer in turn as if the player had input open top drawer then open middle drawer then open bottom drawer.
  • name and synonyms have been set to plural words that players are likely to use.
  • thing_this_is_attached is set to desk, the same as the drawers, and is.listed is set to desk so that the Collection doesn't show up in the Room description.

    • Private Constructor:

    var foo = new adventurejs.Collection(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 Collection 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
    $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
    $contains(id) → {Boolean}

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

    Inherited from: adventurejs.Tangible#$contains

    Parameters:

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

    Returns:

    Boolean
    $is
    $is(property, asset)

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

    Inherited from: adventurejs.Tangible#$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("emitting")
      asking, is this asset an enabled substance emitter?
    • 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
    $moveTo(aspect, asset)

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

    Inherited from: adventurejs.Tangible#$moveTo

    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
    $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
    $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
    addAssetAt() → {Array}

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

    Inherited from: adventurejs.Tangible#addAssetAt

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

    Returns:

    Array
    addWordsToLookup
    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
    aliases()

    Defined in: adventure/Asset.js, line 832

    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
    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
    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
    allowVerbWithAsset(options) → {Boolean}

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

    Inherited from: adventurejs.Asset#allowVerbWithAsset

    Parameters:

    • options Object
      An object of options.
      Properties
      • verb String
        Default value:
        The name of a verb.
      • asset Object
        Default value:
        A game asset.
      • ov String <optional>
        Default value: "dov"
        Direct or indirect object of verb (default is "dov").
    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
    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
    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
    areAnscestorsClosed() → {Boolean}

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

    Inherited from: adventurejs.Tangible#areAnscestorsClosed

    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
    areAnscestorsKnown() → {Boolean}

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

    Inherited from: adventurejs.Tangible#areAnscestorsKnown

    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
    areAnscestorsOpen() → {Boolean}

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

    Inherited from: adventurejs.Tangible#areAnscestorsOpen

    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
    areAnscestorsUnknown(nestlevel) → {Boolean}

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

    Inherited from: adventurejs.Tangible#areAnscestorsUnknown

    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
    canAnyPartContainSubstances
    canAnyPartContainSubstances() → {boolean}

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

    Inherited from: adventurejs.Tangible#canAnyPartContainSubstances

    Check whether this asset has a registered part that can contain a substance.

    Returns:

    boolean
    canBePut
    canBePut(aspect, asset) → {Boolean}

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

    Inherited from: adventurejs.Tangible#canBePut

    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
    canContainAssetAt
    canContainAssetAt(object) → {Boolean}

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

    Inherited from: adventurejs.Tangible#canContainAssetAt

    Parameters:

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

    Returns:

    Boolean
    canContainSubstances
    canContainSubstances() → {Boolean}

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

    Inherited from: adventurejs.Tangible#canContainSubstances

    Determine whether asset can contain any substance.

    Returns:

    Boolean
    canDoVerbAutomatically
    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
    canNestPlayerAt(aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#canNestPlayerAt

    Parameters:

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

    Returns:

    Boolean
    canSetVerbState
    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
    canThisAutoOpen
    canThisAutoOpen() → {Boolean}

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

    Inherited from: adventurejs.Tangible#canThisAutoOpen

    Check whether this asset can be auto opened.

    Returns:

    Boolean
    containsAnyAsset
    containsAnyAsset() → {Boolean}

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

    Inherited from: adventurejs.Tangible#containsAnyAsset

    Check whether this asset contains any assets in any aspects.

    Returns:

    Boolean
    containsAnyAssetAt
    containsAnyAssetAt(aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#containsAnyAssetAt

    Parameters:

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

    Returns:

    Boolean
    containsAnySubstance
    containsAnySubstance() → {Boolean}

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

    Inherited from: adventurejs.Tangible#containsAnySubstance

    Check whether this asset contains any substance.

    Returns:

    Boolean
    containsAnySubstanceAt
    containsAnySubstanceAt(aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#containsAnySubstanceAt

    Parameters:

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

    Returns:

    Boolean
    containsAsset
    containsAsset(id) → {String}

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

    Inherited from: adventurejs.Tangible#containsAsset

    Parameters:

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

    Returns:

    String
    containsAssetAt
    containsAssetAt(id, aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#containsAssetAt

    Parameters:

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

    Returns:

    Boolean
    containsSubstance
    containsSubstance(id) → {String}

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

    Inherited from: adventurejs.Tangible#containsSubstance

    Parameters:

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

    Returns:

    String
    containsSubstanceAt
    containsSubstanceAt(id, aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#containsSubstanceAt

    Parameters:

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

    Returns:

    Boolean
    destroy
    destroy()

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

    Inherited from: adventurejs.Tangible#destroy

    Remove this asset from the world before calling superclass.destroy.
    didDoVerbs
    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
    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
    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
    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
    doVerbAction
    doVerbAction(action, asset2, asset3, params) → {Boolean}

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

    Inherited from: adventurejs.Asset#doVerbAction

    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
    findNestedAssetsWithClass
    findNestedAssetsWithClass(instanceClass) → {Array}

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

    Inherited from: adventurejs.Tangible#findNestedAssetsWithClass

    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
    findNestedAssetsWithProperty(property) → {Array}

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

    Inherited from: adventurejs.Tangible#findNestedAssetsWithProperty

    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
    findNestedIndirectObjects(verb, direct_object) → {Array}

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

    Inherited from: adventurejs.Tangible#findNestedIndirectObjects

    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
    get(property, qualifier)

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

    Inherited from: adventurejs.Tangible#get

    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
    getAllContents() → {Array}

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

    Inherited from: adventurejs.Tangible#getAllContents

    Returns an array of all content in any location

    Returns:

    Array
    getAllNestedContents
    getAllNestedContents() → {Array}

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

    Inherited from: adventurejs.Tangible#getAllNestedContents

    Get list of other assets nested within this one.

    Returns:

    Array
    getAncestorId
    getAncestorId() → {String}

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

    Inherited from: adventurejs.Tangible#getAncestorId

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

    Returns:

    String
    getAnyPartContainingAnySubstance
    getAnyPartContainingAnySubstance() → {object|null}

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

    Inherited from: adventurejs.Tangible#getAnyPartContainingAnySubstance

    Get any registered part of this asset that contains any substance.

    Returns:

    object | null
    getAnyPartContainingSubstance
    getAnyPartContainingSubstance(id) → {object}

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

    Inherited from: adventurejs.Tangible#getAnyPartContainingSubstance

    Parameters:

    • id String
    Check whether this asset has a registered part that contains the specified substance.

    Returns:

    object
    getAnySubstanceThisContains
    getAnySubstanceThisContains() → {String}

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

    Inherited from: adventurejs.Tangible#getAnySubstanceThisContains

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

    Returns:

    String
    getAspectAt
    getAspectAt(aspect) → {Object|Null}

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

    Inherited from: adventurejs.Tangible#getAspectAt

    Parameters:

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

    Returns:

    Object | Null
    getClassInheritance
    getClassInheritance() → {Array}

    Defined in: adventure/Atom.js, line 168

    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
    getClosedAnscestors() → {Array}

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

    Inherited from: adventurejs.Tangible#getClosedAnscestors

    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
    getContentsAt() → {Array}

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

    Inherited from: adventurejs.Tangible#getContentsAt

    Returns an array of all content in the specified aspect.

    Returns:

    Array
    getCountOfListableContentsAt
    getCountOfListableContentsAt(where) → {int}

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

    Inherited from: adventurejs.Tangible#getCountOfListableContentsAt

    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
    getDepth() → {Float}

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

    Inherited from: adventurejs.Tangible#getDepth

    Get this asset's depth.

    Returns:

    Float
    getHeight
    getHeight() → {Float}

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

    Inherited from: adventurejs.Tangible#getHeight

    Get this asset's height.

    Returns:

    Float
    getListableContents
    getListableContents() → {Array}

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

    Inherited from: adventurejs.Tangible#getListableContents

    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
    getNestOrPlaceAsset() → {Boolean}

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

    Inherited from: adventurejs.Tangible#getNestOrPlaceAsset

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

    Returns:

    Boolean
    getNestOrPlacePreposition
    getNestOrPlacePreposition() → {Boolean}

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

    Inherited from: adventurejs.Tangible#getNestOrPlacePreposition

    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
    getOpenOrClosed() → {Array}

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

    Inherited from: adventurejs.Tangible#getOpenOrClosed

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

    Returns:

    Array
    getPlaceAspect
    getPlaceAspect() → {Object|null}

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

    Inherited from: adventurejs.Tangible#getPlaceAspect

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

    Returns:

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

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

    Inherited from: adventurejs.Tangible#getPlaceAsset

    Get the object of this asset's parent asset.

    Returns:

    Object | Boolean
    getPlaceAssetId
    getPlaceAssetId() → {String}

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

    Inherited from: adventurejs.Tangible#getPlaceAssetId

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

    Returns:

    String
    getPlacePreposition
    getPlacePreposition() → {String}

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

    Inherited from: adventurejs.Tangible#getPlacePreposition

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

    Returns:

    String
    getPrettyPlacePreposition
    getPrettyPlacePreposition() → {String}

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

    Inherited from: adventurejs.Tangible#getPrettyPlacePreposition

    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
    getPrintableListOfContents(params) → {String}

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

    Inherited from: adventurejs.Tangible#getPrintableListOfContents

    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
    getPrintableListOfContentsAt
    getPrintableListOfContentsAt(aspect, params) → {String}

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

    Inherited from: adventurejs.Tangible#getPrintableListOfContentsAt

    Todos: reconsider this logic because it assumes that aspect can be not enabled while substance within it can be enabled and that is not how I see it right now

    Parameters:

    • aspect String | Object
    • params Object
    Get a printable list of assets within a specified Aspect of this asset, for example to append to asset description when player inputs "look in this". Returns a string.

    Returns:

    String
    getRoomAsset
    getRoomAsset() → {String}

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

    Inherited from: adventurejs.Tangible#getRoomAsset

    Get the asset of the room this asset is in.

    Returns:

    String
    getRoomId
    getRoomId() → {String}

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

    Inherited from: adventurejs.Tangible#getRoomId

    Get the ID of the room this asset is in.

    Returns:

    String
    getRopesThatBlockTravel
    getRopesThatBlockTravel() → {Array}

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

    Inherited from: adventurejs.Tangible#getRopesThatBlockTravel

    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
    getSubstanceAt() → {String}

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

    Inherited from: adventurejs.Tangible#getSubstanceAt

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

    Returns:

    String
    getThingThisIsTiedToPlayerBy
    getThingThisIsTiedToPlayerBy() → {Object}

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

    Inherited from: adventurejs.Tangible#getThingThisIsTiedToPlayerBy

    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
    getTiedThingsThatDragOnTravel() → {Array}

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

    Inherited from: adventurejs.Tangible#getTiedThingsThatDragOnTravel

    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
    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
    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
    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
    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
    getVerbState()

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

    Inherited from: adventurejs.Asset#getVerbState

    getVessel
    getVessel() → {Object|Null}

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

    Inherited from: adventurejs.Tangible#getVessel

    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
    getVesselAt(aspect) → {Object|Null}

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

    Inherited from: adventurejs.Tangible#getVesselAt

    Parameters:

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

    Returns:

    Object | Null
    getVesselPreposition
    getVesselPreposition() → {String}

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

    Inherited from: adventurejs.Tangible#getVesselPreposition

    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
    getWidth() → {Float}

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

    Inherited from: adventurejs.Tangible#getWidth

    Get this asset's width.

    Returns:

    Float
    getY
    getY() → {Float}

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

    Inherited from: adventurejs.Tangible#getY

    Get this asset's global y.

    Returns:

    Float
    getYBottom
    getYBottom() → {Float}

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

    Inherited from: adventurejs.Tangible#getYBottom

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

    Returns:

    Float
    getYRange
    getYRange() → {Object}

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

    Inherited from: adventurejs.Tangible#getYRange

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

    Returns:

    Object
    getYTop
    getYTop() → {Float}

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

    Inherited from: adventurejs.Tangible#getYTop

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

    Returns:

    Float
    has
    has(asset)

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

    Inherited from: adventurejs.Asset#has

    Parameters:

    • asset Object
    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
    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
    hasAnyPartContainingAnySubstance
    hasAnyPartContainingAnySubstance() → {object|null}

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

    Inherited from: adventurejs.Tangible#hasAnyPartContainingAnySubstance

    Check whether this asset has a registered part that contains any substance.

    Returns:

    object | null
    hasAnyPartContainingSubstance
    hasAnyPartContainingSubstance(id) → {boolean}

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

    Inherited from: adventurejs.Tangible#hasAnyPartContainingSubstance

    Parameters:

    • id String
    Check whether this asset has a registered part that contains the specified substance.

    Returns:

    boolean
    hasAspectAt
    hasAspectAt(aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasAspectAt

    Parameters:

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

    Returns:

    Boolean
    hasClass
    hasClass(prop) → {Boolean}

    Defined in: adventure/Atom.js, line 148

    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
    hasContents
    hasContents(preposition) → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasContents

    Parameters:

    • preposition String
      Optionally provide a preposition to specify an aspect.
    Check whether this asset has any contents.

    Returns:

    Boolean
    hasContentsAtAspect
    hasContentsAtAspect(aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasContentsAtAspect

    Parameters:

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

    Returns:

    Boolean
    hasDescription
    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
    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
    hasIndirectObjects
    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
    hasListableContents() → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasListableContents

    Check whether this asset has any listable contents.

    Returns:

    Boolean
    hasPlace
    hasPlace() → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasPlace

    Determine whether asset has a place.

    Returns:

    Boolean
    hasPropertyOnAspectAt
    hasPropertyOnAspectAt() → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasPropertyOnAspectAt

    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
    hasRopesThatBlockTravel() → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasRopesThatBlockTravel

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

    Returns:

    Boolean
    hasTiedThingsThatDragOnTravel
    hasTiedThingsThatDragOnTravel() → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasTiedThingsThatDragOnTravel

    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
    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
    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
    hasVessel() → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasVessel

    Determine whether asset has any aspect with a vessel.

    Returns:

    Boolean
    hasVesselAtAspect
    hasVesselAtAspect(aspect) → {Boolean}

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

    Inherited from: adventurejs.Tangible#hasVesselAtAspect

    Parameters:

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

    Returns:

    Boolean
    iDidVerb
    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
    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
    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
    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
    initialize(game) → {Boolean}

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

    Inherited from: adventurejs.Tangible#initialize

    Parameters:

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

    Returns:

    Boolean
    isAttached
    isAttached(asset) → {boolean}

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

    Inherited from: adventurejs.Tangible#isAttached

    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
    isBehind(asset) → {boolean}

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

    Inherited from: adventurejs.Tangible#isBehind

    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
    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
    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
    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
    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
    isIn(asset) → {boolean}

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

    Inherited from: adventurejs.Tangible#isIn

    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
    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
    isOn(asset) → {boolean}

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

    Inherited from: adventurejs.Tangible#isOn

    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
    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
    isPlacedAtAspect() → {Boolean}

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

    Inherited from: adventurejs.Tangible#isPlacedAtAspect

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

    Returns:

    Boolean
    isPlacedAtAspectAndAsset
    isPlacedAtAspectAndAsset(aspect, asset) → {Boolean}

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

    Inherited from: adventurejs.Tangible#isPlacedAtAspectAndAsset

    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
    isUnder(asset) → {boolean}

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

    Inherited from: adventurejs.Tangible#isUnder

    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
    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
    isWithin(asset) → {boolean}

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

    Inherited from: adventurejs.Tangible#isWithin

    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
    isWithinYRange(asset) → {Boolean}

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

    Inherited from: adventurejs.Tangible#isWithinYRange

    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
    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
    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
    linkComponents
    linkComponents()

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

    Inherited from: adventurejs.Tangible#linkComponents

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

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

    Inherited from: adventurejs.Tangible#moveFrom

    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
    moveTo
    moveTo(aspect, asset)

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

    Inherited from: adventurejs.Tangible#moveTo

    Parameters:

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

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

    Inherited from: adventurejs.Tangible#onAddSubstanceToThis

    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
    onChangeGravity()

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

    Inherited from: adventurejs.Tangible#onChangeGravity

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

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

    Inherited from: adventurejs.Tangible#onChangeMoisture

    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
    onChangeTemperature()

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

    Inherited from: adventurejs.Tangible#onChangeTemperature

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

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

    Inherited from: adventurejs.Tangible#onIngestThat

    Parameters:

    • asset Object
    Called when an asset is ingested by a character. Provides opportunities to override default behavior through the use of verb reactions doIngestThis and doIngestThat.

    Returns:

    *
    onMoistenThisWithThat
    onMoistenThisWithThat(asset)

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

    Inherited from: adventurejs.Tangible#onMoistenThisWithThat

    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
    onMoveThatToThis(asset, where) → {*}

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

    Inherited from: adventurejs.Tangible#onMoveThatToThis

    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:

    *
    onNestThatToThis
    onNestThatToThis(player) → {Boolean}

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

    Inherited from: adventurejs.Tangible#onNestThatToThis

    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
    onRemoveThatFromThis(asset) → {Boolean}

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

    Inherited from: adventurejs.Tangible#onRemoveThatFromThis

    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
    onSubtractSubstanceFromThis(asset)

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

    Inherited from: adventurejs.Tangible#onSubtractSubstanceFromThis

    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
    onTieThisToThat(asset) → {Boolean}

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

    Inherited from: adventurejs.Tangible#onTieThisToThat

    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
    onUnnestThatFromThis(player) → {Boolean}

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

    Inherited from: adventurejs.Tangible#onUnnestThatFromThis

    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
    onUntieThisFromThat(asset) → {Boolean}

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

    Inherited from: adventurejs.Tangible#onUntieThisFromThat

    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
    placePreventsNesting(player) → {Boolean}

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

    Inherited from: adventurejs.Tangible#placePreventsNesting

    Parameters:

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

    Returns:

    Boolean
    put
    put(preposition, indirect_object)

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

    Inherited from: adventurejs.Tangible#put

    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
    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".
    registerComponents
    registerComponents()

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

    Inherited from: adventurejs.Tangible#registerComponents

    registerComponents is a method that links integrated assets. For example, a sink of class Drainable can have a Faucet, a Drain, and multiple Handle(s), each of which may interact with the base asset or each other in different ways.
    removeAssetAt
    removeAssetAt() → {Array}

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

    Inherited from: adventurejs.Tangible#removeAssetAt

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

    Returns:

    Array
    removeThatFromThis
    removeThatFromThis(asset)

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

    Inherited from: adventurejs.Tangible#removeThatFromThis

    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
    set(props) → {Object}

    Defined in: adventure/Atom.js, line 136

    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.)
    setAspectAt
    setAspectAt(aspect) → {Array}

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

    Inherited from: adventurejs.Tangible#setAspectAt

    Parameters:

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

    Returns:

    Array
    setDOV
    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
    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
    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
    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
    setIs(bool)

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

    Inherited from: adventurejs.Asset#setIs

    Parameters:

    • bool Boolean
    Set asset.is.state.
    setLinkedState
    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
    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
    setPlace(aspect, asset_id) → {Object}

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

    Inherited from: adventurejs.Tangible#setPlace

    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
    setPosition(params) → {Object}

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

    Inherited from: adventurejs.Tangible#setPosition

    Parameters:

    • params Object
    Set this asset's global position.

    Returns:

    Object
    setVerbState
    setVerbState()

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

    Inherited from: adventurejs.Asset#setVerbState

    setVerbSubscription
    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
    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
    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
    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
    setVesselAt(aspect) → {Array}

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

    Inherited from: adventurejs.Tangible#setVesselAt

    Parameters:

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

    Returns:

    Array
    setX
    setX(value) → {Float}

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

    Inherited from: adventurejs.Tangible#setX

    Parameters:

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

    Returns:

    Float
    setY
    setY(value) → {Float}

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

    Inherited from: adventurejs.Tangible#setY

    Parameters:

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

    Returns:

    Float
    setZ
    setZ(value) → {Float}

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

    Inherited from: adventurejs.Tangible#setZ

    Parameters:

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

    Returns:

    Float
    toggleState
    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
    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
    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
    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
    unfasten() → {string}

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

    Inherited from: adventurejs.Tangible#unfasten

    unfasten tries several methods for unfastening.

    Returns:

    string
    unredirectVerb
    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
    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
    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
    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
    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
    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
    validate(game) → {Boolean}

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

    Inherited from: adventurejs.Tangible#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
    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
    absorption_quantity :Boolean

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

    Inherited from: adventurejs.Tangible#absorption_quantity

    Default value: 0

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

    Defined in: adventure/Asset.js, line 329

    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
    aperture :String

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

    Inherited from: adventurejs.Tangible#aperture

    Default value: ""

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

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

    Inherited from: adventurejs.Tangible#append_typed_strings_to_description

    Default value: false

    Set whether strings typed on this asset are appended to its description.
    append_written_strings_to_description
    append_written_strings_to_description :Boolean

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

    Inherited from: adventurejs.Tangible#append_written_strings_to_description

    Default value: false

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

    Defined in: adventure/Asset.js, line 411

    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
    articlename :Getter

    Defined in: adventure/Asset.js, line 425

    Inherited from: adventurejs.Asset#articlename

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

    Defined in: adventure/Asset.js, line 492

    Inherited from: adventurejs.Asset#Articlename

    Returns this.articlename with propercase.
    articlename_is
    articlename_is :Getter

    Defined in: adventure/Asset.js, line 452

    Inherited from: adventurejs.Asset#articlename_is

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

    Defined in: adventure/Asset.js, line 501

    Inherited from: adventurejs.Asset#Articlename_is

    Returns this.articlename_is with propercase.
    articlename_isnt
    articlename_isnt :Getter

    Defined in: adventure/Asset.js, line 462

    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
    Articlename_isnt :Getter

    Defined in: adventure/Asset.js, line 510

    Inherited from: adventurejs.Asset#Articlename_isnt

    Returns this.articlename_isnt with propercase.
    articlename_was
    articlename_was :Getter

    Defined in: adventure/Asset.js, line 472

    Inherited from: adventurejs.Asset#articlename_was

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

    Defined in: adventure/Asset.js, line 519

    Inherited from: adventurejs.Asset#Articlename_was

    Returns this.articlename_was with propercase.
    articlename_wasnt
    articlename_wasnt :Getter

    Defined in: adventure/Asset.js, line 482

    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
    Articlename_wasnt :Getter

    Defined in: adventure/Asset.js, line 528

    Inherited from: adventurejs.Asset#Articlename_wasnt

    Returns this.articlename_wasnt with propercase.
    aspects
    aspects :Object

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

    Inherited from: adventurejs.Tangible#aspects

    Default value: {}

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

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

    Inherited from: adventurejs.Tangible#buoyancy

    Default value: 0

    Todos: Implement.

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

    Defined in: adventure/Asset.js, line 58

    Inherited from: adventurejs.Asset#can

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

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

    Inherited from: adventurejs.Tangible#can.be_swung_at

    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
    collection :Getter/Setter

    Defined in: adventure/Asset.js, line 201

    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."
    components
    components :Array

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

    Inherited from: adventurejs.Tangible#components

    Default value: []

    Some Tangibles come pre-coded to handle certain "components", classes which can automatically be linked with each other to form complex associations. For example, a Sink can have matching Faucet, FaucetHandles, Drain and Plug. Not all classes handle components. See each class's documentation header for "Components:" and "Can be part of:". The registerComponents() method is called during initialization. Set up components like this: 
    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 }. ";
    }
  },
  components: [
    // each of these is a name of another Asset
    "hot water handle",
    "cold water handle",
    "faucet",
    "drain",
    "plug"
  ],
});
    contains
    contains :Object

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

    Inherited from: adventurejs.Tangible#contains

    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
    control_target_id :String

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

    Inherited from: adventurejs.Tangible#control_target_id

    Default value: ""

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

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

    Inherited from: adventurejs.Tangible#default_aspect

    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
    definite_article :String

    Defined in: adventure/Asset.js, line 232

    Inherited from: adventurejs.Asset#definite_article

    Default value: 'the'

    The asset's preferred definite article. Can be overridden in game file. Can also be set to honorific, ex: "Mr." "Mrs."
    definite_name
    definite_name :Getter

    Defined in: adventure/Asset.js, line 370

    Inherited from: adventurejs.Asset#definite_name

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

    Defined in: adventure/Asset.js, line 557

    Inherited from: adventurejs.Asset#description

    An alias to descriptions.look.
    descriptions
    descriptions :Object

    Defined in: adventure/Asset.js, line 177

    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
    did :Object

    Defined in: adventure/Asset.js, line 339

    Inherited from: adventurejs.Asset#did

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

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

    Inherited from: adventurejs.Tangible#dimensions

    Default value: {}

    direction
    direction :String

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

    Inherited from: adventurejs.Tangible#direction

    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
    dont_use_articles :Boolean

    Defined in: adventure/Asset.js, line 260

    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
    dov :Boolean

    Defined in: adventure/Asset.js, line 72

    Inherited from: adventurejs.Asset#dov

    Default value: {}

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

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

    Inherited from: adventurejs.Tangible#emits

    Default value: false

    Todos: Write logic for this.

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

    Defined in: adventure/Asset.js, line 151

    Inherited from: adventurejs.Asset#exclude_from_disambiguation

    Default value: false

    Exclude this item from consideration in resolving disambiguation. Used chiefly for global assets like exits and walls that are used to catch references to non-existant assets.
    exclude_from_lookup
    exclude_from_lookup :Boolean

    Defined in: adventure/Asset.js, line 142

    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
    exit :String

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

    Inherited from: adventurejs.Tangible#exit

    Default value: ""

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

    Defined in: adventure/Atom.js, line 115

    Inherited from: adventurejs.Atom#game

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

    Defined in: adventure/Asset.js, line 353

    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
    indefinite_article :String

    Defined in: adventure/Asset.js, line 241

    Inherited from: adventurejs.Asset#indefinite_article

    Default value: 'a'

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

    Defined in: adventure/Asset.js, line 397

    Inherited from: adventurejs.Asset#indefinite_name

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

    Defined in: adventure/Asset.js, line 90

    Inherited from: adventurejs.Asset#iov

    Default value: {}

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

    Defined in: adventure/Asset.js, line 47

    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
    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
    is.buttoned :Boolean

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

    Inherited from: adventurejs.Tangible#is.buttoned

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.carried

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.closed

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.cold_source

    Default value: false

    Nested property of Is

    Set whether asset is a cold source.
    is.collection
    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
    is.connected_by :Boolean

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

    Inherited from: adventurejs.Tangible#is.connected_by

    Default value: {}

    Nested property of Is

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

    Defined in: adventure/Asset_Is.js, line 103

    Inherited from: adventurejs.Asset#is.data

    Default value: false

    Nested property of Is

    A data asset represents data such as a name or password. Ex: "enter password", "tell name to guard"
    is.deep_nest
    is.deep_nest :Boolean

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

    Inherited from: adventurejs.Tangible#is.deep_nest

    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
    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
    is.distant :Boolean

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

    Inherited from: adventurejs.Tangible#is.distant

    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
    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
    is.false_nest :Boolean

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

    Inherited from: adventurejs.Tangible#is.false_nest

    Default value: false

    Nested property of Is

    is.fixed
    is.fixed :Boolean

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

    Inherited from: adventurejs.Tangible#is.fixed

    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
    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
    is.heat_source :Boolean

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

    Inherited from: adventurejs.Tangible#is.heat_source

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.hidden

    Default value: false

    Nested property of Is

    Todos: add logic to test conditions?

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

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

    Inherited from: adventurejs.Tangible#is.hollow

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.inhands

    Nested property of Is

    Get whether this asset is in player's hands.
    is.initialized
    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
    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
    is.light_source :Boolean

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

    Inherited from: adventurejs.Tangible#is.light_source

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.listed

    Default value: true

    Nested property of Is

    Set whether this asset is listed as an inventory item. If parent is a room, this means the asset won't be listed along with other inventory in the room. This is useful for fixed items that are mentioned in the room description, such as furniture. For an example of a parent that is not a room, consider a desk drawer that is attached to a desk and mentioned in the desk's description. The drawer should not be listed along with inventory items on the desk.
    is.locked
    is.locked :Boolean

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

    Inherited from: adventurejs.Tangible#is.locked

    Default value: false

    Nested property of Is

    Set whether this asset is locked.
    is.nameless
    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
    is.on :Boolean

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

    Inherited from: adventurejs.Tangible#is.on

    Default value: false

    Nested property of Is

    Set whether asset is on.
    is.placeholder
    is.placeholder :Boolean

    Defined in: adventure/Asset_Is.js, line 95

    Inherited from: adventurejs.Asset#is.placeholder

    Default value: false

    Nested property of Is

    Placeholders are universally available to catch references to non-existent elements, such as when player tries to use an exit that doesn't exist.
    is.plugged
    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
    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
    is.plural :Boolean

    Defined in: adventure/Asset_Is.js, line 121

    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
    is.present :Getter

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

    Inherited from: adventurejs.Tangible#is.present

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.reachable

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.reservoir

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.screwed

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.sealed

    Default value: false

    Nested property of Is

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

    Defined in: adventure/Asset_Is.js, line 111

    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
    is.supported :Boolean

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

    Inherited from: adventurejs.Tangible#is.supported

    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
    is.takeable :Getter

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

    Inherited from: adventurejs.Tangible#is.takeable

    Nested property of Is

    Get whether this asset is takeable by player.
    is.validated
    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
    is.viewport :Boolean

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

    Inherited from: adventurejs.Tangible#is.viewport

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.visible

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.watertight

    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
    is.worn :Boolean

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

    Inherited from: adventurejs.Tangible#is.worn

    Default value: false

    Nested property of Is

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

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

    Inherited from: adventurejs.Tangible#is.zipped

    Default value: false

    Nested property of Is

    Set whether this asset is zipped.
    linkableClasses
    linkableClasses :Object

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

    Inherited from: adventurejs.Tangible#linkableClasses

    Default value: {}

    linked_components
    linked_components :Object

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

    Inherited from: adventurejs.Tangible#linked_components

    Default value: {}

    When components are linked, a reference to each is saved here.
    linked_parent
    linked_parent :Object

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

    Inherited from: adventurejs.Tangible#linked_parent

    Default value: ""

    If this asset is a linked component of another asset, keep a reference to the parent asset.
    location_required
    location_required :Boolean

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

    Inherited from: adventurejs.Tangible#location_required

    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
    location_unneccessary :Boolean

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

    Inherited from: adventurejs.Tangible#location_unneccessary

    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
    min_light_required_to_see :float

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

    Inherited from: adventurejs.Tangible#min_light_required_to_see

    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
    must :Object

    Defined in: adventure/Asset.js, line 65

    Inherited from: adventurejs.Asset#must

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

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

    Inherited from: adventurejs.Tangible#must.hold_to_read

    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
    must.hold_to_see_through :Boolean

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

    Inherited from: adventurejs.Tangible#must.hold_to_see_through

    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
    must.hold_to_see_with :Boolean

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

    Inherited from: adventurejs.Tangible#must.hold_to_see_with

    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
    must.let_go_after_swing :Boolean

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

    Inherited from: adventurejs.Tangible#must.let_go_after_swing

    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
    must.wear_to_see_through :Boolean

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

    Inherited from: adventurejs.Tangible#must.wear_to_see_through

    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
    must.wear_to_see_with :Boolean

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

    Inherited from: adventurejs.Tangible#must.wear_to_see_with

    Default value: false

    Nested property of Must

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

    Defined in: adventure/Atom.js, line 102

    Inherited from: adventurejs.Atom#Name

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

    Defined in: adventure/Asset.js, line 216

    Inherited from: adventurejs.Asset#name_is_proper

    Default value: false

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

    Defined in: adventure/Asset.js, line 270

    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
    on_tie_to_drag_behind_rope :Boolean

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

    Inherited from: adventurejs.Tangible#on_tie_to_drag_behind_rope

    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
    on_tie_to_this_take_this :Boolean

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

    Inherited from: adventurejs.Tangible#on_tie_to_this_take_this

    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.
    place
    place :Object

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

    Inherited from: adventurejs.Tangible#place

    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_knows_its_hidden
    player_knows_its_hidden :Boolean

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

    Inherited from: adventurejs.Tangible#player_knows_its_hidden

    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
    plural :String

    Defined in: adventure/Asset.js, line 300

    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
    position :Object

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

    Inherited from: adventurejs.Tangible#position

    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.
    posture_position
    posture_position :Boolean

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

    Inherited from: adventurejs.Tangible#posture_position

    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
    print_bold :Boolean

    Defined in: adventure/Asset.js, line 112

    Inherited from: adventurejs.Asset#print_bold

    Default value: false

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

    Defined in: adventure/Asset.js, line 134

    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
    print_italic :Boolean

    Defined in: adventure/Asset.js, line 119

    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
    print_open_or_closed :Boolean

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

    Inherited from: adventurejs.Tangible#print_open_or_closed

    Default value: false

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

    Defined in: adventure/Asset.js, line 126

    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.
    pronouns
    pronouns :String

    Defined in: adventure/Asset.js, line 279

    Inherited from: adventurejs.Asset#pronouns

    pronouns determines what pronouns to use for this asset. Options are FIRST, PLURAL, SECOND, MALE, FEMALE, NONBINARY, and NONHUMAN. Non-character assets are generally NONHUMAN.
    propername
    propername :String

    Defined in: adventure/Asset.js, line 223

    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
    proxy :Getter

    Defined in: adventure/Asset.js, line 547

    Inherited from: adventurejs.Asset#proxy

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

    Defined in: adventure/Asset.js, line 101

    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
    quirks.climb_means_go_on :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.climb_means_go_on

    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
    quirks.climb_means_stand_on :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.climb_means_stand_on

    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
    quirks.flick_means_toggle :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.flick_means_toggle

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.flip_means_toggle

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.get_off_means_go_down

    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
    quirks.get_on_means_go_up :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.get_on_means_go_up

    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
    quirks.get_up_means_get_off :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.get_up_means_get_off

    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
    quirks.in_means_on :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.in_means_on

    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
    quirks.jump_means_jump_off :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.jump_means_jump_off

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.jump_means_jump_on

    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
    quirks.let_go_of_means_go_down :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.let_go_of_means_go_down

    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
    quirks.let_go_of_means_go_off :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.let_go_of_means_go_off

    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
    quirks.look_with_means_look_through :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.look_with_means_look_through

    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
    quirks.pick_means_unlock :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.pick_means_unlock

    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
    quirks.point_means_aim :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.point_means_aim

    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
    quirks.press_means_toggle :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.press_means_toggle

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.pull_means_open

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.pull_means_toggle

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.push_means_toggle

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.put_means_pour

    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
    quirks.stand_means_get_off :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.stand_means_get_off

    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
    quirks.step_on_means_stamp_on :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.step_on_means_stamp_on

    Default value: false

    Nested property of Quirks

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

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

    Inherited from: adventurejs.Tangible#quirks.step_on_means_stand_on

    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
    quirks.take_means_hold :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.take_means_hold

    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
    quirks.write_on_means_write_in :Boolean

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

    Inherited from: adventurejs.Tangible#quirks.write_on_means_write_in

    Default value: false

    Nested property of Quirks

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

    Defined in: adventure/Asset.js, line 361

    Inherited from: adventurejs.Tangible#redirected_verbs

    Default value: {}

    redirected_verbs is an object used for storing verb redirections via redirectVerb().
    short_name
    short_name :Getter

    Defined in: adventure/Asset.js, line 384

    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
    show_things_this_is_tied_to_in_description :Boolean

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

    Inherited from: adventurejs.Tangible#show_things_this_is_tied_to_in_description

    Default value: true

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

    Defined in: adventure/Asset.js, line 288

    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
    split_name_for_world_lookup :Boolean

    Defined in: adventure/Asset.js, line 160

    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.
    to_be
    to_be :Getter

    Defined in: adventure/Asset.js, line 591

    Inherited from: adventurejs.Asset#to_be

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

    Defined in: adventure/Asset.js, line 346

    Inherited from: adventurejs.Asset#tried

    tried is used to track which verbs have been tried upon this object.
    typed_strings
    typed_strings :Array

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

    Inherited from: adventurejs.Tangible#typed_strings

    Default value: []

    List of strings that have been typed on this asset.
    typing_targets
    typing_targets :String

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

    Inherited from: adventurejs.Tangible#typing_targets

    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
    use_definite_article_in_lists :Boolean

    Defined in: adventure/Asset.js, line 249

    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
    use_once_message :Boolean

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

    Inherited from: adventurejs.Tangible#use_once_message

    Default value: false

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

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

    Inherited from: adventurejs.Tangible#written_strings

    Default value: []

    List of strings that have been written on this asset.