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

Class:Display

constructor description methods properties

Defined in: adventure/Display.js, line 8

Description

Display creates and manages the game display, including the main input and output areas and the status bar. It also manages custom compasses, verb docks and inventory docks. Authors can customize the display with custom CSS. CSS styles for Display can be found in adventurejs.css. To learn more, see the

Private Constructor:

var foo = new adventurejs.Display(game, displayElId)

Parameters:

  • game Game
    A reference to the game instance.
  • displayElId displayElId | HTMLElement
    An ID for an HTML element to use as a display.
Inherited Overrides

Methods Collapse all  |  Expand all

clearInput
clearInput()

Defined in: adventure/display/clearInput.js, line 8

Clear the input field
clearOutput
clearOutput()

Defined in: adventure/display/clearOutput.js, line 8

Clear the game display.
createCompass
createCompass(properties) → {Element}

Defined in: adventure/display/createCompass.js, line 8

Parameters:

  • properties Object
    HTML ID and CSS classes.
createCompass() is a method for creating compasses, including the default compass in the status bar, and any custom compasses. It takes a generic object containing an id and an optional list of css classes to be applied to a compass's HTML element. Compasses will be created at runtime. Compasses can be styled with any custom CSS. Compasses will be updated to show available exits any time the location changes. To create a new compass: 
MyGame.createCompass({
  "id":"MyCompass",
  "cssclasses":["custom"]
});
For more information, see GUI Compasses.

Returns:

Element Returns the HTML element of the compass.
createImageDock
createImageDock(properties) → {Element}

Defined in: adventure/display/createImageDock.js, line 8

Parameters:

  • properties Object
    HTML ID, CSS classes, and verbs.
createImageDock() is a method for creating custom image docks. It takes a generic object containing an id, an optional list of css classes to be applied to the element, and an object containing image id / image url pairs. Image docks will be created at runtime, and can be styled with any custom CSS. To create a new image dock: 
MyGame.createImageDock({
  "id":"MyImageDock",
  "cssclasses":["custom"],
  "images": [
    [ "myimage_01": "/images/myimage_01.jpg" ],
    [ "myimage_02": "/images/myimage_02.jpg" ],
  ],
});
For more information, see Image Dock.

Returns:

Element Returns the HTML element of the verb dock.
createInventoryDock
createInventoryDock(properties) → {Element}

Defined in: adventure/display/createInventoryDock.js, line 8

Parameters:

  • properties Object
    HTML ID, CSS classes, and verbs.
createInventoryDock() is a method for creating custom inventory docks. It takes a generic object containing an id and an optional list of css classes to be applied to the element. Inventory docks will be created at runtime, and can be styled with any custom CSS. To create a new inventory dock: 
MyGame.createInventoryDock({
  "id":"MyInventoryDock",
  "cssclasses":["custom"]
});
For more information, see GUI Inventory Dock.

Returns:

Element Returns the HTML element of the verb dock.
createVerbDock
createVerbDock(properties) → {Element}

Defined in: adventure/display/createRoomDock.js, line 8

Parameters:

  • properties Object
    HTML ID, CSS classes, and verbs.
createRoomDock() is a method for creating custom room docks. It takes a generic object containing an id, and an optional list of css classes to be applied to the element. Room docks will be created at runtime, and can be styled with any custom CSS. To create a new room dock: 
MyGame.createRoomDock({
  "id":"MyRoomDock",
  "cssclasses":["custom"],
});
For more information, see GUI Verb Dock.

Returns:

Element Returns the HTML element of the verb dock.
createVerbDock
createVerbDock(properties) → {Element}

Defined in: adventure/display/createVerbDock.js, line 8

Parameters:

  • properties Object
    HTML ID, CSS classes, and verbs.
createVerbDock() is a method for creating custom verb docks. It takes a generic object containing an id, a list of verbs, and an optional list of css classes to be applied to the element. Any verbs supplied will have buttons created for them. Verb docks will be created at runtime, and can be styled with any custom CSS. To create a new verb dock: 
MyGame.createVerbDock({
  "id":"MyVerbDock",
  "cssclasses":["custom"],
  "verbs": ["save","restore","examine","take","use","drop"],
});
For more information, see GUI Verb Dock.

Returns:

Element Returns the HTML element of the verb dock.
initialize
initialize(props) → {adventurejs.Display}

Defined in: adventure/display/initialize.js, line 7

Parameters:

  • props Object
    A generic object containing properties to copy to the DisplayObject instance.
Initialize the game display. Creates all the necessary HTML elements.

Returns:

adventurejs.Display Returns the instance the method is called on (useful for chaining calls.)
print
print(msg, classes)

Defined in: adventure/display/print.js, line 8

Todos: add ability to pause at screen height so excess text doesn't scroll off screen

Parameters:

  • msg String
    An arbitrary string.
  • classes String
    Optional class(es) to apply to output.
Global method for printing text to game display.
printInput
printInput(input)

Defined in: adventure/display/printInput.js, line 8

Parameters:

  • input String
    An arbitrary string.
Print the player's input back to game display.
printWithInput
printWithInput(msg, classes)

Defined in: adventure/display/printWithInput.js, line 8

Parameters:

  • msg String
    An arbitrary string.
  • classes String
    Optional class(es) to apply to output.
Print a message preceded by player's input back to game display.
sendToInput
sendToInput()

Defined in: adventure/display/sendToInput.js, line 8

Takes a string and writes it to the input field without submitting it to the parser.
set
set(props) → {adventurejs.Display}

Defined in: adventure/display/set.js, line 7

Parameters:

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

Returns:

adventurejs.Display Returns the instance the method is called on (useful for chaining calls.)
setRoomImage
setRoomImage(id) → {adventurejs.Display}

Defined in: adventure/display/setRoomImage.js, line 8

Parameters:

  • id String
    The id of an image in game.image_lookup.
Set Room image if there is one.

Returns:

adventurejs.Display Returns the instance the method is called on (useful for chaining calls.)
setRoomName
setRoomName(name) → {adventurejs.Display}

Defined in: adventure/display/setRoomName.js, line 8

Parameters:

  • name String
    Sets the Status Bar's Room field.
Set Room in status bar.

Returns:

adventurejs.Display Returns the instance the method is called on (useful for chaining calls.)
setScore
setScore(score) → {adventurejs.Display}

Defined in: adventure/display/setScore.js, line 8

Parameters:

  • score String
    Sets the Status Room field.
Set Score in status bar.

Returns:

adventurejs.Display Returns the instance the method is called on (useful for chaining calls.)
unsetCompasses
unsetCompasses()

Defined in: adventure/display/unsetCompasses.js, line 8

Reset exits in status bar and custom compass roses.
unsetImageDocks
unsetImageDocks(properties)

Defined in: adventure/display/unsetImageDocks.js, line 8

Parameters:

  • properties Object
Unset images in image docks.
unsetInventoryDocks
unsetInventoryDocks(properties)

Defined in: adventure/display/unsetInventoryDocks.js, line 8

Parameters:

  • properties Object
Unset inventory in inventory docks.
unsetRoomDocks
unsetRoomDocks(properties)

Defined in: adventure/display/unsetRoomDocks.js, line 8

Parameters:

  • properties Object
Unset room docks.
unsetVerbDocks
unsetVerbDocks(properties)

Defined in: adventure/display/unsetVerbDocks.js, line 8

Parameters:

  • properties Object
Unset verbs in verb docks.
updateCompasses
updateCompasses(exits)

Defined in: adventure/display/updateCompasses.js, line 8

Parameters:

  • exits String
Set exits in status bar and custom compass roses.
updateImageDocks
updateImageDocks(properties)

Defined in: adventure/display/updateImageDocks.js, line 8

Parameters:

  • properties Object
Set images in image docks.
updateInventoryDocks
updateInventoryDocks(properties)

Defined in: adventure/display/updateInventoryDocks.js, line 8

Todos: different lists for specific docks

Parameters:

  • properties Object
Set inventory in inventory docks.
updateRoomDocks
updateRoomDocks(properties)

Defined in: adventure/display/updateRoomDocks.js, line 8

Todos: this has no logic yet

Parameters:

  • properties Object
Update room in room docks.
updateVerbDocks
updateVerbDocks(properties)

Defined in: adventure/display/updateVerbDocks.js, line 8

Todos: this has no logic yet

Parameters:

  • properties Object
Set verbs in verb docks.

Properties  | 

author
author :String

Defined in: adventure/Display.js, line 146

Default value: ""

The game's author.
compasses
compasses :compasses

Defined in: adventure/Display.js, line 42

Default value: []

An array that contains a list of references to the HTML element of any compasses, including the one in the status bar as well as any custom compasses.
displayEl
displayEl :HTMLElement

Defined in: adventure/Display.js, line 83

Default value: null

A reference to the game's HTML display element.
displayElId
displayElId :HTMLElement

Defined in: adventure/Display.js, line 90

Default value: null

The ID of the game's HTML display element.
game
game :Object

Defined in: adventure/Display.js, line 35

Default value: {}

A reference back to the main Game object.
imagedocks
imagedocks :imagedocks

Defined in: adventure/Display.js, line 75

Default value: []

An array that contains a list of references to the HTML elements of any image docks.
inventorydocks
inventorydocks :inventorydocks

Defined in: adventure/Display.js, line 67

Default value: []

An array that contains a list of references to the HTML elements of any inventory docks.
room
room :String

Defined in: adventure/Display.js, line 158

Default value: ""

The current room's name.
roomdocks
roomdocks :roomdocks

Defined in: adventure/Display.js, line 59

Default value: []

An array that contains a list of references to the HTML elements of any room docks.
score
score :String

Defined in: adventure/Display.js, line 170

Default value: ""

The current score.
title
title :String

Defined in: adventure/Display.js, line 122

Default value: ""

The game's title.
verbdocks
verbdocks :verbdocks

Defined in: adventure/Display.js, line 51

Default value: []

An array that contains a list of references to the HTML elements of any verb docks.
version
version :String

Defined in: adventure/Display.js, line 134

Default value: ""

The game's version.