Module: SceneManager

Defined in:
lib/rgss3_default_scripts/SceneManager.rb

Overview

** SceneManager

This module manages scene transitions. For example, it can handle

hierarchical structures such as calling the item screen from the main menu or returning from the item screen to the main menu.

Class Method Summary collapse

Class Method Details

.background_bitmap ⇒ Object

  • Get Background Bitmap



91
92
93
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 91

def self.background_bitmap
  @background_bitmap
end

.call(scene_class) ⇒ Object

  • Call



58
59
60
61
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 58

def self.call(scene_class)
  @stack.push(@scene)
  @scene = scene_class.new
end

.clear ⇒ Object

  • Clear Call Stack



71
72
73
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 71

def self.clear
  @stack.clear
end

.exit ⇒ Object

  • Exit Game



77
78
79
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 77

def self.exit
  @scene = nil
end

.first_scene_class ⇒ Object

  • Get First Scene Class



28
29
30
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 28

def self.first_scene_class
  $BTEST ? Scene_Battle : Scene_Title
end

.goto(scene_class) ⇒ Object

  • Direct Transition



52
53
54
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 52

def self.goto(scene_class)
  @scene = scene_class.new
end

.return ⇒ Object

  • Return to Caller



65
66
67
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 65

def self.return
  @scene = @stack.pop
end

.run ⇒ Object

  • Execute



19
20
21
22
23
24
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 19

def self.run
  DataManager.init
  Audio.setup_midi if use_midi?
  @scene = first_scene_class.new
  @scene.main while @scene
end

.scene ⇒ Object

  • Get Current Scene



40
41
42
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 40

def self.scene
  @scene
end

.scene_is?(scene_class) ⇒ Boolean

  • Determine Current Scene Class

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 46

def self.scene_is?(scene_class)
  @scene.instance_of?(scene_class)
end

.snapshot_for_background ⇒ Object

  • Create Snapshot to Use as Background



83
84
85
86
87
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 83

def self.snapshot_for_background
  @background_bitmap.dispose if @background_bitmap
  @background_bitmap = Graphics.snap_to_bitmap
  @background_bitmap.blur
end

.use_midi? ⇒ Boolean

  • Use MIDI?

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/rgss3_default_scripts/SceneManager.rb', line 34

def self.use_midi?
  $data_system.opt_use_midi
end