Monogatari Documentation
HomepageGitHubDiscordTwitter
v2.1.0
v2.1.0
  • Welcome
  • Getting Started
    • Step 1: Setup Your Environment
    • Step 2: Download Monogatari
    • Step 3: Get Familiarized
    • Step 4: Make Your First Visual Novel
  • Upgrading from v1.4.1
  • F.A.Q.
  • Diagnosing Errors
  • Building Blocks
    • Script & Labels
    • Characters
    • Variables & Data Storage
    • Actions
      • Life Cycle
    • Components
      • Life Cycle
      • Built-in Properties
      • Built-in Functions
  • Script Actions
    • Choices
    • Clear
    • Conditionals
    • Dialogs
    • End
    • Gallery
    • Hide Canvas
    • Hide Character
    • Hide Character Layer
    • Hide Image
    • Hide Particles
    • Hide Video
    • Input
    • Functions
    • Jump
    • Next
    • Placeholder
    • Play Music
    • Play Sound
    • Play Voice
    • Show Canvas
    • Show Background
    • Show Character
    • Show Character Layer
    • Show Image
    • Show Message
    • Show Notification
    • Show Particles
    • Show Scene
    • Show Video
    • Stop Music
    • Stop Sound
    • Stop Voice
    • Vibrate
    • Wait
  • Components
    • Credits Screen
    • Quick Menu
    • Loading Screen
    • Main Screen
    • Choice Container
    • Save Slot
    • Text-Box
  • Configuration Options
    • Game Configuration
      • Asset Preloading
      • Internationalization
      • Saving
      • Skip Main Menu
      • Storage
    • Player Preferences
    • Split Files
  • Style & Design
    • Responsiveness
    • CSS Classes
    • HTML Data Attributes
    • Icons
    • Image Menus
  • Releasing Your Game
    • Chrome App
    • Desktop App
    • Mobile
    • Web
  • Advanced: Monogatari Development
    • Core Libraries
      • Artemis
      • Kayros
      • Pandora
    • Actions
    • Components
    • Translations
    • Events
  • Releases
    • v2.0.0.alpha.8
    • v2.0.0.alpha.7
    • v2.0.0.alpha.6
    • v2.0.0.alpha.5
    • v2.0.0.alpha.4
    • v2.0.0.alpha.3
Powered by GitBook
On this page
  • Description
  • Parameters
  • Properties
  • Assets Declarations
  • Supported Formats
  • Examples
  • Play Voice
  • Loop Voice
  • Fade In effect
  • Custom Volume
  • All Together

Was this helpful?

  1. Script Actions

Play Voice

Play a voice audio file

PreviousPlay SoundNextShow Canvas

Last updated 4 years ago

Was this helpful?

Description

'play voice <voice_id> [with [properties]]'

The play voice action let's you, as it name says, play voice files so that you can make your characters speak. You can play as many voices as you want simultaneously.

To stop a voice, check out the .

Action ID: Voice

Reversible: Yes

Requires User Interaction: No

Parameters

Name

Type

Description

voice_id

string

The name of the voice file you want to play. These assets must be declared beforehand.

properties

string

Optional. A list of comma separated properties with their respective value.

Properties

The following is a comprehensive list of the properties available for you to modify certain behaviors of this action.

Property Name

Type

Description

fade

string

The fade property let's you add a fade in effect to the voice, it accepts a time in seconds, representing how much time you want it to take until the voice reaches it's maximum volume.

volume

number

The volume property let's you define how high the voice will be played.

loop

none

Make the voice loop. This property does not require any value.

Assets Declarations

To play a voice, you must first add the file to your assets/voice/ 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.

monogatari.assets ('voice', {
    '<voice_id>': 'voiceFileName'
});

Supported Formats

Each browser has it's own format compatibility. MP3 however is the format supported by every browser.

Examples

Play Voice

The following will play the sound, and once the sound ends, it will simply stop.

monogatari.script ({
    'Start': [
        'play voice dialog_001',
        'This is the dialog that the voice file is narrating',
        'end'
    ]
});
monogatari.assets ('voice', {
    'dialog_001': 'dialog_file_1.mp3'
});

Loop Voice

monogatari.script ({
    'Start': [
        'play voice dialog_001 with loop',
        'This is the dialog that the voice file is narrating',
        'end'
    ]
});
monogatari.assets ('voice', {
    'dialog_001': 'dialog_file_1.mp3'
});

Fade In effect

The following will play the voice file, and will use a fade in effect.

monogatari.script ({
    'Start': [
        'play voice dialog_001 with fade 3',
        'This is the dialog that the voice file is narrating',
        'end'
    ]
});
monogatari.assets ('voice', {
    'dialog_001': 'dialog_file_1.mp3'
});

Custom Volume

The following will set the volume of this voice to 73%.

monogatari.script ({
    'Start': [
        'play voice dialog_001 with volume 73',
        'This is the dialog that the voice file is narrating',
        'end'
    ]
});
monogatari.assets ('voice', {
    'dialog_001': 'dialog_file_1.mp3'
});

Please note however, that the user's preferences regarding volumes are always respected, which means that this percentage is taken from the current player preferences, meaning that if the player has set the volume to 50%, the actual volume value for the voice will be the result of:

All Together

Of course, you can combine all of this properties, and remember the order doesn't really matter, you can write the properties on the order that feels more natural to you.

monogatari.script ({
    'Start': [
        'play voice dialog_001 with volume 100 loop fade 20',
        'This is the dialog that the voice file is narrating',
        'end'
    ]
});
monogatari.assets ('voice', {
    'dialog_001': 'dialog_file_1.mp3'
});

If you wish to use other formats, you can check a to discover what browsers will be able to play it.

The following will play the voice file, and once it ends, it will start over on an infinite loop until it is stopped using the .

50∗0.73=36.550 * 0.73 = 36.5% 50∗0.73=36.5
Stop Voice documentation
compatibility table
Stop Voice Action