Skip to main content

FullSceneDescription

                            
                              
                                interface 
                                FullSceneDescription
                                
                                  
                                    
                                      T
                                       = 
                                      unknown
                                    
                                  
                                
                                extends 
                                
                                  
                                    
                                      SceneDescription
                                      
                                        
                                          
                                            T
                                          
                                        
                                      
                                    
                                  
                                
                              
                              

Describes a complete scene together with the meta file.

Type Parameters

  • T = unknown

    The type of the configuration object.

Properties

config

                            
                              
                                config
                                : 
                                T
                              
                              

Configuration object.

Inherited from SceneDescription.config

experimentalFeatures


klass

                            
                              
                                klass
                                : 
                                SceneConstructor
                                
                                  
                                    
                                      T
                                    
                                  
                                
                              
                              

The class used to instantiate the scene.

Inherited from SceneDescription.klass

logger

                            
                              
                                logger
                                : 
                                Logger
                              
                              

meta

                            
                              
                                meta
                                : 
                                ObjectMetaField
                                
                                  
                                    
                                      
                                        
                                          
                                            seed
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  any
                                                
                                                
                                                  number
                                                
                                              
                                            
                                             = 
                                            ...
                                          
                                          
                                            timeEvents
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  SerializedTimeEvent
                                                  []
                                                
                                                
                                                  SerializedTimeEvent
                                                  []
                                                
                                              
                                            
                                             = 
                                            ...
                                          
                                          
                                            version
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  any
                                                
                                                
                                                  number
                                                
                                              
                                            
                                             = 
                                            ...
                                          
                                        
                                      
                                    
                                  
                                
                              
                              
Inherited from SceneDescription.meta

name

                            
                              
                                name
                                : 
                                string
                              
                              

onReplaced

                            
                              
                                onReplaced
                                : 
                                ValueDispatcher
                                
                                  
                                    
                                      FullSceneDescription
                                      
                                        
                                          
                                            T
                                          
                                        
                                      
                                    
                                  
                                
                              
                              

playback

                            
                              
                                playback
                                : 
                                PlaybackStatus
                              
                              

plugins

                            
                              
                                plugins
                                ?: 
                                
                                  
                                    
                                      string
                                    
                                    
                                      Plugin
                                    
                                  
                                
                                []
                              
                              

A list of plugins to include in the project.

Inherited from SceneDescription.plugins

resolutionScale

                            
                              
                                resolutionScale
                                : 
                                number
                              
                              

sharedWebGLContext

                            
                              
                                sharedWebGLContext
                                : 
                                SharedWebGLContext
                              
                              

size

                            
                              
                                size
                                : 
                                Vector2
                              
                              

stack

                            
                              
                                stack
                                ?: 
                                string
                              
                              

The stack trace at the moment of creation.

Inherited from SceneDescription.stack

timeEventsClass


variables

                            
                              
                                variables
                                : 
                                Variables