Class OverviewClass Name: Game_System
Class Description: Game_System is a Data class, it handles data surrounding the system. It holds methods for playing sounds and background music as well as updating the timer, it also holds two instances of the interrupter class in 'map_interpreter' and 'battle_interpreter'. Refer to "$game_system" for the instance of this class.
List of global variables usedList of Public Instance Variables
- map_interpreter # map event interpreter
- battle_interpreter # battle event interpreter
- timer # timer
- timer_working # timer working flag
- save_disabled # save forbidden
- menu_disabled # menu forbidden
- encounter_disabled # encounter forbidden
- message_position # text option: positioning
- message_frame # text option: window frame
- save_count # save count
- magic_number # magic number
List of Instance variables
- @map_interpreter
- @battle_interpreter
- @timer
- @timer_working
- @save_disabled
- @menu_disabled
- @encounter_disabled
- @message_position
- @message_frame
- @save_count
- @magic_number
List of Methods:
- initialize
- bgm_play(bgm)
- bgm_stop
- bgm_fade(time)
- bgm_memorize
- bgm_restore
- bgs_play(bgs)
- bgs_fade(time)
- bgs_memorize
- bgs_restore
- me_play(me)
- se_play(se)
- se_stop
- playing_bgm
- playing_bgs
- windowskin_name
- windowskin_name=(windowskin_name)
- battle_bgm
- battle_bgm=(battle_bgm)
- battle_end_me
- battle_end_me=(battle_end_me)
- update
Overview of MethodsMethod initializeMethod Name: initialize
Method Description: when Game_
System.new is called this method sets the default values for all the public instance variables
list of local variables List of Instance variables used
- @map_interpreter
- @battle_interpreter
- @timer
- @timer_working
- @save_disabled
- @menu_disabled
- @encounter_disabled
- @message_position
- @message_frame
- @save_count
- @magic_number
Method bgm_play(bgm) Method Name: bgm_play
Method Description: called with a RPG::AudioFile instance or nil as an argument saves that argument in @playing_bgm and them plays the file or stops the currently playing one if the argument is nil
list of local variables
- bgm # a RPG::AudioFile instance or nil
List of Instance variables usedMethod bgm_stop Method Name: bgm_stop
Method Description: stops the currently playing bgm
list of local variables List of Instance variables usedMethod bgm_fade(time) Method Name: bgm_fade
Method Description: sets @playing_bgm to nil and fades out the currently playing bmg in the number of seconds in the argument it was called with
list of local variables List of Instance variables usedMethod bgm_memorize Method Name: bgm_memorize
Method Description: saves @playing_bgm in @memorized_bgm
list of local variables List of Instance variables used
- @playing_bgm
- @memorized_bgm
Method bgm_restore Method Name: bgm_restore
Method Description: calls bgm_play with @memorized_bgm as an argument
list of local variables List of Instance variables usedMethod bgs_play(bgs) Method Name: bgs_play
Method Description: called with a RPG::AudioFile instance or nil as an argument saves that argument in @playing_bgs and them plays the file or stops the currently playing one if the argument is nil
list of local variables List of Instance variables usedMethod bgs_fade(time) Method Name: bgs_fade
Method Description: called with a number as an argument, fades the currently playing bgs in the number of second specified in the argument.
list of local variables List of Instance variables usedMethod bgs_memorize Method Name: bgs_memorize
Method Description: stores @playing_bgs in @memorized_bgs
list of local variables List of Instance variables used
- @playing_bgs
- @memorized_bgs
Method bgs_restore Method Name: bgs_restore
Method Description: calls bgs_play with @memorized_bgs as an argument
list of local variables List of Instance variables usedMethod me_play(me) Method Name: me_play
Method Description: called with a RPG::AudioFile instance or nil as an argument, plays the file specified in the argument or stops the currently playing one if the argument is nil.
list of local variables List of Instance variables usedMethod se_play(se) Method Name: se_play
Method Description: called with a RPG::AudioFile instance as an argument, plays the file specified in the argument.
list of local variables List of Instance variables usedMethod se_stop Method Name: se_stop
Method Description: stops the currently playing se
list of local variables List of Instance variables usedMethod playing_bgm Method Name: playing_bgm
Method Description: returns @playing_bgm
list of local variables List of Instance variables usedMethod playing_bgs Method Name: playing_bgs
Method Description: returns @playing_bgs
list of local variables List of Instance variables usedMethod windowskin_name Method Name: windowskin_name
Method Description: if @windowskin_name is nil returns the default windowskin name from $data_system.windowskin_name, otherwise it returns if @windowskin_name
list of local variables List of Instance variables usedMethod windowskin_name=(windowskin_name) Method Name: windowskin_name
Method Description: called like $game_system.windowskin_name = 'windowskinname' , sets @windowskin_name equal to 'windowskinname'
list of local variables List of Instance variables usedMethod battle_bgm Method Name: battle_bgm
Method Description: if @battle_bgm is nil returns the default battle_bgm from $data_system.battle_bgm , otherwise it returns if @ battle_bgm
list of local variables List of Instance variables usedMethod battle_bgm=(battle_bgm) Method Name: battle_bgm
Method Description: called like $game_system.battle_bgm = 'battle_bgm' , sets @battle_bgm equal to 'battle_bgm'
list of local variables List of Instance variables usedMethod battle_end_me Method Name: battle_end_me
Method Description: if @battle_end_me is nil returns the default battle_bgm from $data_system. battle_end_me , otherwise it returns if @battle_end_me
list of local variables List of Instance variables usedMethod battle_end_me=(battle_end_me) Method Name: battle_end_me
Method Description: called like $game_system. battle_end_me = 'battle_end_me' , sets @battle_end_me equal to 'battle_end_me
list of local variables List of Instance variables usedMethod update Method Name: update
Method Description: decreases @timer by 1 if the @timer_working flag is set to true and @timer is bigger that 0
list of local variables List of Instance variables used