Show Video

Description

1
'show video <video_id> <mode> [with [properties]]'
Copied!
The video action allows you to show videos on your novel in different modes.
Action ID: Video
Reversible: Yes
Requires User Interaction: No, unless the close property is not given, then the user will have to click once the video is over to advance.

Parameters

Name
Type
Description
mode
string
Defines what way you want to show the video like.
Possible Values:
    modal - Shows the video as a
    immersive - Shows the video covering the full game screen
    background - Shows the video as a background for your characters
    fullscreen - Attempts to show the video in full screen, if permission is denied, it will fallback to the immersive mode.
video_id
string
The ID of a video asset previously defined.

Properties

The following is a comprehensive list of the properties available for you to modify certain behaviors of the video action.
Name
Type
Description
controls
No value required
Optional. Adding this property will make the video controls (play, pause, seeking) visible for the player.
close
No value required
Optional. Adding this property will make the video close itself once it's over.
loop
No value required
Optional. Adding this property will make the video loop. The close property will not have any effect if the loop property is added.

Assets Declarations

To play a video, you must first add the file to your assets/video/ directory and then declare it. To do so, Monogatari has an has a function that will let you declare all kinds of assets for your game.
1
Monogatari.assets ('videos', {
2
'<video_id>': 'videoFileName'
3
});
Copied!

Supported Formats

Each browser has it's own format compatibility. MP4 however is the format supported by most browsers.
If you wish to use other formats, you can check a compatibility table to discover what browsers will be able to play it.

Examples

Script
Video Assets
1
Monogatari.script ({
2
'Start': [
3
'show video flowerTimelapse modal'
4
'end'
5
]
6
});
Copied!
1
Monogatari.assets ('video', {
2
'<video_id>': 'videoFileName'
3
});
Copied!
Last modified 1yr ago