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

Class:Gas

constructor description methods properties

Extends: AdventureJS.Assets.Substance

Defined in: adventure/assets/substances/Gas.js, line 5

Tutorials: Substances_AboutSubstances

Constructor:

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

Description

Gas is a subclass of Substance with gaseous (as opposed to liquid or solid) properties.

Example:

Substances are different from Tangibles in that they're semi-global, rather than singular. The class represents all of its kind in a Game, meaning, if you create an instance called "helium", all helium in the Game is the same helium, whether it's in a cylinder or a balloon. 

MyGame.createAsset({
  class: "Gas",
  name: "helium",
  description: "It's invisible. ",
});
MyGame.createAsset({
  class: "Balloon",
  name: "balloon",
  place: { in: "Party" },
  description: "It's a balloon. ",
  in:
  {
    vessel: {
      volume: 2000,
      substance_id: "helium",
    },
  },
});

Private Constructor:

var foo = new Gas(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 Gas 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
    Name of top level game instance that is scoped to window.
  • name String
    Instance name.
Inherited Overrides

Index

Methods:

Properties:

Methods Collapse all  |  Expand all

$can
$can() → {Boolean}

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

Inherited from: AdventureJS.Assets.Asset#$can

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

Returns:

Boolean
$getDispenserAssets
$getDispenserAssets() → {Boolean}

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

Inherited from: AdventureJS.Assets.Asset#$getDispenserAssets

Get a list of asset IDs of dispensers of this asset.

Returns:

Boolean
$getDispensers
$getDispensers() → {Boolean}

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

Inherited from: AdventureJS.Assets.Asset#$getDispensers

Get a list of dispensers of this asset.

Returns:

Boolean
$hasDispensers
$hasDispensers() → {Boolean}

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

Inherited from: AdventureJS.Assets.Asset#$hasDispensers

Check whether this asset can be dispensed by other assets.

Returns:

Boolean
$must
$must() → {Boolean}

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

Inherited from: AdventureJS.Assets.Asset#$must

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

Returns:

Boolean
$quirks
$quirks() → {Object|Null}

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

Inherited from: AdventureJS.Assets.Asset#$quirks

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

Returns:

Object | Null
allowVerbOnce
allowVerbOnce(verb, ov) → {Boolean}

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

Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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.Assets.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
canDoVerbAutomatically
canDoVerbAutomatically(verb) → {Boolean}

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

Inherited from: AdventureJS.Assets.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
canSetVerbState
canSetVerbState(verb) → {Boolean}

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

Inherited from: AdventureJS.Assets.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
destroy
destroy(del)

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

Inherited from: AdventureJS.Assets.Asset#destroy

Parameters:

  • del Boolean
    Whether to permanently delete this asset.
destroy is called to remove an asset from the game world. This gets called by game.destroyAsset()
didDoVerbs
didDoVerbs(verbs) → {Boolean}

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

Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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.Assets.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 getStringArrayFunction and return the results. If the result returns false or null it will terminate the calling verb's default behavior.

We look for actions in two forms:
  • Function properties such as asset.doThisToThat() are called. If a function returns null or false, that effectively ends the turn.
  • String properties such as asset.do_this_to_that override the turn's default output.

    • Returns:

    Boolean
    getClassInheritance
    getClassInheritance() → {Array}

    Defined in: adventure/Atom.js, line 197

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

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

    Inherited from: AdventureJS.Assets.Asset#getDescription

    Parameters:

    • identifier String
      An aspect or other identifier.
    Get a description for an identifier on this asset. This is a convenience shortcut to game.getDescription().

    Returns:

    String
    getModifiedDescription
    getModifiedDescription(identifier) → {String}

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

    Inherited from: AdventureJS.Assets.Asset#getModifiedDescription

    Parameters:

    • identifier String
      An aspect or other identifier.
    Get a modified description for an identifier on this asset. This is a convenience shortcut to game.getModifiedDescription().

    Returns:

    String
    getName
    getName(type, kace)

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

    Inherited from: AdventureJS.Assets.Asset#getName

    Parameters:

    • type String
      The type of name to get. Valid options are: article, definite|the, indefinite|a, fungible? (with question mark). Provide values in lowercase, Sentencecase or UPPERCASE to get results in that format.
    • kace String
      Optionally provide an explicit case, which takes precedence over cases found in type param. Valid options are: lower, upper, capitalize, proper.
    getName is called to remove an asset from the game world.
    getQuirks
    getQuirks() → {Object}

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

    Inherited from: AdventureJS.Assets.Asset#getQuirks

    getQuirks() is a general method for getting a list of quirks stored in asset.quirks.

    Returns:

    Object
    getVerbConnectionCount
    getVerbConnectionCount(verb, to_ov) → {Int}

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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.Assets.Asset#getVerbState

    hasAction
    hasAction(hook_name, asset1_name, asset2_name) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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
    hasClass
    hasClass(prop) → {Boolean}

    Defined in: adventure/Atom.js, line 171

    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
    hasDescription
    hasDescription(identifier) → {String|Boolean}

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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
    hasVerbMaxConnections
    hasVerbMaxConnections(verb, to_ov) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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.Assets.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:

    *
    iDidVerb
    iDidVerb(verb, ov) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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.

    Returns:

    Boolean
    iDidVerbCount
    iDidVerbCount(verb, ov) → {Int}

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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()

    Defined in: adventure/Asset.js, line 786

    Inherited from: AdventureJS.Assets.Asset#initialize

    initialize() is the final step of creating a new game world asset, following construction and validation. The chief job of initialization is to add all of this asset's vocabulary to MyGame.world_lookup.

    isConnectedToAnything
    isConnectedToAnything(verb, to_ov) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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
    isInDispenser
    isInDispenser()

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

    Inherited from: AdventureJS.Assets.Asset#isInDispenser

    isInDispenser is called to determine whether a platonic asset is in a dispenser.

    Returns:

    Boolean
    isIOV
    isIOV(verb) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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
    isOV
    isOV(verb) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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
    isVerbState
    isVerbState(verb) → {Boolean}

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

    Inherited from: AdventureJS.Assets.Asset#isVerbState

    Parameters:

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

    Returns:

    Boolean
    iTriedVerb
    iTriedVerb(verb, ov) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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.Assets.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
    redirectVerb
    redirectVerb(oldVerb, newVerb)

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

    Inherited from: AdventureJS.Assets.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".
    returnFalse
    returnFalse() → {Boolean}

    Defined in: adventure/Asset.js, line 864

    Inherited from: AdventureJS.Assets.Asset#returnFalse

    returnFalse() 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 false instead of throwing a "not a function" error.

    Returns:

    Boolean
    returnNull
    returnNull() → {Null}

    Defined in: adventure/Asset.js, line 829

    Inherited from: AdventureJS.Assets.Asset#returnNull

    returnNull() 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.

    Returns:

    Null
    set
    set(props) → {Object}

    Defined in: adventure/Atom.js, line 159

    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.)
    setDOV
    setDOV(verb, params)

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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.Assets.Asset#setIs

    Parameters:

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

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

    Inherited from: AdventureJS.Assets.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.Assets.Asset#setObjectOfVerbs

    Parameters:

    • object_of String
    • verb String
    setObjectOfVerbs is a convenience method that passes a list of verb names through to setVerbSubscription.
    setVerbState
    setVerbState()

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

    Inherited from: AdventureJS.Assets.Asset#setVerbState

    setVerbSubscription
    setVerbSubscription(object_of, verb, params)

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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, Class, ov) → {Boolean}

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

    Inherited from: AdventureJS.Assets.Asset#setVerbWithClass

    Parameters:

    • verb String
      The name of a verb.
    • Class 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
    toggleState
    toggleState(verb) → {Boolean}

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.Asset#undestroy

    undestroy is called to return a destroyed asset to the game world.
    unredirectVerb
    unredirectVerb(oldVerb)

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

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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.Assets.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.Assets.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()

    Defined in: adventure/Asset.js, line 759

    Inherited from: AdventureJS.Assets.Asset#validate

    validate() provides an opportunity to check author-made Assets for errors before initializing them.
    validateVerbConnections
    validateVerbConnections()

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

    Inherited from: AdventureJS.Assets.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  | 

    a
    a :Getter

    Defined in: adventure/Asset.js, line 500

    Inherited from: AdventureJS.Assets.Asset#a

    asset.a is a shortcut to asset.indefinite_article, intended for author convenience.
    adjectives
    adjectives :Getter/Setter

    Defined in: adventure/Asset.js, line 368

    Inherited from: AdventureJS.Assets.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.
    article_name
    article_name :Getter

    Defined in: adventure/Asset.js, line 545

    Inherited from: AdventureJS.Assets.Asset#article_name

    Getter function returns asset name or proper name, with or without definite article or indefinite article, depending on asset settings.
    Article_name
    Article_name :Getter

    Defined in: adventure/Asset.js, line 614

    Inherited from: AdventureJS.Assets.Asset#Article_name

    Returns this.article_name with propercase.
    ARTICLE_NAME
    ARTICLE_NAME :Getter

    Defined in: adventure/Asset.js, line 623

    Inherited from: AdventureJS.Assets.Asset#ARTICLE_NAME

    Returns this.article_name with uppercase.
    article_name_is
    article_name_is :Getter

    Defined in: adventure/Asset.js, line 574

    Inherited from: AdventureJS.Assets.Asset#article_name_is

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

    Defined in: adventure/Asset.js, line 632

    Inherited from: AdventureJS.Assets.Asset#Article_name_is

    Returns this.article_name_is with propercase.
    article_name_isnt
    article_name_isnt :Getter

    Defined in: adventure/Asset.js, line 584

    Inherited from: AdventureJS.Assets.Asset#article_name_isnt

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

    Defined in: adventure/Asset.js, line 641

    Inherited from: AdventureJS.Assets.Asset#Article_name_isnt

    Returns this.article_name_isnt with propercase.
    article_name_was
    article_name_was :Getter

    Defined in: adventure/Asset.js, line 594

    Inherited from: AdventureJS.Assets.Asset#article_name_was

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

    Defined in: adventure/Asset.js, line 650

    Inherited from: AdventureJS.Assets.Asset#Article_name_was

    Returns this.article_name_was with propercase.
    article_name_wasnt
    article_name_wasnt :Getter

    Defined in: adventure/Asset.js, line 604

    Inherited from: AdventureJS.Assets.Asset#article_name_wasnt

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

    Defined in: adventure/Asset.js, line 659

    Inherited from: AdventureJS.Assets.Asset#Article_name_wasnt

    Returns this.article_name_wasnt with propercase.
    can
    can :Object

    Defined in: adventure/Asset.js, line 61

    Inherited from: AdventureJS.Assets.Asset#can

    can is a generalized container for asset boolean properties.
    collection
    collection :Getter/Setter

    Defined in: adventure/Asset.js, line 212

    Inherited from: AdventureJS.Assets.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."
    definite_article
    definite_article :String

    Defined in: adventure/Asset.js, line 270

    Inherited from: AdventureJS.Assets.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 424

    Inherited from: AdventureJS.Assets.Asset#definite_name

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

    Defined in: adventure/Asset.js, line 438

    Inherited from: AdventureJS.Assets.Asset#Definite_name

    Getter function returns capitalized indefinite_name.
    DEFINITE_NAME
    DEFINITE_NAME :Getter

    Defined in: adventure/Asset.js, line 447

    Inherited from: AdventureJS.Assets.Asset#DEFINITE_NAME

    Getter function returns uppercase definite_name.
    description
    description :*

    Defined in: adventure/Asset.js, line 688

    Inherited from: AdventureJS.Assets.Asset#description

    An alias to descriptions.look.
    descriptions
    descriptions :Object

    Defined in: adventure/Asset.js, line 188

    Inherited from: AdventureJS.Assets.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.feel - used if player types "touch thing"
    • descriptions.careful - used if player types "carefully examine thing"
    did
    did :Object

    Defined in: adventure/Asset.js, line 384

    Inherited from: AdventureJS.Assets.Asset#did

    did is used to track which verbs have acted upon this object.
    dov
    dov :Boolean

    Defined in: adventure/Asset.js, line 83

    Inherited from: AdventureJS.Assets.Asset#dov

    Default value: {}

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

    Defined in: adventure/Asset.js, line 162

    Inherited from: AdventureJS.Assets.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 153

    Inherited from: AdventureJS.Assets.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.
    fungible
    fungible :Object

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

    Inherited from: AdventureJS.Assets.Asset#fungible

    Default value: {}

    Used to set properties controlling how instances of this class are dispensed, if the class is fungible. this.fungible.dispensers contains a list of assets that dispense this class.
    game
    game :Getter

    Defined in: adventure/Atom.js, line 138

    Inherited from: AdventureJS.Atom#game

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

    Defined in: adventure/Asset.js, line 308

    Inherited from: AdventureJS.Assets.Asset#gender

    Set a gender for this asset. use for this asset. Default options are male, female, transgender, nonbinary, and nonhuman, though authors may edit this list. Non-character assets default to nonhuman.
    id
    id :String

    Defined in: adventure/Atom.js, line 114

    Inherited from: AdventureJS.Atom#id

    id returns the id of the class instance.
    image
    image :String

    Defined in: adventure/Asset.js, line 398

    Inherited from: AdventureJS.Assets.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 279

    Inherited from: AdventureJS.Assets.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 513

    Inherited from: AdventureJS.Assets.Asset#indefinite_name

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

    Defined in: adventure/Asset.js, line 527

    Inherited from: AdventureJS.Assets.Asset#Indefinite_name

    Getter function returns capitalized indefinite_name.
    INDEFINITE_NAME
    INDEFINITE_NAME :Getter

    Defined in: adventure/Asset.js, line 536

    Inherited from: AdventureJS.Assets.Asset#INDEFINITE_NAME

    Getter function returns uppercase indefinite_name.
    inflect
    inflect :Getter

    Defined in: adventure/Asset.js, line 742

    Inherited from: AdventureJS.Assets.Asset#inflect

    Getter function takes a plural pronoun and inflects it to the equivalent pronoun for this asset's pronoun setting.
    iov
    iov :Boolean

    Defined in: adventure/Asset.js, line 101

    Inherited from: AdventureJS.Assets.Asset#iov

    Default value: {}

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

    Defined in: adventure/Asset.js, line 46

    Inherited from: AdventureJS.Assets.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.Assets.Asset#is.abstract

    Default value: false

    Nested property of Is

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

    Defined in: adventure/assets/Substance_Is.js, line 46

    Inherited from: AdventureJS.Assets.Substance#is.breathable

    Default value: false

    Nested property of Is

    Set whether this gas asset is breathable.
    is.collection
    is.collection :Boolean

    Defined in: adventure/Asset_Is.js, line 48

    Inherited from: AdventureJS.Assets.Asset#is.collection

    Default value: true

    Nested property of Is

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

    Defined in: adventure/Asset_Is.js, line 103

    Inherited from: AdventureJS.Assets.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.destroyed
    is.destroyed :Boolean

    Defined in: adventure/Asset_Is.js, line 33

    Inherited from: AdventureJS.Assets.Asset#is.destroyed

    Default value: false

    Nested property of Is

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

    Defined in: adventure/assets/Substance_Is.js, line 60

    Inherited from: AdventureJS.Assets.Substance#is.edible

    Default value: false

    Nested property of Is

    Set whether this solid asset is edible.
    is.extant
    is.extant :Boolean

    Defined in: adventure/Asset_Is.js, line 41

    Inherited from: AdventureJS.Assets.Asset#is.extant

    Default value: true

    Nested property of Is

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

    Defined in: adventure/Asset_Is.js, line 79

    Inherited from: AdventureJS.Assets.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.initialized
    is.initialized :Boolean

    Defined in: adventure/Asset_Is.js, line 62

    Inherited from: AdventureJS.Assets.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/assets/Substance_Is.js, line 74

    Inherited from: AdventureJS.Assets.Substance#is.known

    Default value: true

    Nested property of Is

    Set this asset known. All substances are known by default.
    is.liquid
    is.liquid :Boolean

    Defined in: adventure/assets/Substance_Is.js, line 25

    Overrides from: AdventureJS.Assets.Substance#is.liquid

    Default value: false

    Nested property of Is

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

    Defined in: adventure/Asset_Is.js, line 69

    Inherited from: AdventureJS.Assets.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.placeholder
    is.placeholder :Boolean

    Defined in: adventure/Asset_Is.js, line 95

    Inherited from: AdventureJS.Assets.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.Assets.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.Assets.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.Assets.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.potable
    is.potable :Boolean

    Defined in: adventure/assets/Substance_Is.js, line 32

    Inherited from: AdventureJS.Assets.Substance#is.potable

    Default value: false

    Nested property of Is

    Set whether this liquid asset is potable.
    is.seen
    is.seen :Boolean

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

    Inherited from: AdventureJS.Assets.Substance#is.seen

    Default value: true

    Nested property of Is

    Set this asset seen. All substances are seen by default.
    is.singleton
    is.singleton :Boolean

    Defined in: adventure/Asset_Is.js, line 111

    Inherited from: AdventureJS.Assets.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.validated
    is.validated :Boolean

    Defined in: adventure/Asset_Is.js, line 55

    Inherited from: AdventureJS.Assets.Asset#is.validated

    Default value: false

    Nested property of Is

    Used at runtime to keep track of asset's validation state.
    keywords
    keywords :Getter/Setter

    Defined in: adventure/Asset.js, line 378

    Inherited from: AdventureJS.Assets.Asset#keywords

    A list of keywords that are written to world_lookup for this item.
    must
    must :Object

    Defined in: adventure/Asset.js, line 72

    Inherited from: AdventureJS.Assets.Asset#must

    must is a generalized container for asset boolean properties.
    name
    name :String

    Defined in: adventure/Atom.js, line 62

    Inherited from: AdventureJS.Atom#name

    Class identifier to be provided in the asset definition. All game objects start as generic objects that get passed to createAsset, which uses an object's class field to specify a class constructor.
    Name
    Name :String

    Defined in: adventure/Atom.js, line 125

    Inherited from: AdventureJS.Atom#Name

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

    Defined in: adventure/Asset.js, line 227

    Inherited from: AdventureJS.Assets.Asset#name_returns_input

    Default value: false

    If true, when asset is referred to in player input, asset.name will return whatever term player used that resolved to this asset. This is useful for multifacted assets. For example, imgine a desert mirage that is randomly described as a tent or a camel or a pond. Whichever word the player inputs - x tent, x camel, x pond - will be used in the output.
    noun
    noun :String

    Defined in: adventure/Asset.js, line 348

    Inherited from: AdventureJS.Assets.Asset#noun

    group is a string representing a collective category. For example, chair, bed, and desk all share a group of furniture. Players can input this word to refer to any asset of its type.
    plural
    plural :String

    Defined in: adventure/Asset.js, line 327

    Inherited from: AdventureJS.Assets.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.
    print_bold
    print_bold :Boolean

    Defined in: adventure/Asset.js, line 123

    Inherited from: AdventureJS.Assets.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 145

    Inherited from: AdventureJS.Assets.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 130

    Inherited from: AdventureJS.Assets.Asset#print_italic

    Default value: false

    Set to true to have an object's name be printed italic.
    print_style
    print_style :String

    Defined in: adventure/Asset.js, line 137

    Inherited from: AdventureJS.Assets.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 298

    Inherited from: AdventureJS.Assets.Asset#pronouns

    pronouns determines what pronouns to use for this asset. Default options are first, plural, second, male, female, nonbinary, and nonhuman, though authors may edit this list. Non-character assets default to nonhuman.
    proper_name
    proper_name :String

    Defined in: adventure/Asset.js, line 239

    Inherited from: AdventureJS.Assets.Asset#proper_name

    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'.
    Proper_name
    Proper_name :Getter

    Defined in: adventure/Asset.js, line 469

    Inherited from: AdventureJS.Assets.Asset#Proper_name

    Getter function returns capitalized proper_name.
    PROPER_NAME
    PROPER_NAME :Getter

    Defined in: adventure/Asset.js, line 478

    Inherited from: AdventureJS.Assets.Asset#PROPER_NAME

    Getter function returns uppercase proper_name.
    proxy
    proxy :Getter

    Defined in: adventure/Asset.js, line 678

    Inherited from: AdventureJS.Assets.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 112

    Inherited from: AdventureJS.Assets.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.
    singular
    singular :String

    Defined in: adventure/Asset.js, line 318

    Inherited from: AdventureJS.Assets.Asset#singular

    singular is a string representing one asset of this class, for example 'sword'. Players can input this word to refer to an instance of this class.
    singularPluralPairs
    singularPluralPairs :Array

    Defined in: adventure/Asset.js, line 336

    Inherited from: AdventureJS.Assets.Asset#singularPluralPairs

    singularPluralPairs 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 171

    Inherited from: AdventureJS.Assets.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.
    the
    the :Getter

    Defined in: adventure/Asset.js, line 487

    Inherited from: AdventureJS.Assets.Asset#the

    asset.the is a shortcut to asset.definite_article, intended for author convenience.
    to_be
    to_be :Getter

    Defined in: adventure/Asset.js, line 722

    Inherited from: AdventureJS.Assets.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 391

    Inherited from: AdventureJS.Assets.Asset#tried

    tried is used to track which verbs have been tried upon this object.
    use_definite_article
    use_definite_article :Boolean

    Defined in: adventure/Asset.js, line 260

    Inherited from: AdventureJS.Assets.Asset#use_definite_article

    Default value: true

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

    Defined in: adventure/Asset.js, line 287

    Inherited from: AdventureJS.Assets.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 by game settings.
    use_proper_name
    use_proper_name :Boolean

    Defined in: adventure/Asset.js, line 248

    Inherited from: AdventureJS.Assets.Asset#use_proper_name

    Default value: true

    Used to determine whether to display name or proper name. If this is set to false, by default the asset's name will be printed with a definite article. If set to true, the asset's name will be printed without a definite article. For instance, you might want a name like "Mrs. Fox" to appear as written, whereas you might want a character just named "fox" to appear as "the fox" in text.