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

Class:Introcard

constructor description methods properties

Defined in: Adventure/Introcard.js, line 5

Engine class

Description

Introcard is a repository for properties used to print an introductory screen at the start of the game. Introcard is created automatically by Game. This is an internal class that authors should not need to construct. However, authors can set intro options from their game file as shown below.

Example:

var MyGame = new AdventureJS.Game( "MyGame", "GameDisplay" );
MyGame.introcard.set({
});

Private Constructor:

var foo = new AdventureJS.Introcard(game)

Parameters:

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

Methods Collapse all  |  Expand all

set
set(props) → {AdventureJS.Introcard}

Defined in: Adventure/Introcard.js, line 124

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.Introcard Returns the instance the method is called on (useful for chaining calls.)
show
show()

Defined in: Adventure/Introcard.js, line 89

Show the introcard.

Properties  | 

clear_on_continue
clear_on_continue :Boolean

Defined in: Adventure/Introcard.js, line 51

Default value: false

If true, clear the screen before continuing the game.
hide_statusbar
hide_statusbar :Boolean

Defined in: Adventure/Introcard.js, line 58

Default value: false

Hide statusbar when introcard is shown
hide_titlebar
hide_titlebar :Boolean

Defined in: Adventure/Introcard.js, line 73

Default value: false

Hide titlebar when introcard is shown.
prompt_text
prompt_text :String

Defined in: Adventure/Introcard.js, line 37

Default value: ""

Optional text to show when prompting user to press a key.
prompt_to_continue
prompt_to_continue :boolean

Defined in: Adventure/Introcard.js, line 44

Default value: false

If true, prompt the user to press a key to continue.
show_statusbar_on_continue
show_statusbar_on_continue :Boolean

Defined in: Adventure/Introcard.js, line 65

Default value: true

If statusbar was hidden on showing the introcard, restore it on hiding the introcard.
show_statusbar_on_continue
show_statusbar_on_continue :Boolean

Defined in: Adventure/Outrocard.js, line 86

Default value: true

If statusbar was hidden on showing the outrocard, restore it on hiding the outrocard.
show_titlebar_on_continue
show_titlebar_on_continue :Boolean

Defined in: Adventure/Introcard.js, line 80

Default value: true

If titlebar was hidden on showing the introcard, restore it on hiding the introcard.
text
text :String

Defined in: Adventure/Introcard.js, line 30

Default value: ""

Optional text to show at the top of the introcard.