Customize Output:Introcards
You may wish to begin your game with a introcard – meaning, some kind of introductory block of text, perhaps showing your game's title, version, and author name, or some backstory setting up the game's premise. The introcard manager offers options for clearing the screen, showing information outside the main flow of text, toggling the visibility of UI elements, and prompting the user to press a key to continue.
Desert Drifter
Version 0.0.1
It was foolish to step away from the camel string. You were quickly
separated by the raging sandstorm. All it took was one, two, three steps,
before the buffeting wind had you completely disoriented. Now you are lost
with nothing but an empty water skin.
[Press any key to continue...]
DesertDrifter.introcard.set({
hide_statusbar: true,
prompt_to_continue: true,
prompt_text: `[Press any key to continue...]`,
clear_on_continue: true,
text: `
{title}
Version {version}
By {author}
It was foolish to step away from the camel string. {We} {were} quickly separated by the raging sandstorm. All it took was one, two, three steps, before the buffeting wind had {us} completely disoriented. Now {we} {are} lost with nothing but an empty water skin.
`,
});
Introcard Properties
- text {String} The text to be printed as the body of the introcard. This text can include inline CSS and is subject to StringArrayFunction.
- prompt_to_continue {Boolean} If set true, the main text will be followed with a message telling the user to touch a key to continue.
- prompt_text {String} This is the text that says something like "[touch any key to continue]". This is an optional field. If no text is provided, game.settings.prompt_text will be used.
- clear_on_continue {Boolean} If set true, when the player touches a key to continue, the intro text screen will be cleared.
- hide_statusbar {Boolean} If set true, the game's statusbar will be hidden at the introcard.
- show_statusbar_on_continue {Boolean} If set true, the game's statusbar will be shown when the player touches a key to continue.
- hide_titlebar {Boolean} If set true, the game's titlebar will be hidden at the introcard.
- show_titlebar_on_continue {Boolean} If set true, the game's titlebar will be shown when the player touches a key to continue.