Plane
The Plane class. Planes are special sprites that tile bitmap patterns across the entire screen, and are used to display panoramas and fog.
Superclass
Class Method
Plane.new([viewport])
Creates a Plane object. Specifies a Viewport (Viewport) when necessary.
Methods
dispose
Frees the plane. If the plane has already been freed, does nothing.
disposed?
Returns TRUE if the plane has been freed.
viewport
Retrieves the Viewport (Viewport) specified when the plane was created.
Properties
bitmap
Refers to the bitmap (Bitmap) used in the plane.
visible
Whether the plane can be seen. If TRUE, the plane is visible.
z
The plane's Z-coordinate. The larger this value, the closer to the player the plane will be displayed. If multiple objects share the same Z-coordinate, the more recently created object will be displayed closest to the player.
ox
The X-coordinate of the plane's starting point. Change this value to scroll the plane.
oy
The Y-coordinate of the plane's starting point. Change this value to scroll the plane.
zoom_x
The plane's X-axis zoom level. 1.0 denotes actual pixel size.
zoom_y
The plane's Y-axis zoom level. 1.0 denotes actual pixel size.
opacity
The plane's opacity (0-255). Values out of range are automatically corrected.
blend_type
The plane's blending mode (0: normal, 1: addition, 2: subtraction).
color
The color (Color) to be blended with the plane. Alpha values are used in the blending ratio.
tone
The plane's color tone (Tone).
Last updated