RPG::System Class Reference

Used for system data which can change in-game. More...

List of all members.

Public Member Functions
RPG::Music *	getTitleBGM ()
	Returns the current title screen music.
RPG::Music *	getBattleBGM ()
	Returns the current battle music.
RPG::Music *	getVictoryBGM ()
	Returns the current victory music.
RPG::Music *	getInnBGM ()
	Returns the current inn music.
RPG::Music *	getSkiffBGM ()
	Returns the current skiff music.
RPG::Music *	getShipBGM ()
	Returns the current ship music.
RPG::Music *	getAirshipBGM ()
	Returns the current airship music.
RPG::Music *	getGameOverBGM ()
	Returns the current game over music.
RPG::Sound *	getCursorSE ()
	Returns the current cursor sound.
RPG::Sound *	getDecisionSE ()
	Returns the current decision sound.
RPG::Sound *	getCancelSE ()
	Returns the current cancel sound.
RPG::Sound *	getBuzzerSE ()
	Returns the current buzzer sound.
RPG::Sound *	getBattleStartSE ()
	Returns the current battle start sound.
RPG::Sound *	getFleeSE ()
	Returns the current escape sound.
RPG::Sound *	getEnemyAttackSE ()
	Returns the current monster attack sound.
RPG::Sound *	getEnemyDamageSE ()
	Returns the current monster damage sound.
RPG::Sound *	getHeroDamageSE ()
	Returns the current actor damage sound.
RPG::Sound *	getEvasionSE ()
	Returns the current evasion sound.
RPG::Sound *	getEnemyDeathSE ()
	Returns the current monster death sound.
RPG::Sound *	getItemSE ()
	Returns the current item sound.
RPG::Transition	getTeleportEraseTrans ()
	Returns the current teleport screen erasing transition.
RPG::Transition	getTeleportShowTrans ()
	Returns the current teleport screen showing transition.
RPG::Transition	getBattleStartEraseTrans ()
	Returns the current battle start screen erasing transition.
RPG::Transition	getBattleStartShowTrans ()
	Returns the current battle start screen showing transition.
RPG::Transition	getBattleEndEraseTrans ()
	Returns the current battle end screen erasing transition.
RPG::Transition	getBattleEndShowTrans ()
	Returns the current battle end screen showing transition.
Public Attributes
Scene_T	scene
	Current game scene (see RPG::Scene)
int	frameCounter
	Internal frame counter (see details!)
DStringPtr	systemGraphicFilename
	Filename of the system graphic (empty for default)
bool	systemTiled
	Is the window background tiled?
SystemFont	systemFont
	Current system font.
SystemGraphic *	systemGraphic
	Current system and system2 graphic.
DArray< bool, 1 >	switches
	Switches (see also RPG::Switches!)
DArray< int, 1 >	variables
	Variables (see also RPG::Variables!)
bool	messageTransparent
	Is the message background invisible? (see also RPG::BattleSettings::transparentWindows)
MessagePosition	messagePosition
	Position of the message.
bool	messageAutoPos
	Prevent hero from being overlapped by a message?
bool	messageModal
	Should messages pause other event activites?
DStringPtr	faceFilename
	Filename of the current face.
int	faceID
	ID of the sprite in the faceset.
FacePosition	facePosition
	Position of the face.
bool	faceMirrored
	Is the face mirrored?
Image *	faceImage
	RPG::Image of the face.
bool	messageActive
	Is a message active?
bool	musicFade
	Is the music fading?
Music *	currentBGM
	Current background music.
Music *	pedestrianBGM
	Background music which should be restored after the vehicle has been exited.
Music *	mapBGM
	Background music on the map (used to restore music after battle)
Music *	memorizedBGM
	Memorized music.
Music *	titleBGM
	Current title screen music (empty for default)
Music *	battleBGM
	Current battle music (empty for default)
Music *	victoryBGM
	Current victory music (empty for default)
Music *	innBGM
	Current inn music (empty for default)
Music *	skiffBGM
	Current skiff music (empty for default)
Music *	shipBGM
	Current ship music (empty for default)
Music *	airshipBGM
	Current airship music (empty for default)
Music *	gameOverBGM
	Current game over music (empty for default)
Sound *	cursorSE
	Current cursor sound (empty for default)
Sound *	decisionSE
	Current decision sound (empty for default)
Sound *	cancelSE
	Current cancel sound (empty for default)
Sound *	buzzerSE
	Current buzzer sound (empty for default)
Sound *	battleStartSE
	Current sound played at battle start (empty for default)
Sound *	fleeSE
	Current sound played when a battler escapes (empty for default)
Sound *	enemyAttackSE
	Current sound played when a monster attacks (empty for default)
Sound *	enemyDamageSE
	Current sound played when a monster is damaged (empty for default)
Sound *	heroDamageSE
	Current sound played when an actor is damaged (empty for default)
Sound *	evasionSE
	Current sound played when an attack is evaded (empty for default)
Sound *	enemyDeathSE
	Current sound played when a monster is killed (empty for default)
Sound *	itemSE
	Current sound played when an item is used (empty for default)
Transition_T	teleportEraseTrans
	Current screen erasing transition on teleport (see RPG::Transition)
Transition_T	teleportShowTrans
	Current screen showing transition on teleport (see RPG::Transition)
Transition_T	battleStartEraseTrans
	Current screen erasing transition on battle start (see RPG::Transition)
Transition_T	battleStartShowTrans
	Current screen showing transition on battle start (see RPG::Transition)
Transition_T	battleEndEraseTrans
	Current screen erasing transition on battle end (see RPG::Transition)
Transition_T	battleEndShowTrans
	Current screen showing transition on battle end (see RPG::Translation)
bool	teleportAllowed
	Are teleport skills allowed?
bool	escapeAllowed
	Are escaped skills allowed?
bool	saveAllowed
	Is saving allows?
bool	menuAllowed
	Is the game menu allowed?
DStringPtr	defaultBackdrop
	Filename of default backdrop.
int	saveCount
	Number of times saved.
ATBMode_T	atbMode
	ATB mode.

---

Detailed Description

Used for system data which can change in-game.

Note:

Many things are only stored in this class if they were changed and are now different from the default in the database, thus you should use the getter methods to access these things.

See also:

RPG::system

RPG::DBSystem

RPG::dbSystem

---

Member Function Documentation

RPG::Music* RPG::System::getAirshipBGM

(

)

Returns the current airship music.

RPG::Music* RPG::System::getBattleBGM

(

)

Returns the current battle music.

RPG::Transition RPG::System::getBattleEndEraseTrans

(

)

Returns the current battle end screen erasing transition.

RPG::Transition RPG::System::getBattleEndShowTrans

(

)

Returns the current battle end screen showing transition.

RPG::Transition RPG::System::getBattleStartEraseTrans

(

)

Returns the current battle start screen erasing transition.

RPG::Sound* RPG::System::getBattleStartSE

(

)

Returns the current battle start sound.

RPG::Transition RPG::System::getBattleStartShowTrans

(

)

Returns the current battle start screen showing transition.

RPG::Sound* RPG::System::getBuzzerSE

(

)

Returns the current buzzer sound.

RPG::Sound* RPG::System::getCancelSE

(

)

Returns the current cancel sound.

RPG::Sound* RPG::System::getCursorSE

(

)

Returns the current cursor sound.

RPG::Sound* RPG::System::getDecisionSE

(

)

Returns the current decision sound.

RPG::Sound* RPG::System::getEnemyAttackSE

(

)

Returns the current monster attack sound.

RPG::Sound* RPG::System::getEnemyDamageSE

(

)

Returns the current monster damage sound.

RPG::Sound* RPG::System::getEnemyDeathSE

(

)

Returns the current monster death sound.

RPG::Sound* RPG::System::getEvasionSE

(

)

Returns the current evasion sound.

RPG::Sound* RPG::System::getFleeSE

(

)

Returns the current escape sound.

RPG::Music* RPG::System::getGameOverBGM

(

)

Returns the current game over music.

RPG::Sound* RPG::System::getHeroDamageSE

(

)

Returns the current actor damage sound.

RPG::Music* RPG::System::getInnBGM

(

)

Returns the current inn music.

RPG::Sound* RPG::System::getItemSE

(

)

Returns the current item sound.

RPG::Music* RPG::System::getShipBGM

(

)

Returns the current ship music.

RPG::Music* RPG::System::getSkiffBGM

(

)

Returns the current skiff music.

RPG::Transition RPG::System::getTeleportEraseTrans

(

)

Returns the current teleport screen erasing transition.

RPG::Transition RPG::System::getTeleportShowTrans

(

)

Returns the current teleport screen showing transition.

RPG::Music* RPG::System::getTitleBGM

(

)

Returns the current title screen music.

RPG::Music* RPG::System::getVictoryBGM

(

)

Returns the current victory music.

---

Member Data Documentation

Music* RPG::System::airshipBGM

Current airship music (empty for default)

ATBMode_T RPG::System::atbMode

ATB mode.

Music* RPG::System::battleBGM

Current battle music (empty for default)

Transition_T RPG::System::battleEndEraseTrans

Current screen erasing transition on battle end (see RPG::Transition)

Transition_T RPG::System::battleEndShowTrans

Current screen showing transition on battle end (see RPG::Translation)

Transition_T RPG::System::battleStartEraseTrans

Current screen erasing transition on battle start (see RPG::Transition)

Sound* RPG::System::battleStartSE

Current sound played at battle start (empty for default)

Transition_T RPG::System::battleStartShowTrans

Current screen showing transition on battle start (see RPG::Transition)

Sound* RPG::System::buzzerSE

Current buzzer sound (empty for default)

Sound* RPG::System::cancelSE

Current cancel sound (empty for default)

Music* RPG::System::currentBGM

Current background music.

Sound* RPG::System::cursorSE

Current cursor sound (empty for default)

Sound* RPG::System::decisionSE

Current decision sound (empty for default)

DStringPtr RPG::System::defaultBackdrop

Filename of default backdrop.

Sound* RPG::System::enemyAttackSE

Current sound played when a monster attacks (empty for default)

Sound* RPG::System::enemyDamageSE

Current sound played when a monster is damaged (empty for default)

Sound* RPG::System::enemyDeathSE

Current sound played when a monster is killed (empty for default)

bool RPG::System::escapeAllowed

Are escaped skills allowed?

Sound* RPG::System::evasionSE

Current sound played when an attack is evaded (empty for default)

DStringPtr RPG::System::faceFilename

Filename of the current face.

int RPG::System::faceID

ID of the sprite in the faceset.

Image* RPG::System::faceImage

RPG::Image of the face.

bool RPG::System::faceMirrored

Is the face mirrored?

FacePosition RPG::System::facePosition

Position of the face.

Sound* RPG::System::fleeSE

Current sound played when a battler escapes (empty for default)

int RPG::System::frameCounter

Internal frame counter (see details!)

This frame counter will count every update of the game scene. Please read the onFrame documentation too!

See also:

onFrame

Music* RPG::System::gameOverBGM

Current game over music (empty for default)

Sound* RPG::System::heroDamageSE

Current sound played when an actor is damaged (empty for default)

Music* RPG::System::innBGM

Current inn music (empty for default)

Sound* RPG::System::itemSE

Current sound played when an item is used (empty for default)

Music* RPG::System::mapBGM

Background music on the map (used to restore music after battle)

Music* RPG::System::memorizedBGM

Memorized music.

bool RPG::System::menuAllowed

Is the game menu allowed?

bool RPG::System::messageActive

Is a message active?

bool RPG::System::messageAutoPos

Prevent hero from being overlapped by a message?

bool RPG::System::messageModal

Should messages pause other event activites?

MessagePosition RPG::System::messagePosition

Position of the message.

bool RPG::System::messageTransparent

Is the message background invisible? (see also RPG::BattleSettings::transparentWindows)

bool RPG::System::musicFade

Is the music fading?

Music* RPG::System::pedestrianBGM

Background music which should be restored after the vehicle has been exited.

bool RPG::System::saveAllowed

Is saving allows?

int RPG::System::saveCount

Number of times saved.

Scene_T RPG::System::scene

Current game scene (see RPG::Scene)

Music* RPG::System::shipBGM

Current ship music (empty for default)

Music* RPG::System::skiffBGM

Current skiff music (empty for default)

DArray<bool, 1> RPG::System::switches

Switches (see also RPG::Switches!)

SystemFont RPG::System::systemFont

Current system font.

SystemGraphic* RPG::System::systemGraphic

Current system and system2 graphic.

DStringPtr RPG::System::systemGraphicFilename

Filename of the system graphic (empty for default)

bool RPG::System::systemTiled

Is the window background tiled?

bool RPG::System::teleportAllowed

Are teleport skills allowed?

Transition_T RPG::System::teleportEraseTrans

Current screen erasing transition on teleport (see RPG::Transition)

Transition_T RPG::System::teleportShowTrans

Current screen showing transition on teleport (see RPG::Transition)

Music* RPG::System::titleBGM

Current title screen music (empty for default)

DArray<int, 1> RPG::System::variables

Variables (see also RPG::Variables!)

Music* RPG::System::victoryBGM

Current victory music (empty for default)