SceneCommand Class
Describes a scene command. Commands are used in scene view to define logic/flow.
Item Index
Properties
defaultValue
String
The default values for the command used if the command is new created like if the users drags a new command from the toolbox to scene content.
expanded
Boolean
Indicates if the command is in expanded state by default.
Default: false
expandedView
Object
The expanded view contains GSQ items which are only visible if the user expands
the command by clicking on the expand-arrow icon. It should be used for settings
which are not so important or which are not changing very often.
The expanded view is separated into columns and each column has a set of sections shown belows each other. Each section can have an own header-text to describe
its content a bit more. Each section contains a set of rows and each row contains a set of items which
are displayed next to each other.
Example:
"expandedView": { "columns": [ { "sections": [ { "label": "Header Text", "rows": [ { "items": [] } ] } ] } ] }
fullSizeItems
GSQItem[]
Full-Size items are only visible if the user expands the command by clicking on the expand-arrow icon. They displayed below each other and each items takes up the full width of the command-size. There is also no label displayed. In regular full-size items are used for multi-line text input for commands like "Show Message".
group
String
The group/category where the new command should be added to. You can use any of the already existing categories or just define your own like „My Custom Commands“. If the specified category doesn't exist a new category is created.
id
String
The unique identifier for the command. It can be any kind of text as long as it is unique. So you don’t need to follow any kind of format or syntax. However, the default syntax is [module].[name] like commands which are more specific for visual novels using vn.[name] while more general commands are using gs.[name]. However, you shouldn’t use vn.[name] or gs.[name] to avoid confusion since they are only for built-in commands.
inlineImage
Object
Defines an inline-image displayed on the top-right of the command. In regular this is used to display the character's image on commands like "Join Scene" or "Show Message" so the user can recognize faster which character is acting.
Default: false
inlineImage.folder
String
The resource folder used to load the inline-image from.
inlineImage.formula
String
A formula to calculate the resource used for the inline-image. It has one parameter "p" containing the current command parameters/data. The formula must return a resource object like: { name: "MyPicture" }.
quickItems
GSQItem[]
Array of GSQ items to let the user input the necessary data needed by the command. Quick items are always visible to allow quick changes. They should be used for items which often needs to be changed or which are important.