Plane

The Plane class. Planes are special sprites that tile bitmap patterns across the entire screen and are used to display parallax backgrounds and so on.

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.

Properties

bitmap

Refers to the bitmap (Bitmap) used in the plane.

viewport

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

visible

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

z

The plane's z-coordinate. The larger the 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). Out-of-range values 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).