Module Rubygame
In: lib/rubygame/sprite.rb
lib/rubygame/clock.rb
lib/rubygame/constants.rb
lib/rubygame/event.rb
lib/rubygame/rect.rb
lib/rubygame/queue.rb
lib/rubygame/sfont.rb
lib/rubygame/keyconstants.rb
ext/rubygame/rubygame_transform.c
ext/rubygame/rubygame_ttf.c
ext/rubygame/rubygame_joystick.c
ext/rubygame/rubygame_event.c
ext/rubygame/rubygame_image.c
ext/rubygame/rubygame_time.c
ext/rubygame/rubygame_draw.c
ext/rubygame/rubygame.c
ext/rubygame/rubygame_screen.c
ext/rubygame/rubygame_surface.c
ext/rubygame/rubygame_gl.c

Rubygame — Ruby bindings to SDL to facilitate game creation Copyright (C) 2004-2005 John ‘jacius’ Croisant

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Methods

init   key2str  

Classes and Modules

Module Rubygame::Draw
Module Rubygame::GL
Module Rubygame::Image
Module Rubygame::Key
Module Rubygame::Mouse
Module Rubygame::Sprites
Module Rubygame::Time
Module Rubygame::Transform
Class Rubygame::ActiveEvent
Class Rubygame::Event
Class Rubygame::ExposeEvent
Class Rubygame::JoyAxisEvent
Class Rubygame::JoyBallEvent
Class Rubygame::JoyDownEvent
Class Rubygame::JoyHatEvent
Class Rubygame::JoyUpEvent
Class Rubygame::Joystick
Class Rubygame::KeyDownEvent
Class Rubygame::KeyUpEvent
Class Rubygame::MouseDownEvent
Class Rubygame::MouseMotionEvent
Class Rubygame::MouseUpEvent
Class Rubygame::Queue
Class Rubygame::QuitEvent
Class Rubygame::Rect
Class Rubygame::ResizeEvent
Class Rubygame::SDLError
Class Rubygame::SFont
Class Rubygame::Screen
Class Rubygame::Surface
Class Rubygame::TTF

Constants

ALL_EVENT_CLASSES = [ActiveEvent, KeyDownEvent, KeyUpEvent,\ MouseMotionEvent,MouseDownEvent,MouseUpEvent,JoyAxisEvent,\ JoyBallEvent, JoyHatEvent,JoyDownEvent, JoyUpEvent,\ ResizeEvent, QuitEvent]   List of all Rubygame hardware event classes. *Do not modify!*
ALL_KEYS = {\ K_BACKSPACE => ["\b", "backspace"],\ K_TAB => ["\t", "tab"],\ K_CLEAR => [nil, "clear"],\ K_RETURN => ["\n", "return", "enter"],\ K_PAUSE => [nil, "pause"],\ K_ESCAPE => ["^[", "escape"],\ K_SPACE => [" ", "space"],\ K_EXCLAIM => ["!", "exclamation_mark", "exclaim"],\ K_QUOTEDBL => ["\"", "double_quote"],\ K_HASH => ["#", "hash", "pound", "bang"],\ K_DOLLAR => ["$", "dollar"],\ K_AMPERSAND => ["&", "ampersand", "and"],\ K_QUOTE => ["'", "quote"],\ K_LEFTPAREN => ["(", "left_parenthesis", "lparen"],\ K_RIGHTPAREN => [")", "right_parenthesis","rparen"],\ K_ASTERISK => ["*", "asterisk"],\ K_PLUS => ["+", "plus"],\ K_COMMA => [",", "comma"],\ K_MINUS => ["-", "minus"],\ K_PERIOD => [".", "period"],\ K_SLASH => ["/", "slash"],\ K_0 => ["0", "numberline_0"],\ K_1 => ["1", "numberline_1"],\ K_2 => ["2", "numberline_2"],\ K_3 => ["3", "numberline_3"],\ K_4 => ["4", "numberline_4"],\ K_5 => ["5", "numberline_5"],\ K_6 => ["6", "numberline_6"],\ K_7 => ["7", "numberline_7"],\ K_8 => ["8", "numberline_8"],\ K_9 => ["9", "numberline_9"],\ K_COLON => [":", "colon"],\ K_SEMICOLON => [";", "semicolon"],\ K_LESS => ["<", "less_than"],\ K_EQUALS => ["=", "equals"],\ K_GREATER => [">", "greater_than"],\ K_QUESTION => ["?", "question_mark", "question"],\ K_AT => ["@", "at"],\ K_LEFTBRACKET => ["[", "left_bracket", "lbracket"],\ K_BACKSLASH => ["\\", "backslash"],\ K_RIGHTBRACKET => ["]", "right_bracket", "rbracket"],\ K_CARET => ["^", "caret"],\ K_UNDERSCORE => ["_", "underscore"],\ K_BACKQUOTE => ["`", "backquote", "grave"],\ K_A => ["a"],\ K_B => ["b"],\ K_C => ["c"],\ K_D => ["d"],\ K_E => ["e"],\ K_F => ["f"],\ K_G => ["g"],\ K_H => ["h"],\ K_I => ["i"],\ K_J => ["j"],\ K_K => ["k"],\ K_L => ["l"],\ K_M => ["m"],\ K_N => ["n"],\ K_O => ["o"],\ K_P => ["p"],\ K_Q => ["q"],\ K_R => ["r"],\ K_S => ["s"],\ K_T => ["t"],\ K_U => ["u"],\ K_V => ["v"],\ K_W => ["w"],\ K_X => ["x"],\ K_Y => ["y"],\ K_Z => ["z"],\ K_DELETE => [nil, "delete", "del"],\ K_KP0 => ["0", "kp0", "keypad_0"],\ K_KP1 => ["1", "kp1", "keypad_1"],\ K_KP2 => ["2", "kp2", "keypad_2"],\ K_KP3 => ["3", "kp3", "keypad_3"],\ K_KP4 => ["4", "kp4", "keypad_4"],\ K_KP5 => ["5", "kp5", "keypad_5"],\ K_KP6 => ["6", "kp6", "keypad_6"],\ K_KP7 => ["7", "kp7", "keypad_7"],\ K_KP8 => ["8", "kp8", "keypad_8"],\ K_KP9 => ["9", "kp9", "keypad_9"],\ K_KP_PERIOD => [".", "period", "keypad_period"],\ K_KP_DIVIDE => ["/", "divide", "keypad_divide"],\ K_KP_MULTIPLY => ["*", "multiply", "keypad_multiply"],\ K_KP_MINUS => ["-", "minus", "keypad_minus"],\ K_KP_PLUS => ["+", "plus", "keypad_plus"],\ K_KP_ENTER => ["\n", "enter", "keypad_enter"],\ K_KP_EQUALS => ["=", "equals", "keypad_equals"],\ K_UP => [nil, "up"],\ K_DOWN => [nil, "down"],\ K_RIGHT => [nil, "right"],\ K_LEFT => [nil, "left"],\ K_INSERT => [nil, "insert", "ins"]\ K_HOME => [nil, "home"],\ K_END => [nil, "end"],\ K_PAGEUP => [nil, "page_up", "pgup"]\ K_PAGEDOWN => [nil, "page_down", "pgdn"]\ K_F1 => [nil, "f1", "function_1"],\ K_F2 => [nil, "f2", "function_2"],\ K_F3 => [nil, "f3", "function_3"],\ K_F4 => [nil, "f4", "function_4"],\ K_F5 => [nil, "f5", "function_5"],\ K_F6 => [nil, "f6", "function_6"],\ K_F7 => [nil, "f7", "function_7"],\ K_F8 => [nil, "f8", "function_8"],\ K_F9 => [nil, "f9", "function_9"],\ K_F10 => [nil, "f10", "function_10"],\ K_F11 => [nil, "f11", "function_11"],\ K_F12 => [nil, "f12", "function_12"],\ K_F13 => [nil, "f13", "function_13"],\ K_F14 => [nil, "f14", "function_14"],\ K_F15 => [nil, "f15", "function_15"],\ K_NUMLOCK => [nil, "numlock"],\ K_CAPSLOCK => [nil, "capslock", "caplock"],\ K_SCROLLOCK => [nil, "scroll_lock", "scrollock", "scrolllock"],\ K_LSHIFT => [nil, "left_shift", "lshift"],\ K_RSHIFT => [nil, "right_shift", "rshift"],\ K_LCTRL => [nil, "left_control", "lctrl"],\ K_RCTRL => [nil, "right_control", "rctrl"],\ K_LALT => [nil, "left_alt", "lalt"],\ K_RALT => [nil, "right_alt", "ralt"],\ K_LMETA => [nil, "left_meta", "lmeta"],\ K_RMETA => [nil, "right_meta", "rmeta"],\ K_LSUPER => [nil, "left_super", "lsuper"],\ K_RSUPER => [nil, "right_super", "rsuper"],\ K_MODE => [nil, "mode"],\ K_HELP => [nil, "help"],\ K_PRINT => [nil, "print_screen","prt_scr","print"],\ K_SYSREQ => [nil, "sysrq", "sysreq", "system_request"],\ K_BREAK => [nil, "break"],\ K_MENU => [nil, "menu"],\ K_POWER => [nil, "power"],\ # I have no idea how to get a Euro symbol here! K_EURO => ["\u20ac", "euro"],\ # just K_WORLD_0 to K_WORLD_95 after this K_WORLD_0 => [nil, "world_0"],\ K_WORLD_1 => [nil, "world_1"],\ K_WORLD_2 => [nil, "world_2"],\ K_WORLD_3 => [nil, "world_3"],\ K_WORLD_4 => [nil, "world_4"],\ K_WORLD_5 => [nil, "world_5"],\ K_WORLD_6 => [nil, "world_6"],\ K_WORLD_7 => [nil, "world_7"],\ K_WORLD_8 => [nil, "world_8"],\ K_WORLD_9 => [nil, "world_9"],\ K_WORLD_10 => [nil, "world_10"],\ K_WORLD_11 => [nil, "world_11"],\ K_WORLD_12 => [nil, "world_12"],\ K_WORLD_13 => [nil, "world_13"],\ K_WORLD_14 => [nil, "world_14"],\ K_WORLD_15 => [nil, "world_15"],\ K_WORLD_16 => [nil, "world_16"],\ K_WORLD_17 => [nil, "world_17"],\ K_WORLD_18 => [nil, "world_18"],\ K_WORLD_19 => [nil, "world_19"],\ K_WORLD_20 => [nil, "world_20"],\ K_WORLD_21 => [nil, "world_21"],\ K_WORLD_22 => [nil, "world_22"],\ K_WORLD_23 => [nil, "world_23"],\ K_WORLD_24 => [nil, "world_24"],\ K_WORLD_25 => [nil, "world_25"],\ K_WORLD_26 => [nil, "world_26"],\ K_WORLD_27 => [nil, "world_27"],\ K_WORLD_28 => [nil, "world_28"],\ K_WORLD_29 => [nil, "world_29"],\ K_WORLD_30 => [nil, "world_30"],\ K_WORLD_31 => [nil, "world_31"],\ K_WORLD_32 => [nil, "world_32"],\ K_WORLD_33 => [nil, "world_33"],\ K_WORLD_34 => [nil, "world_34"],\ K_WORLD_35 => [nil, "world_35"],\ K_WORLD_36 => [nil, "world_36"],\ K_WORLD_37 => [nil, "world_37"],\ K_WORLD_38 => [nil, "world_38"],\ K_WORLD_39 => [nil, "world_39"],\ K_WORLD_40 => [nil, "world_40"],\ K_WORLD_41 => [nil, "world_41"],\ K_WORLD_41 => [nil, "world_41"],\ K_WORLD_42 => [nil, "world_42"],\ K_WORLD_43 => [nil, "world_43"],\ K_WORLD_44 => [nil, "world_44"],\ K_WORLD_45 => [nil, "world_45"],\ K_WORLD_46 => [nil, "world_46"],\ K_WORLD_47 => [nil, "world_47"],\ K_WORLD_48 => [nil, "world_48"],\ K_WORLD_49 => [nil, "world_49"],\ K_WORLD_50 => [nil, "world_50"],\ K_WORLD_51 => [nil, "world_51"],\ K_WORLD_52 => [nil, "world_52"],\ K_WORLD_53 => [nil, "world_53"],\ K_WORLD_54 => [nil, "world_54"],\ K_WORLD_55 => [nil, "world_55"],\ K_WORLD_56 => [nil, "world_56"],\ K_WORLD_57 => [nil, "world_57"],\ K_WORLD_58 => [nil, "world_58"],\ K_WORLD_59 => [nil, "world_59"],\ K_WORLD_60 => [nil, "world_60"],\ K_WORLD_61 => [nil, "world_61"],\ K_WORLD_62 => [nil, "world_62"],\ K_WORLD_63 => [nil, "world_63"],\ K_WORLD_64 => [nil, "world_64"],\ K_WORLD_65 => [nil, "world_65"],\ K_WORLD_66 => [nil, "world_66"],\ K_WORLD_67 => [nil, "world_67"],\ K_WORLD_68 => [nil, "world_68"],\ K_WORLD_69 => [nil, "world_69"],\ K_WORLD_70 => [nil, "world_70"],\ K_WORLD_71 => [nil, "world_71"],\ K_WORLD_72 => [nil, "world_72"],\ K_WORLD_73 => [nil, "world_73"],\ K_WORLD_74 => [nil, "world_74"],\ K_WORLD_75 => [nil, "world_75"],\ K_WORLD_76 => [nil, "world_76"],\ K_WORLD_77 => [nil, "world_77"],\ K_WORLD_78 => [nil, "world_78"],\ K_WORLD_79 => [nil, "world_79"],\ K_WORLD_80 => [nil, "world_80"],\ K_WORLD_81 => [nil, "world_81"],\ K_WORLD_82 => [nil, "world_82"],\ K_WORLD_83 => [nil, "world_83"],\ K_WORLD_84 => [nil, "world_84"],\ K_WORLD_85 => [nil, "world_85"],\ K_WORLD_86 => [nil, "world_86"],\ K_WORLD_87 => [nil, "world_87"],\ K_WORLD_88 => [nil, "world_88"],\ K_WORLD_89 => [nil, "world_89"],\ K_WORLD_90 => [nil, "world_90"],\ K_WORLD_91 => [nil, "world_91"],\ K_WORLD_92 => [nil, "world_92"],\ K_WORLD_93 => [nil, "world_93"],\ K_WORLD_94 => [nil, "world_94"],\ K_WORLD_95 => [nil, "world_95"],\ }

Public Class methods

Converts a keyboard symbol (keysym) into a human-readable text string. If either Shift key was being pressed, alphanumeric or punctuation keys will be made uppercase or alternate, based on U.S. keyboard layout. E.g. "a" becomes "A", "1" becomes "!", and "/" becomes "?".

Public Instance methods

Initialize Rubygame. This should be called soon after you require Rubygame, so that everything will work properly.

[Validate]