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

Class:Drainable_Is

constructor description methods properties

Extends: adventurejs.Tangible_Is

Defined in: adventure/assets/tangibles/things/containers/liquidcontainers/Drainable_Is.js, line 5

Description

Drainable_Is.js handles is.state management for Drainable Assets.

Private Constructor:

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

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

getClassInheritance
getClassInheritance() → {Array}

Defined in: adventure/Atom.js, line 191

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

Properties  | 

game
game :Getter

Defined in: adventure/Atom.js, line 138

Inherited from: adventurejs.Atom#game

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

Defined in: adventure/Atom.js, line 114

Inherited from: adventurejs.Atom#id

id returns the id of the class instance.
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.