API Docs for:
Show:

Object_Character Class

Module: vn

A game object for a visual novel character.

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

animator

vn.Component_Animator

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

behavior

vn.Component_CharacterBehavior

The character's behavior component which contains the character-specific logic.

expression

Object

The character's expression(database-record)

image

String

The object's image used for visual presentation.

mask

gs.Mask

The object's mask.

mirror

Boolean

Indicates if the object's visual presentation should be mirrored horizontally.

rid

Number

The ID of the character-record used.

srcRect

gs.Rect

The object's source rectangle on screen.

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.

zIndex

Number

The object's z-index.