Class: LiteRGSS::Viewport

Inherits:
Object
  • Object
show all
Defined in:
LiteRGSS.rb

Overview

Class that describes a surface of the screen where texts and sprites are shown (with some global effect)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#new(width, height) ⇒ Viewport #new(x, width, height) ⇒ Viewport #new(x, y, width, height) ⇒ Viewport

Create a new Viewport

Parameters:

  • x (Integer)

    x position of the surface

  • y (Integer)

    y position of the surface

  • width (Integer)

    width of the surface

  • height (Integer)

    height of the surface

Instance Attribute Details

#colorColor

The aditive Color effect of the viewport

Returns:

#oxInteger

The offset x of the viewport's contents

Returns:

  • (Integer)

#oyInteger

The offset y of the viewport's contents

Returns:

  • (Integer)

#rectRect

The surface of the viewport on the screen

Returns:

#toneTone

The Tone effect of the viewport

Returns:

#visibleBoolean

Viewport content visibility

Returns:

  • (Boolean)

#zNumeric

The viewport z property

Returns:

  • (Numeric)

Instance Method Details

#__index__Integer

Return the viewport “index” (used to know if the viewport has been created after an other sprite or viewport when z are the same

Returns:

  • (Integer)

#disposeself

Dispose the viewport (and all its sprites/texts)

Returns:

  • (self)

#disposed?Boolean

Indicate if the viewport is disposed or not

Returns:

  • (Boolean)

#reload_stackself

Reload the viewport sprite stack Used for Z processing

Returns:

  • (self)

#update

Does nothing (RGSS compatibility)