API Docs for:
Show:

Object_Background Class

Module: vn

A game object used for backgrounds in a scene.

Item Index

Methods

Properties

Methods

restore

(
  • data
)

Restores the game object from a data-bundle.

Parameters:

  • data Object
    • The data-bundle.

toDataBundle

() Object

Serializes the object into a data-bundle.

Returns:

Object:

The data-bundle.

Properties

angle

Number

The rotation-angle of the background in degrees. The rotation center depends on the anchor-point.

animator

vn.Component_Animator

The object's animator-component to execute different kind of animations like move, rotate, etc. on it.

image

String

The object's image used for visual presentation.

mask

gs.Mask

The object's mask to execute masking-effects on it.

srcRect

gs.Rect

The object's source rectangle. It controls which part of the object's image is used for visual presentation.

tone

gs.Tone

The color tone of the object used for the visual presentation.

visual

gs.Component_Sprite

The object's visual-component to display the game object on screen.