API Docs for:
Show:

CommonEventParameter Class

Module: gs

Stores a single common event parameter definition.

Properties

booleanVariable

gs.Variable

Stores boolean-variable if type is "Switch"

label

String

Text which is displayed to the user in auto-generated UI form.

numberList

gs.CommonEventParameterNumberList

Stores a number list if "Number List" is selected as numberValueType.

numberValueType

String

If type is "Number" it describes which kind of number value is stored.

  • number - A regular number value
  • numberList - A value from a popup-list
  • characters - A character id
  • characterExpressions - A character expression id
  • cgGallery - A CG Galler entry id
  • commonEvents - A common event id
  • animations - An animation id

numberVariable

gs.Variable

Stores number-variable if type is "Number"

stringValueType

String

If type is "Text" it describes which kind of text value is stored.

  • text - A regular text value
  • sceneId - The UID of a scene.
  • Graphics/Characters - The name of a graphic resource from Graphics/Characters folder
  • Graphics/Backgrounds - The name of a graphic resource from Graphics/Backgrounds folder
  • Graphics/Pictures - The name of a graphic resource from Graphics/Pictures folder
  • Graphics/Transitions - The name of a graphic resource from Graphics/Transitions folder
  • Graphics/Fonts - The name of a font resource from Graphics/Fonts folder
  • Audio/Sounds - The name of an audio resource from Audio/Sounds folder
  • Audio/Music - The name of an audio resource from Audio/Music folder
  • Movies - The name of an video resource from Movies folder
  • Live2D - The name of an Live2D resource from Live2D folder

stringVariable

gs.Variable

Stores string-variable if type is "Text"

type

Number

The parameter type.

  • 0 = Text
  • 1 = Number
  • 2 = Switch