API Docs for:
Show:

Console Class

Defined in: src/console.js:4

Manages the display and history of console messages to the user. "The troll hits you dealing 10 damage." "You die."

Constructor

Console

(
  • game
  • [messageHistoryCount=5]
  • [elClassName='console']
)

Defined in src/console.js:4

Parameters:

  • game Game
    • Game instance this obj is attached to.
  • [messageHistoryCount=5] Number optional
    • Number of messages to display at once.
  • [elClassName='console'] String optional
    • Css class name to assign to the console element.

Item Index

Methods

Properties

Methods

log

(
  • -
)

Defined in src/console.js:46

Adds a message to the console.

Parameters:

  • - String

    Message to be added.

Properties

el

HTMLElement

Defined in src/console.js:31

Element containing console messages. Must be manually added to the DOM

game

Game

Defined in src/console.js:24

Game instance this obj is attached to.

messageHistoryCount

Number

Defined in src/console.js:39

Number of messages to display at once.