Object_Scene Class
A scene object manages a whole visual novel scene with backgrounds, characters, messages, etc.
Item Index
Properties
- backgroundContainer
- backgrounds
- behavior
- characterContainer
- characters
- choiceTimer
- commonEventContainer
- events
- hotspotContainer
- hotspots
- interpreter
- messageAreaContainer
- messageAreas
- pictureContainer
- pictures
- preparing
- sceneData
- settings
- tempSettings
- textContainer
- texts
- timerContainer
- timers
- videoContainer
- videos
- viewportContainer
- visible
- visible_
Properties
backgroundContainer
gs.Object_Container
Contains all background objects of the scene.
backgrounds
gs.Object_Background
All backgrounds as array. That is the same like accessing the subObjects of the container object.
behavior
gs.Component_GameSceneBehavior
The behavior-component for the VN scene specific behavior.
characterContainer
gs.Object_Container
Contains all character objects of the scene.
characters
gs.Object_Character
All character objects as array. That is the same like accessing the subObjects of the container object.
choiceTimer
gs.Object_Timer
A timer object used for choices with time-limit.
commonEventContainer
gs.Object_Container
Contains all common events which are running parallel/auto to the scene.
events
gs.Component_EventEmitter
An event-emitter to emit events.
hotspotContainer
gs.Object_Container
Contains all hotspot objects of the scene.
hotspots
gs.Object_Hotspot
All hotspot objects as array. That is the same like accessing the subObjects of the container object.
interpreter
gs.Component_CommandInterpreter
An interpreter to execute the commands of scene.
messageAreaContainer
gs.Object_Container
Contains all message areas of the scene.
messageAreas
vn.MessageArea
All message areas as array.
pictureContainer
gs.Object_Container
Contains all picture objects of the scene.
pictures
gs.Object_Picture
All picture objects as array. That is the same like accessing the subObjects of the container object.
preparing
Boolean
Indicates that the scene is still in prepare-state and not ready yet.
sceneData
Object
Contains all data necessary to construct the scene.
settings
Object
The game settings.
tempSettings
Object
Temporary settings like skip, etc.
textContainer
gs.Object_Container
Contains all text objects of the scene.
texts
gs.Object_Text
All text objects as array. That is the same like accessing the subObjects of the container object.
timerContainer
gs.Object_Container
Contains all interval timers.
timers
gs.Object_IntervalTimer
All interval timer objects as array. That is the same like accessing the subObjects of the container object.
videoContainer
gs.Object_Container
Contains all video objects of the scene.
videos
gs.Object_Video
All video objects as array. That is the same like accessing the subObjects of the container object.
viewportContainer
gs.Object_Container
Contains all viewports which are used to create multi-layered screen effects.
visible
Boolean
Indicates if the UI layout is visible.