Class:Display
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.
- Index
- Methods
- Properties
Index
Methods:
- clearInput
- clearOutput
- createCompass
- createImageDock
- createInventoryDock
- createVerbDock
- initialize
- printInput
- printWithInput
- sendToInput
- set
- setRoomImage
- setRoomName
- setScore
- unsetCompasses
- unsetImageDocks
- unsetInventoryDocks
- unsetVerbDocks
- updateCompasses
- updateImageDocks
- updateInventoryDocks
- updateVerbDocks
Properties:
Methods Collapse all |
clearInput
clearInput()
Defined in: adventure/display/clearInput.js, line 8
clearOutput
clearOutput()
Defined in: adventure/display/clearOutput.js, line 8
createCompass
createCompass(properties) → {Element}
Defined in: adventure/display/createCompass.js, line 8
Parameters:
-
properties
Object
HTML ID and CSS classes.
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.
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.
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/createVerbDock.js, line 8
Parameters:
-
properties
Object
HTML ID, CSS classes, and verbs.
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.
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.
printInput
printInput(input)
Defined in: adventure/display/printInput.js, line 8
Parameters:
-
input
String
An arbitrary string.
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.
sendToInput
sendToInput()
Defined in: adventure/display/sendToInput.js, line 8
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.
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.
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.
Returns:
adventurejs.Display
Returns the instance the method is called on (useful for chaining calls.)
setScore
setScore(score) → {Display}
Defined in: adventure/display/setScore.js, line 8
Parameters:
-
score
String
Sets the Status Room field.
unsetCompasses
unsetCompasses()
Defined in: adventure/display/unsetCompasses.js, line 8
unsetImageDocks
unsetImageDocks(properties)
Defined in: adventure/display/unsetImageDocks.js, line 8
Parameters:
-
properties
Object
unsetInventoryDocks
unsetInventoryDocks(properties)
Defined in: adventure/display/unsetInventoryDocks.js, line 8
Parameters:
-
properties
Object
unsetVerbDocks
unsetVerbDocks(properties)
Defined in: adventure/display/unsetVerbDocks.js, line 8
Parameters:
-
properties
Object
updateCompasses
updateCompasses(exits)
Defined in: adventure/display/updateCompasses.js, line 8
Parameters:
-
exits
String
updateImageDocks
updateImageDocks(properties)
Defined in: adventure/display/updateImageDocks.js, line 8
Parameters:
-
properties
Object
updateInventoryDocks
updateInventoryDocks(properties)
Defined in: adventure/display/updateInventoryDocks.js, line 8
Todos: different lists for specific docks
Parameters:
-
properties
Object
updateVerbDocks
updateVerbDocks(properties)
Defined in: adventure/display/updateVerbDocks.js, line 8
Todos: this has no logic yet
Parameters:
-
properties
Object
Properties |
author
author :String
compasses
compasses :compasses
Defined in: adventure/Display.js, line 42
Default value: []
displayEl
displayEl :HTMLElement
Defined in: adventure/Display.js, line 75
Default value: null
displayElId
displayElId :HTMLElement
Defined in: adventure/Display.js, line 82
Default value: null
game
game :Object
Defined in: adventure/Display.js, line 35
Default value: {}
imagedocks
imagedocks :imagedocks
Defined in: adventure/Display.js, line 67
Default value: []
inventorydocks
inventorydocks :inventorydocks
Defined in: adventure/Display.js, line 59
Default value: []
room
room :String
score
score :String
title
title :String
verbdocks
verbdocks :verbdocks
Defined in: adventure/Display.js, line 51
Default value: []
version