📜
RGSS Reference Manual
  • RGSS Reference Manual
  • RGSS Specifications
  • Ruby Syntax
    • Syntax and Expressions
    • Variables and Constants
    • Literals
    • Operator Expressions
    • Control Structures
    • Method Calls
    • Class and Method Definitions
  • Standard Library
    • Built-in Functions
    • Built-in Variables
    • Built-in Classes
      • Object
        • Array
        • Exception
        • FalseClass
        • Hash
        • IO
          • File
        • MatchData
        • Module
          • Class
        • NilClass
        • Numeric
          • Integer
            • Bignum
            • Fixnum
          • Float
        • Range
        • Proc
        • Regexp
        • String
        • Symbol
        • Time
        • TrueClass
    • Built-in Modules
      • Comparable
      • Enumerable
      • Errno
      • FileTest
      • GC
      • Kernel
      • Marshal
      • Math
    • Built-in Exception Classes
  • Game Library
    • RGSS Built-in Functions
    • RGSS Built-in Classes
      • Bitmap
      • Color
      • Font
      • Plane
      • Rect
      • Sprite
      • Table
      • Tilemap
      • Tone
      • Viewport
      • Window
      • RGSSError
      • RPG::Sprite
      • RPG::Weather
    • RGSS Built-in Modules
      • Audio
      • Graphics
      • Input
      • RPG
      • RPG::Cache
    • RPGXP Data Structures
      • RPG::Map
      • RPG::MapInfo
      • RPG::Event
      • RPG::Event::Page
      • RPG::Event::Page::Condition
      • RPG::Event::Page::Graphic
      • RPG::EventCommand
      • RPG::MoveRoute
      • RPG::MoveCommand
      • RPG::Actor
      • RPG::Class
      • RPG::Class::Learning
      • RPG::Skill
      • RPG::Item
      • RPG::Weapon
      • RPG::Armor
      • RPG::Enemy
      • RPG::Enemy::Action
      • RPG::Troop
      • RPG::Troop::Member
      • RPG::Troop::Page
      • RPG::Troop::Page::Condition
      • RPG::State
      • RPG::Animation
      • RPG::Animation::Frame
      • RPG::Animation::Timing
      • RPG::Tileset
      • RPG::CommonEvent
      • RPG::System
      • RPG::System::Words
      • RPG::System::TestBattler
      • RPG::AudioFile
  • Appendix
    • Regular Expression
    • sprintf Format
Powered by GitBook
On this page
  • Superclass
  • Class Method
  • Window.new([viewport])
  • Methods
  • viewport
  • dispose
  • disposed?
  • update
  • Properties
  • windowskin
  • contents
  • stretch
  • cursor_rect
  • active
  • visible
  • pause
  • x
  • y
  • width
  • height
  • z
  • ox
  • oy
  • opacity
  • back_opacity
  • contents_opacity
  1. Game Library
  2. RGSS Built-in Classes

Window

The game window class. Created internally from multiple sprites.

PreviousViewportNextRGSSError

Last updated 1 year ago

Superclass

Class Method

Window.new([viewport])

Creates a Window object. Specifies a Viewport () when necessary.

Methods

viewport

Gets the Viewport () specified when the window was created.

dispose

Frees the window. If the window has already been freed, does nothing.

disposed?

Returns TRUE if the window has been freed.

update

Refreshes the cursor blink and the pause graphic animation. As a rule, this method is called once per frame.

Properties

windowskin

contents

stretch

The wallpaper display method. If TRUE, stretches the wallpaper graphic; if FALSE, tiles it. The default value is TRUE.

cursor_rect

active

Cursor blink status. If TRUE, the cursor is blinking.

visible

The window's visibility. If TRUE, the window is visible.

pause

The pause graphic's visibility. This is a symbol that appears in the message window when waiting for the player to press a button. If TRUE, the graphic is visible.

x

The window's X-coordinate.

y

The window's Y-coordinate.

width

The window's width.

height

The window's height.

z

The window's Z-coordinate. The larger this value, the closer to the player the window will be displayed. If multiple objects share the same Z-coordinate, the more recently created object will be displayed closest to the player. The Z-coordinate of the window's contents equals the window background's Z-coordinate plus 2.

ox

The X-coordinate of the starting point of the window's contents. Change this value to scroll the window's contents.

oy

The Y-coordinate of the starting point of the window's contents. Change this value to scroll the window's contents.

opacity

The window's opacity (0-255). Values out of range are automatically corrected.

back_opacity

The window background's opacity (0-255). Values out of range are automatically corrected.

contents_opacity

The opacity of the window's contents (0-255). Values out of range are automatically corrected.

Refers to the bitmap () used as a windowskin.

Refers to the bitmap () used for the window's contents.

The cursor box (). Sets the window's upper left corner using relative coordinates (-16, -16).

Object
Viewport
Viewport
Bitmap
Bitmap
Rect