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

Class:Outrocard

constructor description methods properties

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", "GameDisplay" );
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 186

Hide the outrocard.
set
set(props) → {AdventureJS.Outrocard}

Defined in: Adventure/Outrocard.js, line 202

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:

AdventureJS.Outrocard Returns the instance the method is called on (useful for chaining calls.)
show
show()

Defined in: Adventure/Outrocard.js, line 110

Show the outrocard.

Properties  | 

clear_on_continue
clear_on_continue :Boolean

Defined in: Adventure/Outrocard.js, line 72

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 65

Default value: false

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

Defined in: Adventure/Outrocard.js, line 79

Default value: false

Hide statusbar when outrocard is shown
hide_titlebar
hide_titlebar :Boolean

Defined in: Adventure/Outrocard.js, line 94

Default value: false

Hide titlebar when outrocard is shown.
show_quit
show_quit :Boolean

Defined in: Adventure/Outrocard.js, line 58

Default value: true

Show quit button on outrocard.
show_restart
show_restart :Boolean

Defined in: Adventure/Outrocard.js, line 51

Default value: true

Show restart button on outrocard.
show_restore
show_restore :Boolean

Defined in: Adventure/Outrocard.js, line 44

Default value: true

Show restore button on outrocard.
show_titlebar_on_continue
show_titlebar_on_continue :Boolean

Defined in: Adventure/Outrocard.js, line 101

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 37

Default value: true

Show undo button on outrocard.
text
text :String

Defined in: Adventure/Outrocard.js, line 30

Default value: ""

Optional text to show at the top of the outrocard.