RPG::System Class Reference

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

#include <System.h>

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::Switch!)
DArray< int, 1 >	variables
	Variables (see also RPG::Variable!)
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.
int	lastSavedSlot
	The last save slot called.
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 Data Documentation

frameCounter

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

---

The documentation for this class was generated from the following file:

• include/DynRPG/System.h