F12 Pause

F12 Pause with image script Version: 1.1

By: Zeriab

Description

This script changes the functionality of the F12 button so it toggles pause on and off instead of resetting the game.

It displays an image while paused.

Screenshots

Instructions

Copy+paste the script into the script editor. (Unsure? See this tutorial)

Import picture named pause to Graphics/Pictures. You can use the example picture below for trying it out.

Script

#==============================================================================

# ** Pausing with F12

#------------------------------------------------------------------------------

# Zeriab

# Version 1.1

# 2009-05-25 (Year-Month-Day)

#------------------------------------------------------------------------------

# * Version History :

# Version 1.0 -------------------------------------------------- (2009-05-22)

# - First release

# Version 1.1 -------------------------------------------------- (2009-05-25)

# - The pause image now appears immediately when F12 is pressed.

# - Transitions are cut short rather than restarted when F12 is pressed.

#------------------------------------------------------------------------------

# * Description :

# This script changes the functionality of pressing F12 during the game

# from resetting the game to (un)pausing the game. A picture is displayed

# while the game is paused. (Having a picture is optional)

#------------------------------------------------------------------------------

# * License :

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU Lesser Public License for more details.

# For the full license see <http://www.gnu.org/licenses/>

# The GNU General Public License: http://www.gnu.org/licenses/gpl.txt

# The GNU Lesser General Public License: http://www.gnu.org/licenses/lgpl.txt

#------------------------------------------------------------------------------

# * Compatibility :

# Is most likely not compatible with other F12 prevention scripts.

#------------------------------------------------------------------------------

# * Instructions :

# Place this script anywhere above main.

# The image file 'pause' present in Graphics/Pictures is used.

# Note: No picture is shown if there is no 'pause' in Graphics/Pictures.

#==============================================================================

#=============================================================================

# ** Reset class (because it won't be defined until F12 is pressed otherwise)

#=============================================================================

class Reset < Exception

end

#=============================================================================

# ** Module Graphics

#=============================================================================

module Graphics

class << self

#-------------------------------------------------------------------------

# * Aliases Graphics.update and Graphics.transition

#-------------------------------------------------------------------------

unless self.method_defined?(:zeriab_f12_pause_update)

alias_method(:zeriab_f12_pause_update, :update)

alias_method(:zeriab_f12_pause_transition, :transition)

end

#-------------------------------------------------------------------------

# Change the update method so F12 toggles pause

#-------------------------------------------------------------------------

def update(*args)

# Try to update normally

begin

zeriab_f12_pause_update(*args)

return

rescue Reset

# Do nothing

end

# F12 has been pressed

done = false

# Store frame count

frame_count = Graphics.frame_count

# Show pause image

@sprite = Sprite.new

@sprite.z = 9999

begin

@sprite.bitmap = RPG::Cache.picture('pause')

rescue

@sprite.bitmap = Bitmap.new(32,32)

end

# Keep trying to do the update

while !done

begin

zeriab_f12_pause_update(*args)

done = true

rescue Reset

# Do Nothing

end

# F12 has been released, update until it is pressed again

while done

begin

zeriab_f12_pause_update(*args)

rescue Reset

done = false

end

# F12 has been pressed, keep trying to update

while !done

begin

zeriab_f12_pause_update(*args)

done = true

rescue Reset

# Do nothing

end

# F12 has been released, dispose pause image

@sprite.dispose

# Set proper frame count

Graphics.frame_count = frame_count

end

#-------------------------------------------------------------------------

# Changes the transition so it is cut short if F12 is pressed

#-------------------------------------------------------------------------

def transition(*args)

done = false

# Keep trying to do the transition

while !done

begin

zeriab_f12_pause_transition(*args)

done = true

rescue Reset

# Set transition length to 0 frames.

args[0] = 0

end

Credit

Credits goes to Zeriab for writing the script and making the Paused picture.

Known Compatibility Issues

Will most like not work together with other scripts changing the functionality of the F12 button.

Author's Notes

Thanks goes to sixdd for suggesting pause toggling and showing a pause image.

Thanks goes to Kiriashi for inspiration on cutting the transitions short.

You can use the pause image and modify it any way you like. You don't have to provide credits or anything.

If F12 is pressed during a transition the transition is cut short.

Note that it does NOT work on VX.

Terms and Conditions

LGPL

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU Lesser Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU Lesser Public License for more details.

For the full license see <http://www.gnu.org/licenses/>

The GNU General Public License: http://www.gnu.org/licenses/gpl.txt

The GNU Lesser General Public License: http://www.gnu.org/licenses/lgpl.txt

F6 Pauses the game

In case you want to have a pause button which is not F12 I have made this script:

#=============================================================================

# ** Module Input

#=============================================================================

module Input

class << self

#-------------------------------------------------------------------------

# * Aliases Graphics.update and Graphics.transition

#-------------------------------------------------------------------------

unless self.method_defined?(:zeriab_pause_update)

alias_method(:zeriab_pause_update, :update)

end

def update(*args)

zeriab_pause_update(*args)

return unless trigger?(F6)

# Store frame count

frame_count = Graphics.frame_count

# Show pause image

@sprite = Sprite.new

@sprite.z = 9999

begin

@sprite.bitmap = RPG::Cache.picture('pause')

rescue

@sprite.bitmap = Bitmap.new(32,32)

end

# Update once so the trigger doesn't count.

zeriab_pause_update(*args)

# Update until trigger

while !trigger?(F6)

zeriab_pause_update(*args)

Graphics.update

end

# Dispose pause image

@sprite.dispose

# Set proper frame count

Graphics.frame_count = frame_count

end

This will work for the buttons specified in help file.

Quote:

DOWN LEFT RIGHT UP

Numbers corresponding to the directions down, left, right, and up.

A B C X Y Z L R

Numbers corresponding to the various controller buttons.

SHIFT CTRL ALT

Numbers directly corresponding to the keyboard's SHIFT, CTRL, and ALT keys.

F5 F6 F7 F8 F9

Numbers corresponding to the keyboard's function keys. The other function keys are reserved by the system and cannot be obtained.

If you want to use other keys I would suggest finding an input script to your liking and modifying this script to accommodate to the input script you choose.

*hugs*