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

Class:Outrocard

Defined in: Adventure/Outrocard.js, line 5

Engine class

Description

Outrocard can be used to print a completion screen when a player reaches an end state of the game (win, lose, or draw). Outrocard is created automatically by Game. This is an internal class that authors should not need to construct. However, authors can set title options from their game file as shown below.

Example:

var MyGame = new AdventureJS.Game( "MyGame", "GameContainer" );
MyGame.Outrocard.set({
});

Private Constructor:

var foo = new AdventureJS.Outrocard(game)

Parameters:

  • game Game
    A reference to the game instance.
Inherited Overrides

Methods Collapse all  |  Expand all

hide
hide()

Defined in: Adventure/Outrocard.js, line 215

Hide the outrocard.
hide
hide()

Defined in: Adventure/Outrocard.js, line 235

Clears the outrocard from the output without removing other content.
set
set(props) → {Object}

Defined in: Adventure/Outrocard.js, line 250

Parameters:

  • props Object
    A generic object containing properties to copy to the 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.)
show
show()

Defined in: Adventure/Outrocard.js, line 118

Show the outrocard.

Properties  | 

clear_on_continue
clear_on_continue :Boolean

Defined in: Adventure/Outrocard.js, line 73

Default value: false

If true, clear the screen when choosing a followup option.
clear_on_show
clear_on_show :Boolean

Defined in: Adventure/Outrocard.js, line 66

Default value: false

If true, clear the screen when showing the outro.
hide_statusbar
hide_statusbar :Boolean

Defined in: Adventure/Outrocard.js, line 80

Default value: false

Hide statusbar when outrocard is shown
hide_titlebar
hide_titlebar :Boolean

Defined in: Adventure/Outrocard.js, line 95

Default value: false

Hide titlebar when outrocard is shown.
is_shown
is_shown :Boolean

Defined in: Adventure/Outrocard.js, line 110

Default value: true

Used to keep track of the outrocard's visibility.
show_quit
show_quit :Boolean

Defined in: Adventure/Outrocard.js, line 59

Default value: true

Show quit button on outrocard.
show_restart
show_restart :Boolean

Defined in: Adventure/Outrocard.js, line 52

Default value: true

Show restart button on outrocard.
show_restore
show_restore :Boolean

Defined in: Adventure/Outrocard.js, line 45

Default value: true

Show restore button on outrocard.
show_titlebar_on_continue
show_titlebar_on_continue :Boolean

Defined in: Adventure/Outrocard.js, line 102

Default value: true

If titlebar was hidden on showing the outrocard, restore it on hiding the outrocard.
show_undo
show_undo :Boolean

Defined in: Adventure/Outrocard.js, line 38

Default value: true

Show undo button on outrocard.
text
text :String

Defined in: Adventure/Outrocard.js, line 31

Default value: ""

Optional text to show at the top of the outrocard.