Class: Game_System

Game_System()

new Game_System()

The game object class for the system data. Use as global variable $gameSystem
Properties:
Name Type Description
_saveEnabled Boolean
_menuEnabled Boolean
_encounterEnabled Boolean
_formationEnabled Boolean
_battleCount Number
_winCount Number
_escapeCount Number
_saveCount Number
_versionId Number
_framesOnSave Number
_bgmOnSave RPG.AudioFile
_bgsOnSave RPG.AudioFile
_windowTone Array.<Number>
_battleBgm RPG.AudioFile
_victoryMe RPG.AudioFile
_defeatMe RPG.AudioFile
_savedBgm RPG.AudioFile
_walkingBgm RPG.AudioFile

Methods

battleBgm() → {RPG.AudioFile}

Returns the current battle background music.
Returns:
Type
RPG.AudioFile

battleCount() → {Number}

Returns the number of battles the player has participated in.
Returns:
Type
Number

defeatMe() → {RPG.AudioFile}

Returns the defeat musical effect.
Returns:
Type
RPG.AudioFile

disableEncounter()

Returns true if the player can encounter enemies.

disableFormation()

Disables the use of the formation command in the menu.

disableMenu()

Disables the menu from being accessed.

disableSave()

Disables the ability to save the game.

enableEncounter()

enableFormation()

Enables the use of the formation command in the menu.

enableMenu()

Enables the menu to be accessed.

enableSave()

Enables the ability to save the game.

escapeCount() → {Number}

Returns the number of battles the player has escaped from in battle.
Returns:
Type
Number

isChinese() → {Boolean}

Returns:
Type
Boolean

isCJK() → {Boolean}

Returns:
Type
Boolean

isEncounterEnabled() → {Boolean}

Returns:
Type
Boolean

isFormationEnabled() → {Boolean}

Returns:
Type
Boolean

isJapanese() → {Boolean}

Returns:
Type
Boolean

isKorean() → {Boolean}

Returns:
Type
Boolean

isMenuEnabled() → {Boolean}

Returns true if the menu is enabled.
Returns:
Type
Boolean

isRussian() → {Boolean}

Returns:
Type
Boolean

isSaveEnabled() → {Boolean}

Returns:
Type
Boolean

isSideView() → {Boolean}

Returns:
Type
Boolean

onAfterLoad()

onBattleEscape()

onBattleStart()

onBattleWin()

onBeforeSave()

playtime() → {Number}

Returns the total play time.
Returns:
Type
Number

playtimeText() → {String}

Returns:
Type
String

replayBgm()

Replays the saved background music.

replayWalkingBgm()

Replays the saved walking background music.

saveBgm()

Saves background music to the game system object.

saveCount() → {Number}

Returns the number of saves the player has made in game.
Returns:
Type
Number

saveWalkingBgm()

Saves the walking background music.

saveWalkingBgm2()

Saves the second walking bgm from the map data.

setBattleBgm(value)

Sets the battle background music.
Parameters:
Name Type Description
value RPG.AudioFile

setDefeatMe(value)

Sets the defeat musical effect.
Parameters:
Name Type Description
value RPG.AudioFile

setVictoryMe(value)

Sets the victory musical effect.
Parameters:
Name Type Description
value RPG.AudioFile

setWindowTone(value)

Sets the window tone, given an array of rgb. Example: [0, 255, 255].
Parameters:
Name Type Description
value Array.<Number>

versionId() → {Number}

Returns the version id represented in the database.
Returns:
Type
Number

victoryMe() → {RPG.AudioFile}

Returns the victory musical effect.
Returns:
Type
RPG.AudioFile

winCount() → {Number}

Returns the number of the wins the player has gained in battle.
Returns:
Type
Number

windowTone() → {Array.<Number>}

Returns the tone of the window in the database.
Returns:
Type
Array.<Number>