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

Class:Atom

constructor description methods properties

Defined in: adventure/Atom.js, line 4

Framework class

Description

Atom is a bedrock class that is used as the prime ancestor for all in-game classes. It defines several important base properties including name, class, id, and the set method. Authors should not need to instantiate or subclass Atom. Start with the Tangible class to create new physical Assets, or the Intangible class to create new abstract Assets.

Private Constructor:

var foo = new adventurejs.Atom(game_name, name, context_id)

Parameters:

  • game_name String
    A reference back to the top level game object, by way of window[game_name]. Done this way rather than using an object reference in order to avoid circular references, because they're difficult to parse into JSON, the method that's used for saving/restoring game data.
  • name String
    The name of the object in the game world, ie "brass lantern". The name is also used to create the object's id by means of removing periods and spaces and converting to lowercase.
  • context_id String
    Optional param used by some supporting classes such as Aspects and Vessels to indicate context.
Inherited Overrides

Methods Collapse all  |  Expand all

getClassInheritance
getClassInheritance() → {Array}

Defined in: adventure/Atom.js, line 168

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 148

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 136

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

Defined in: adventure/ParsedNoun.js, line 165

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 115

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

Defined in: adventure/Atom.js, line 102

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

Defined in: adventure/Atom.js, line 60

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.
context_id
context_id :string

Defined in: adventure/Atom.js, line 99

context_id is set in some child classes including Aspect, Nest, and Vessel to get the object's context, or parent asset.
game_name
game_name :string

Defined in: adventure/Atom.js, line 48

game_name stores the name of the current game instance as scoped to window. (By default, we use "MyGame", but you can use any name.) In order to refer to the game object, we use window[this.game_name]. We store a string instead of the object itself in order to avoid problems caused by circular references during JSON encoding, which is used extensively for managing game state and saved games.
id
id :string

Defined in: adventure/Atom.js, line 85

A unique ID for the game asset, based on the object name provided in the asset definition.
name
name :string

Defined in: adventure/Atom.js, line 74

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.