OptionalisInternalConstructor: booleanProtected_librarySceneKeyWindow.libraryWindow
Protected_outlinerSceneKeyWindow.outlinerWindow
Protected_resourceAn instance to the ResourceDiscussionWindow owned by this instance Editor.ResourceDiscussionWindow
Protected_sceneProtected_sceneProtected_sceneProtected_sceneSceneKeyWindow.sceneWindow
Protected_viewportProtected_viewportSceneKeyWindow.viewportSettingsWindow
ProtectedonEvent callback called whenever a undoable command is redone in this key window UndoRedo stack.
The command being redone.
ProtectedonEvent callback called whenever a undoable command is undone in this key window UndoRedo stack.
The command being undone.
ProtectedonEvent callback called whenever a new undoable command is registered with this key window UndoRedo stack.
The command being added to the stack.
Pings the scene object, highlighting it in its respective editors.
the scene object to ping.
ProtectedsceneEvent callback called whenever the scene becomes dirty or clean.
ProtectedsceneEvent callback called whenever the engine enters in play mode.
ProtectedsceneEvent callback called whenever the engine exists play mode.
ProtectedsceneEvent callback called whenever the engine pauses the play mode.
ProtectedsceneEvent callback called whenever the engine unpauses the play mode.
ProtectedsceneEvent callback called whenever the engine performs a backup of the scene.
Static ReadonlydefaultThe default distance used when spawning objects in front of the camera.
Static ReadonlykThe duration between cloud sync auto save when the scene becomes dirty.
Static ReadonlykSeconds to wait before starting frame capture.
Static ReadonlykStatic ReadonlykStatic ReadonlykStatic ReadonlykReturns the DPI scale factor.
A list of all currently active dockable windows on the key window.
A set of flags that customize the behavior of the key window.
The key window flags.
Sets the height of the window in points.
Sets the height of the window in pixels.
Gets the icon for the window.
The interface marker for the ISceneSelectionStateAware interface.
Determines if the key window's tab is visible.
Determines whether the window has been destroyed or not.
Determines if a drag selection is currently taking place.
Checks whether the window currently has keyboard focus.
Determines if the scene is dirty.
Determines if a scene is fully loaded and active.
VirtualDetermines if a scene is currently being loaded asynchronously.
Determines if the scene is currenty not playing or paused.
Gets the key window which owns this window.
Returns the X position of the window in screen coordinates in points.
An instance to the LibraryWindow owned by this key window.
Specifies the local shortcut context. This context will be automatically disabled whenever the user switches focus from the context.
An instance to the MainCameraWindow owned by this key window.
An instance to the OutlinerWindow owned by this key window.
Gets the window of the owning container. The owning container is window that serves as the host for one or multiple key windows.
Gets the parent EditorWindow.
Gets the RenderWindow associated with this EditorWindow.
The instantiated scene currently being shown on the scene window.
VirtualGets the progress value of the current async scene load in the range [0...1].
Gets the progress value of the current async scene load as preformatted string.
The scene resource handle, for the currently opened scene.
The current scene selection state.
An instance to the SceneWindow owned by this key window.
Specifies the global shortcut context. This context will be always enabled as long as the window is active.
Gets the primary tool bar element.
Returns the X position of the window in screen coordinates in points.
The scene camera that renders the scene from the user's perspective.
An instance to the ViewportSettingsWindow owned by this key window.
Sets the width of the window in points.
Sets the width of the window in pixels.
StaticcurrentGenerates a Component for the currently selected SceneObject, or creates a new one on demand.
The component type to create
OptionalcreateNewSceneObject: booleanTrue to always create a new scene object, otherwise will be assigned to selected.
OptionalautoResolveDiffs: booleanAutomatically resolve the diffs, set to false if you need to resolve manually.
OptionalspawnInfront: booleanTrue to spawn the object infront of the camera, otherwise at scene root.
The newly created component.
Adds a FatComponent to the specified parent SceneObject.
The fat component type to create
Optionalparent: SceneObjectThe parent scene object.
OptionalautoResolveDiffs: booleanAutomatically resolve the diffs, set to false if you need to resolve manually.
OptionalselectNewObject: booleanAutomatically select and focus the object.
OptionalspawnInfront: booleanTrue to spawn the object infront of the camera, otherwise at scene root.
Adds a new SceneObject, or creates a new one on demand.
Optionalparent: SceneObjectThe optional parent scene object.
OptionalautoResolveDiffs: booleanAutomatically resolve the diffs, set to false if you need to resolve manually.
OptionalspawnInfront: booleanTrue to spawn the object infront of the camera, otherwise at scene root.
The newly created scene object.
Adds the specified mesh to the scene as StaticMesh.
The mesh
Optionalparent: SceneObjectOptionalcolliderShapeInformation: anyThe collider Shape Information
OptionalselectNewObject: booleanAdds a template instance for the specified template and returns its newly created root node.
Optionalparent: SceneObjectOptionalselectNewObject: booleanProtectedcreateRecreates the ViewportCamera scene object for the current user.
ProtectedcreateCreates a new EditorWindow for usage on this KeyWindow. If the window was already opened before, the window won't be made visible.
The type of the editor window to be created.
The newly created editor window.
Creates the KeyWindowTutorial instance for the key window.
The KeyWindowTutorial instance or null if the key window does not support tutorials.
This method is called after the onInitialize method, so all buttons and elements should already be created that are required for the tutorial. If the key window requires dynamic resolution of references for the tutorial, the KeyWindowTutorial must be subclasses and the onResolveTutorialElement method must be overridden.
Docks the specified window to the key window. If the window does not exist yet, a new instance will be created.
Type of window to dock.
Optionallocation: EnumValue<DockLocation, number>The dock location.
Optionalreference: DockableEditorWindowThe reference window. The location will determine how and where the new window will be docked.
OptionalrelativeSize: numberThe relative size of the new window. Setting it to 0.5, causes dockwindows to be splitted equally.
Instance of the docked window.
ProtecteddockDocks a new EditorWindow into the given location.
The type of the editor window to be docked.
The relative location to dock the window to, relative to reference.
The reference window. Used to determine the meaning location.
OptionalrelativeSize: numberThe relative size of the docked window. Setting it to 0.5, causes both the first and second window to have the same size.
The editor window instance of the given type.
ProtectedensureProtectedfindFinds in the current loaded scene a Scene Object that represents the Editor Camera.
The Scene Object of the Editor Camera. Null if not found.
Sets the given window type as locked. Disables undocking or docking
of other windows on the same space. Will also hide the tab bar and the window title.
ProtectedfreezeFreezes the dockable editor window of type windowType.
The type of the window to freeze.
Attempts to get a previously opened DockableEditorWindow.
Instance of the open window or null, if it does not exist yet.
Gets the current dockable window layout.
The dockable editor window layout.
ProtectedgetGets an existing EditorWindow for usage on this KeyWindow.
The type of the editor window to be retrieved or created.
The editor window instance of the given type.
VirtualLoads the scene from the specified library path.
The resource path.
VirtualLoads the Scene with the specified uuid.
true if the load was started.
ProtectedonProtectedonOpens a DockableEditorWindow.
Instance of the open window.
ProtectedopenOpens a new EditorWindow for usage on this KeyWindow. If the window is already opened, it will be focused instead.
The type of the editor window to be created.
The newly opened editor window.
VirtualDetermines if the key window must be recreated when the specified module is being reloaded. This is an important task to do if the key window edits classes from the module that is being reloaded. In that case, the key window must be recreated - otherwise, it references outdated classes which results in undefined behavior that can destabilize the application.
The following are possible modules:
The fully qualified name of the module to be reloaded.
VirtualSaves the scene to its resource location. If the scene is currently playing, a prompt appears to stop the scene.
Determines if the user has to confirm the save operation.
OptionalonSuccess: (() => void)Action called when the operation succeeds.
OptionalonFailure: (() => void)Action called when saving the scene failed, or the user declined to save.
Changes the currently active scene.
The new SceneInstance, pass null to unload the scene and release all handles.
OptionalsceneUUID: UUIDThe UUID for the Scene resource.
VirtualSets a predefined dockable editor window layout.
The layout to be set.
ProtectedshowShows a message box if the scene is currently playing. The user can then stop the scene and the onSceneStopped delegate is invoked.
The message box title.
The message box message.
The message box's secondary message
OptionalonSceneStopped: (() => void)The deleagte when the scene has been stopped.
OptionalonCancel: (() => void)The delegate when the action has been canceled
true if the scene is already stopped
ProtectedupdateProtectedupdateProtectedwillStaticallStaticdropDrops the sceneObject to the ground.
The drop is performed using the PhysicsScene of the ´sceneInstance. If no colliders are available below the sceneObject`, the drop cannot be performed.
StaticduplicateDuplicates the sceneObjects to the picked position.
StaticgetGets all open SceneKeyWindow instances.
StaticisStaticmoveMoves the sceneObjects to the picked position.
Protected StaticopenInternal method used by the managed side to open a newly created KeyWindow object instance.
The key window instance.
StaticopenStaticopenOpens a new SceneKeyWindow with the given scene.
A new instance of the scene will be created.
Optionalscene: SceneThe scene to be loaded in the key window.
The newly created key window.
StaticopenOpens a new SceneKeyWindow with the given sceneUUID.
A new instance of the scene will be created.
The newly created key window.
StaticsavePresents the save dialog for each open scene that is dirty. If the scene has already been saved to disk, the dialog will not be dispayed. Instead, the scene will be saved directly. The dialogs are presented in sequential fashion.
True if the user should be prompted to save the scene.
OptionalonSuccess: (() => void)The callback that is invoked when all scenes have been saved.
OptionalonAbort: (() => void)The callback that is invoked when the user aborts the save operation.
OptionalignoreKeyWindows: SceneKeyWindow[]The optional key windows that should be ignored.
StaticstopReadonlyonTriggered when the scene play data state changes, e.g. when the scene starts simulation.
This is a convenience event that abstracts the ScenePlayData events so consumers do not have to manually subscribe and unsubscribe when the SceneKeyWindow loads another scene.
ReadonlyonTriggered before backing up the scene to perform a revertable action such as simulating the scene.
This is a convenience event that abstracts the ScenePlayData events so consumers do not have to manually subscribe and unsubscribe when the SceneKeyWindow loads another scene.
ReadonlyonEvent triggered when the toolbar is being built.
ReadonlyonEvent triggered once the window is resized.
ReadonlyonEvent triggered once the window is moved.
ReadonlyonEvent triggered when the window is closed.
Readonlyon
A KeyWindow type that can open a scene with viewport, outliner and inspectors to edit it.