rgss 0.0.1

data/lib/rgss/stubs/rect.rb

@@ -0,0 +1,324 @@
+
+module RGSS
+
+
+  ##
+  # @abstract
+  class IVec2
+
+    ##
+    # Creates a new instance of the {IVec2} class.
+    # @overload initialize
+    #
+    # @overload initialize(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    # @overload initialize(other)
+    #   @param other [IVec2]
+    def initialize(*args)
+    end
+
+    def [](index)
+    end
+
+    def []=(index, value)
+    end
+
+    ##
+    # Creates an array instance that represents this object.
+    # @return [Array(Integer, Integer)] The newly created Array.
+    def to_a
+    end
+
+    ##
+    # Creates a hash instance that represents this object.
+    # @return [Hash{Symbol => Integer}] The newly created Hash.
+    def to_h
+    end
+
+    def +(other)
+    end
+
+    def -(other)
+    end
+
+    def set(x, y)
+    end
+
+    def empty?
+    end
+
+    alias_method :add, :+
+    alias_method :subtract, :-
+  end
+
+
+  class Point < IVec2
+
+    ##
+    # @return [Integer]
+    attr_accessor :x
+
+    ##
+    # @return [Integer]
+    attr_accessor :y
+  end
+
+  class Size < IVec2
+
+    ##
+    # @return [Integer]
+    attr_accessor :width
+
+    ##
+    # @return [Integer]
+    attr_accessor :height
+
+    ##
+    #
+    # @overload offset(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload offset(other)
+    #   @param other [IVec2]
+    #
+    # @return [Point]
+    def offset
+    end
+
+    ##
+    #
+    # @overload offset!(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload offset!(other)
+    #   @param other [IVec2]
+    #
+    # @return [self]
+    def offset!
+    end
+  end
+
+  ##
+  # Stores a set of four integers that represent the location and size of a rectangle, with the top-left at 0, 0.
+  #
+  # @note All relevant methods implemented in `Object` (i.e. `#dup`, `#clone`, Marshalling, equality) have also been
+  #   properly implemented/overridden, but have been omitted from the documentation for brevity.
+  class Rect
+
+    ##
+    # @return [Integer] the location of the top-left corner on the x-axis.
+    attr_accessor :x
+
+    ##
+    # @return [Integer] the location of the top-left corner on the y-axis.
+    attr_accessor :y
+
+    ##
+    # @return [Integer] the size of the rectangle on the x-axis.
+    attr_accessor :width
+
+    ##
+    # @return [Integer] the size of the rectangle on the y-axis.
+    attr_accessor :height
+
+    ##
+    # @return [Point] the location of the top-left corner of the rectangle.
+    attr_accessor :location
+
+    ##
+    # @return [Size] the size (width and height) of the rectangle.
+    attr_accessor :size
+
+    ##
+    # @return [Integer] the location of the left edge of the rectangle on the x-axis.
+    attr_reader :left
+
+    ##
+    # @return [Integer] the location of the top edge of the rectangle on the y-axis.
+    attr_reader :top
+
+    ##
+    # @return [Integer] the location of the right edge of the rectangle on the x-axis.
+    attr_reader :right
+
+    ##
+    # @return [Integer] the location of the bottom edge of the rectangle on the y-axis.
+    attr_reader :bottom
+
+    ##
+    # Creates and returns a new {Rect} with all values defaulted to `0`.
+    #
+    # @return [Rect] The newly created rectangle.
+    def self.empty
+    end
+
+    ##
+    # Creates a new instance of the {Rect} class.
+    #
+    # @overload initialize
+    #   Creates a new empty rectangle.
+    #
+    # @overload initialize(location, size)
+    #   Creates a new rectangle with the specified location and size.
+    #   @param location [Point]
+    #   @param size [Size]
+    #
+    # @overload initialize(x, y, width, height)
+    #   Creates a new rectangle with the specified dimensions.
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #   @param width [Numeric]
+    #   @param height [Numeric]
+    def initialize(*args)
+    end
+
+    ##
+    # Creates a new {Rect} by the specified edges.
+    #
+    # @param left [Numeric] the location of the rectangles left edge on the x-axis.
+    # @param top [Numeric] the location of the rectangles top edge on the y-axis.
+    # @param right [Numeric] the location of the rectangles right edge on the x-axis.
+    # @param bottom [Numeric] the location of the rectangles bottom edge on the y-axis.
+    #
+    # @return [Rect] the newly created {Rect} instance.
+    def self.ltrb(left, right, top, bottom)
+    end
+
+    ##
+    # Provides access to the rectangle components by index.
+    # @param index [Numeric] the index of the component (x, y, width, height) to retrieve.
+    # @return [Integer] the value of the specified component.
+    # @raise [IndexError] if index is less than `0` or greater than `3`.
+    def [](index)
+    end
+
+    ##
+    # Provides access to the rectangle components by index.
+    # @param index [Numeric] the index of the component (x, y, width, height) to set.
+    # @return [Integer] the value that was set.
+    # @raise [IndexError] if index is less than `0` or greater than `3`.
+    def []=(index, value)
+    end
+
+    def set(x, y, width, height)
+    end
+
+    ##
+    #
+    # @return [Boolean]
+    def empty?
+    end
+
+    ##
+    # @overload contains?(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload contains?(point)
+    #   @param point [Point]
+    #
+    # @overload contains?(rect)
+    #   @param rect [Rect]
+    #
+    # @return [Boolean]
+    def contains?(*args)
+    end
+
+    ##
+    # @overload inflate(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload inflate(amount)
+    #   @param amount [IVec2]
+    #
+    # @return [Rect]
+    def inflate(*args)
+    end
+
+    ##
+    # @overload inflate!(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload inflate!(amount)
+    #   @param amount [IVec2]
+    #
+    # @return [self]
+    def inflate!(*args)
+    end
+
+    ##
+    #
+    # @param other [Rect]
+    #
+    # @return [Rect]
+    def intersect(other)
+    end
+
+    ##
+    #
+    # @param other [Rect]
+    #
+    # @return [self]
+    def intersect!(other)
+    end
+
+    ##
+    # @param other [Rect]
+    #
+    # @return [Boolean]
+    def intersects?(other)
+    end
+
+    ##
+    # @overload offset(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload offset(amount)
+    #   @param amount [IVec2]
+    #
+    # @return [Rect]
+    def offset(*args)
+    end
+
+    ##
+    # @overload offset(x, y)
+    #   @param x [Numeric]
+    #   @param y [Numeric]
+    #
+    # @overload offset(amount)
+    #   @param amount [IVec2]
+    #
+    # @return [self]
+    def offset!(*args)
+    end
+
+    ##
+    # Creates an array instance that represents this object.
+    # @return [Array(Integer, Integer, Integer, Integer)] The newly created Array.
+    def to_a
+    end
+
+    ##
+    # Creates a hash instance that represents this object.
+    # @return [Hash{Symbol => Integer}] The newly created Hash.
+    def to_h
+    end
+
+    alias_method :include?, :contains?
+  end
+
+
+
+
+
+
+end
+
+
+

data/lib/rgss/stubs/rpg.rb

@@ -0,0 +1,267 @@
+module RGSS
+
+
+  module Input
+
+    def self.trigger?(sym)
+    end
+
+    def self.press?(sym)
+    end
+
+    def self.release?(sym)
+    end
+
+    def self.none?(sym)
+    end
+
+    def self.repeat?(sym)
+    end
+
+    def self.cursor
+    end
+
+    def self.create_cursor(source)
+    end
+
+    def self.scroll_x
+    end
+
+    def self.scroll_y
+    end
+
+    def self.bind(sym, keys = nil, mouse = nil, gamepad = nil)
+    end
+
+
+    KEY_UNKNOWN = -1
+    KEY_SPACE = 32
+    KEY_APOSTROPHE = 39
+    KEY_COMMA = 44
+    KEY_MINUS = 45
+    KEY_PERIOD = 46
+    KEY_SLASH = 47
+    KEY_0 = 48
+    KEY_1 = 49
+    KEY_2 = 50
+    KEY_3 = 51
+    KEY_4 = 52
+    KEY_5 = 53
+    KEY_6 = 54
+    KEY_7 = 55
+    KEY_8 = 56
+    KEY_9 = 57
+    KEY_SEMICOLON = 59
+    KEY_EQUAL = 61
+    KEY_A = 65
+    KEY_B = 66
+    KEY_C = 67
+    KEY_D = 68
+    KEY_E = 69
+    KEY_F = 70
+    KEY_G = 71
+    KEY_H = 72
+    KEY_I = 73
+    KEY_J = 74
+    KEY_K = 75
+    KEY_L = 76
+    KEY_M = 77
+    KEY_N = 78
+    KEY_O = 79
+    KEY_P = 80
+    KEY_Q = 81
+    KEY_R = 82
+    KEY_S = 83
+    KEY_T = 84
+    KEY_U = 85
+    KEY_V = 86
+    KEY_W = 87
+    KEY_X = 88
+    KEY_Y = 89
+    KEY_Z = 90
+    KEY_LEFT_BRACKET = 91
+    KEY_BACKSLASH = 92
+    KEY_RIGHT_BRACKET = 93
+    KEY_GRAVE_ACCENT = 96
+    KEY_WORLD_1 = 161
+    KEY_WORLD_2 = 162
+    KEY_ESCAPE = 256
+    KEY_ENTER = 257
+    KEY_TAB = 258
+    KEY_BACKSPACE = 259
+    KEY_INSERT = 260
+    KEY_DELETE = 261
+    KEY_RIGHT = 262
+    KEY_LEFT = 263
+    KEY_DOWN = 264
+    KEY_UP = 265
+    KEY_PAGE_UP = 266
+    KEY_PAGE_DOWN = 267
+    KEY_HOME = 268
+    KEY_END = 269
+    KEY_CAPS_LOCK = 280
+    KEY_SCROLL_LOCK = 281
+    KEY_NUM_LOCK = 282
+    KEY_PRINT_SCREEN = 283
+    KEY_PAUSE = 284
+    KEY_F1 = 290
+    KEY_F2 = 291
+    KEY_F3 = 292
+    KEY_F4 = 293
+    KEY_F5 = 294
+    KEY_F6 = 295
+    KEY_F7 = 296
+    KEY_F8 = 297
+    KEY_F9 = 298
+    KEY_F10 = 299
+    KEY_F11 = 300
+    KEY_F12 = 301
+    KEY_F13 = 302
+    KEY_F14 = 303
+    KEY_F15 = 304
+    KEY_F16 = 305
+    KEY_F17 = 306
+    KEY_F18 = 307
+    KEY_F19 = 308
+    KEY_F20 = 309
+    KEY_F21 = 310
+    KEY_F22 = 311
+    KEY_F23 = 312
+    KEY_F24 = 313
+    KEY_F25 = 314
+    KEY_KP_0 = 320
+    KEY_KP_1 = 321
+    KEY_KP_2 = 322
+    KEY_KP_3 = 323
+    KEY_KP_4 = 324
+    KEY_KP_5 = 325
+    KEY_KP_6 = 326
+    KEY_KP_7 = 327
+    KEY_KP_8 = 328
+    KEY_KP_9 = 329
+    KEY_KP_DECIMAL = 330
+    KEY_KP_DIVIDE = 331
+    KEY_KP_MULTIPLY = 332
+    KEY_KP_SUBTRACT = 333
+    KEY_KP_ADD = 334
+    KEY_KP_ENTER = 335
+    KEY_KP_EQUAL = 336
+    KEY_LEFT_SHIFT = 340
+    KEY_LEFT_CONTROL = 341
+    KEY_LEFT_ALT = 342
+    KEY_LEFT_SUPER = 343
+    KEY_RIGHT_SHIFT = 344
+    KEY_RIGHT_CONTROL = 345
+    KEY_RIGHT_ALT = 346
+    KEY_RIGHT_SUPER = 347
+    KEY_MENU = 348
+    KEY_LAST = KEY_MENU
+
+    MOD_SHIFT = 0x0001
+    MOD_CONTROL = 0x0002
+    MOD_ALT = 0x0004
+    MOD_SUPER = 0x0008
+    MOD_CAPS_LOCK = 0x0010
+    MOD_NUM_LOCK = 0x0020
+
+    MOUSE_BUTTON_1 = 0
+    MOUSE_BUTTON_2 = 1
+    MOUSE_BUTTON_3 = 2
+    MOUSE_BUTTON_4 = 3
+    MOUSE_BUTTON_5 = 4
+    MOUSE_BUTTON_6 = 5
+    MOUSE_BUTTON_7 = 6
+    MOUSE_BUTTON_8 = 7
+    MOUSE_BUTTON_LAST = MOUSE_BUTTON_8
+    MOUSE_BUTTON_LEFT = MOUSE_BUTTON_1
+    MOUSE_BUTTON_RIGHT = MOUSE_BUTTON_2
+    MOUSE_BUTTON_MIDDLE = MOUSE_BUTTON_3
+
+    JOYSTICK_1 = 0
+    JOYSTICK_2 = 1
+    JOYSTICK_3 = 2
+    JOYSTICK_4 = 3
+    JOYSTICK_5 = 4
+    JOYSTICK_6 = 5
+    JOYSTICK_7 = 6
+    JOYSTICK_8 = 7
+    JOYSTICK_9 = 8
+    JOYSTICK_10 = 9
+    JOYSTICK_11 = 10
+    JOYSTICK_12 = 11
+    JOYSTICK_13 = 12
+    JOYSTICK_14 = 13
+    JOYSTICK_15 = 14
+    JOYSTICK_16 = 15
+    JOYSTICK_LAST = JOYSTICK_16
+
+    GAMEPAD_BUTTON_A = 0
+    GAMEPAD_BUTTON_B = 1
+    GAMEPAD_BUTTON_X = 2
+    GAMEPAD_BUTTON_Y = 3
+    GAMEPAD_BUTTON_LEFT_BUMPER = 4
+    GAMEPAD_BUTTON_RIGHT_BUMPER = 5
+    GAMEPAD_BUTTON_BACK = 6
+    GAMEPAD_BUTTON_START = 7
+    GAMEPAD_BUTTON_GUIDE = 8
+    GAMEPAD_BUTTON_LEFT_THUMB = 9
+    GAMEPAD_BUTTON_RIGHT_THUMB = 10
+    GAMEPAD_BUTTON_DPAD_UP = 11
+    GAMEPAD_BUTTON_DPAD_RIGHT = 12
+    GAMEPAD_BUTTON_DPAD_DOWN = 13
+    GAMEPAD_BUTTON_DPAD_LEFT = 14
+    GAMEPAD_BUTTON_LAST = GAMEPAD_BUTTON_DPAD_LEFT
+
+    GAMEPAD_BUTTON_CROSS = GAMEPAD_BUTTON_A
+    GAMEPAD_BUTTON_CIRCLE = GAMEPAD_BUTTON_B
+    GAMEPAD_BUTTON_SQUARE = GAMEPAD_BUTTON_X
+    GAMEPAD_BUTTON_TRIANGLE = GAMEPAD_BUTTON_Y
+
+    GAMEPAD_AXIS_LEFT_X = 0
+    GAMEPAD_AXIS_LEFT_Y = 1
+    GAMEPAD_AXIS_RIGHT_X = 2
+    GAMEPAD_AXIS_RIGHT_Y = 3
+    GAMEPAD_AXIS_LEFT_TRIGGER = 4
+    GAMEPAD_AXIS_RIGHT_TRIGGER = 5
+    GAMEPAD_AXIS_LAST = GAMEPAD_AXIS_RIGHT_TRIGGER
+
+  end
+
+
+  module Graphics
+
+    def self.fps
+    end
+
+    def self.render
+    end
+  end
+
+  module Game
+
+    class << self
+
+      attr_accessor :title
+      attr_accessor :fullscreen
+    end
+
+    def self.init
+    end
+
+    def self.create(width, height, title, **opts)
+    end
+
+    def self.center
+    end
+
+    def self.close(flag = true)
+    end
+
+    def self.closing?
+    end
+
+    def self.terminate
+    end
+  end
+
+end