RPG Paper Maker

Class: SystemSong

SystemSong

A song of the game

new SystemSong (json, kind)

Name Type Default Description
json Object optional Json object describing the song
kind SongKind SongKind.Music optional The kind of song
Properties:
Name Type Description
kind SongKind The kind of song
id number The song ID
name string The song name
isBR boolean Indicate if the pciture is a BR (Basic Ressource)
isDLC boolean Indicate if the pciture is a DLC
song Howl The loaded Howl song

Members

getLocalFolder

Get the local folder associated to a kind of song

Methods

SystemSong.getFolder (kind, isBR, isDLC)string static

Get the folder associated to a kind of song
Name Type Description
kind SongKind The kind of song
isBR boolean Indicate if the pciture is a BR
isDLC boolean Indicate if the pciture is a DLC
Returns:
Type Description
string

read (json)

Read the JSON associated to the song
Name Type Description
json Object Json object describing the song

getPath ()string

Get the absolute path associated to this song
Returns:
Type Description
string

load ()

Load the song