API Docs for:
Show:

Document Class

Module: gs

All data stored by Visual Novel Maker follows the document-format except graphic- and audio resources. All documents can be found in data-folder of the project. Each document is stored as .json file using its own unique identifier (UID) as file name.

Properties

items

Object

Contains the actual data of the document. It is important to keep the data in a serializable/deserializable state.

items.name

String

The document's display name.

items.type

String

The document's type. That field is necessary because Visual Novel Maker needs to know what how to handle this document. The following public document types are available:

  • vn.scene
    • - Scene
  • vn.chapter
    • - Chapter
  • data_record
    • - Database Record
  • game_script
    • - Game Script in Script-Editor
  • script
    • - Script in Extension Editor
  • event_command
    • - Scene Command for Scene-Editor/View
  • DataRecordView
    • - Database Category + View.
  • custom_view
    • - Custom View/Form for use in other views/forms/scene-commands.
  • application_language_bundle
    • - Language Bundle to translate custom plugins into different languages.
  • language_profile
    • - Language Profile definition for the game's supported languages.
  • language_bundle
    • - Language Bundle which contains all texts of a game language.
  • custom_strings_bundle
    • - Contains localized custom texts for use in game scripts.
  • global_variables
    • - Stores all global variable definitions.
  • persistent_variables
    • - Stores all persistent variable definitions.
  • settings
    • - Stores project specific settings
  • extension
    • - Holds data about an installed plugin.

lastModificationTime

Number

Timestamp of the document's last modification. Its always zero and only present for internal reasons.

uid

String

The unique identifier (UID) of the document. This ID must also be used as the name for the .json file.