Window
The game window class. Created internally from multiple sprites.
Superclass
Class Method
Window.new([viewport])
Creates a Window object. Specifies a Viewport (Viewport) when necessary.
Methods
viewport
Gets the Viewport (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
Refers to the bitmap (Bitmap) used as a windowskin.
contents
Refers to the bitmap (Bitmap) used for the window's contents.
stretch
The wallpaper display method. If TRUE, stretches the wallpaper graphic; if FALSE, tiles it. The default value is TRUE.
cursor_rect
The cursor box (Rect). Sets the window's upper left corner using relative coordinates (-16, -16).
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.
Last updated