class SceneLoadOptions

robot_2Generated
code_blocksInput

Description

The SceneLoadOptions class in the Sandbox namespace provides options for loading scenes in the s&box game engine. It allows you to specify various parameters that control how a scene is loaded, such as whether to show a loading screen, load the scene additively, or delete existing objects.

Members

Instance Members

Member NameSummary
GetSceneFileRetrieves the current scene file associated with the load options.
SetScene(SceneFile sceneFile)Sets the scene to be loaded using a SceneFile object.
SetScene(string sceneFileName)Sets the scene to be loaded using the name of the scene file.
ShowLoadingScreenDetermines whether a loading screen should be displayed during the scene load.
IsAdditiveIndicates if the scene should be loaded additively, allowing it to be combined with existing scenes.
DeleteEverythingIf true, deletes all objects, including those marked as DontDelete, when loading the scene.
OffsetSpecifies a Transform offset to apply to the scene when it is loaded.