Window

The game window class. Created internally from multiple sprites.

Superclass

Class Method

Window.new([x, y, width, height]) (RGSS3)

Creates a window object. Specifies position and size as necessary.

Methods

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 general rule, this method is called once per frame.

move(x, y, width, height) (RGSS3)

Sets the x-coordinate, y-coordinate, width, and height all at once.

open? (RGSS3)

Returns true if the window is completely open (openness == 255).

close? (RGSS3)

Returns true if the window is completely closed (openness == 0).

Properties

windowskin

Refers to the bitmap (Bitmap) used as a window skin.

Skin specifications are nearly identical to those in the previous version (VX). Resource standards: See the detailed information on window skins.

contents

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

cursor_rect

The cursor box (Rect).

Specifies a rectangle with coordinates based on the window's contents. (RGSS3)

viewport

Refers to the viewport (Viewport) associated with the window.

active

The cursor's blink status. If TRUE, the cursor is blinking. The default is TRUE.

visible

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

arrows_visible (RGSS3)

The visibility of scrolling arrows. If TRUE, the arrows are visible. The default is TRUE.

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. The default is FALSE.

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 the 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 default is 100 (RGSS3).

ox

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

Also affects the cursor. (RGSS3)

oy

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

Also affects the cursor. (RGSS3)

padding (RGSS3)

The size of the padding between the window's frame and contents. The default value is 12. (RGSS3)

padding_bottom (RGSS3)

The padding for the bottom. Must be set after padding because it is changed along with it.

opacity

The window's opacity (0-255). Out-of-range values are automatically corrected. The default value is 255.

back_opacity

The window background's opacity (0-255). Out-of-range values are automatically corrected. The default value is 192 (RGSS3).

contents_opacity

The opacity of the window's contents (0-255). Out-of-range values are automatically corrected. The default value is 255.

openness

The openness of the window (from 0 to 255). Out-of-range values are automatically corrected.

By changing this value in stages from 0 (completely closed) to 255 (completely open), it is possible to create an animation of the window opening and closing. If the openness is less than 255, the contents of the window will not be displayed. The default value is 255.

tone (RGSS3)

The color (Tone) of the window's background.