Sceneclass

public System.IDisposable AddHook(Sandbox.GameObjectSystem.Stage stage, int order, System.Action action, string className, string description)PUBLIC

Call this method on this stage. This returns a disposable that will remove the hook when disposed.

public System.IDisposable BatchGroup()PUBLIC

Collects anything inside into a batch group. A batchgroup is used with GameObject and Components to make sure that their OnEnable/OnDisable and other callbacks are called in a deterministic order, and that they can find each other during creation. `Sandbox.GameObject.NetworkSpawn` calls will also be batched.

public void ClearUnsavedChanges()PUBLICOBSOLETE

Obsolete: This API member is obsolete.

public static Sandbox.Scene CreateEditorScene()PUBLICSTATIC

public Sandbox.GameObject CreateObject(bool enabled = True)PUBLIC

Create a GameObject on this scene. This doesn't require the scene to be the active scene.

public virtual void Deserialize(System.Text.Json.Nodes.JsonObject node, Sandbox.GameObject.DeserializeOptions option)PUBLICVIRTUAL

public virtual void Destroy()PUBLICVIRTUAL

Destroy this scene. After this you should never use it again.

public void EditorDraw()PUBLIC

public void EditorTick(float timeNow, float timeDelta)PUBLIC

protected virtual override void Finalize()PROTECTEDVIRTUALOVERRIDE

public System.Collections.Generic.IEnumerable`1<Sandbox.GameObject> FindAllWithTag(string tag)PUBLIC

Find objects with tag

public System.Collections.Generic.IEnumerable`1<Sandbox.GameObject> FindAllWithTags(System.Collections.Generic.IEnumerable`1<string> tags)PUBLIC

public void GameTick(double timeDelta = 0.1)PUBLIC

public T Get()PUBLIC

Gets the first object found of this type. This could be a component or a GameObjectSystem, or other stuff in the future.

public bool IsBBoxVisibleToConnection(Sandbox.Connection target, BBox box)PUBLIC

Are these bounds visible to the specified `Sandbox.Connection`?

public bool IsPointVisibleToConnection(Sandbox.Connection target, Vector3 position)PUBLIC

Is a position visible to the specified `Sandbox.Connection`?

public bool LoadFromFile(string filename)PUBLIC

Load from the provided file name. This will not load the scene for other clients in a multiplayer session, you should instead use `Sandbox.Game.ChangeScene(Sandbox.SceneLoadOptions)` if you want to bring other clients.

public void ProcessDeletes()PUBLIC

Delete any GameObjects waiting to be deleted

public System.IDisposable Push()PUBLIC

Push this scene as the active scene, for a scope

public virtual void RunEvent(System.Action`1<T> action, Sandbox.FindMode find = 69)PUBLICVIRTUAL

public virtual System.Text.Json.Nodes.JsonObject Serialize(Sandbox.GameObject.SerializeOptions options = null)PUBLICVIRTUAL

public System.Text.Json.Nodes.JsonObject SerializeProperties()PUBLIC

public void StartLoading()PUBLIC

public static System.Collections.Generic.IEnumerable`1<Sandbox.Scene> Sandbox.Scene.All { get; set; }PUBLICSTATICGETSET

All active non-editor scenes.

public Sandbox.CameraComponent Sandbox.Scene.Camera { get; set; }PUBLICGETSET

public Sandbox.SceneWorld Sandbox.Scene.DebugSceneWorld { get; set; }PUBLICGETSET

public string Sandbox.Scene.Description { get; set; }PUBLICGETSETOBSOLETE

Obsolete: please use the SceneInformation component

public Sandbox.GameObjectDirectory Sandbox.Scene.Directory { get; set; }PUBLICGETSET

public Sandbox.Scene.ISceneEditorSession Sandbox.Scene.Editor { get; set; }PUBLICGETSET

Allows access to the scene's editor session from the game. This will be null if there is no editor session active on this scene.

public float Sandbox.Scene.FixedDelta { get; set; }PUBLICGETSET

public float Sandbox.Scene.FixedUpdateFrequency { get; set; }PUBLICGETSETFIXED TICKOBSOLETE

Obsolete: Moved to Sandbox.ProjectSettings.PhysicsSettings

public bool Sandbox.Scene.HasUnsavedChanges { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Use Scene.Editor.HasUnsavedChanges

public bool Sandbox.Scene.IsEditor { get; set; }PUBLICGETSET

public bool Sandbox.Scene.IsFixedUpdate { get; set; }PUBLICGETSETFIXED TICK

public bool Sandbox.Scene.IsLoading { get; set; }PUBLICGETSET

Return true if we're in an initial loading phase

public virtual bool Sandbox.Scene.IsValid { get; set; }PUBLICVIRTUALGETSET

Returns true if this scene has not been destroyed

public int Sandbox.Scene.MaxFixedUpdates { get; set; }PUBLICGETSETFIXED TICKOBSOLETE

Obsolete: Moved to Sandbox.ProjectSettings.PhysicsSettings

public Sandbox.Navigation.NavMesh Sandbox.Scene.NavMesh { get; set; }PUBLICGETSET

public float Sandbox.Scene.NetworkFrequency { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Moved to ProjectSettings.Networking.UpdateRate

public float Sandbox.Scene.NetworkRate { get; set; }PUBLICGETSET

One divided by ProjectSettings.Networking.UpdateRate.

public int Sandbox.Scene.PhysicsSubSteps { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Moved to Sandbox.ProjectSettings.PhysicsSettings

public Sandbox.PhysicsWorld Sandbox.Scene.PhysicsWorld { get; set; }PUBLICGETSET

public Sandbox.RenderAttributes Sandbox.Scene.RenderAttributes { get; set; }PUBLICGETSET

Global render attributes accessible on any renderable in this Scene.

public Sandbox.SceneWorld Sandbox.Scene.SceneWorld { get; set; }PUBLICGETSET

The scene world, holding this scene's renderables. Created on first access, so scenes that never render anything (like prefab caches or tests) never create one.

public Sandbox.GameResource Sandbox.Scene.Source { get; set; }PUBLICGETSET

public bool Sandbox.Scene.ThreadedAnimation { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Unused. Animation is always threaded.

public float Sandbox.Scene.TimeScale { get; set; }PUBLICGETSET

public string Sandbox.Scene.Title { get; set; }PUBLICGETSETOBSOLETE

Obsolete: please use the SceneInformation component

public Sandbox.SceneTrace Sandbox.Scene.Trace { get; set; }PUBLICGETSET

public bool Sandbox.Scene.UseFixedUpdate { get; set; }PUBLICGETSETFIXED TICKOBSOLETE

Obsolete: Moved to Sandbox.ProjectSettings.PhysicsSettings

public Sandbox.Volumes.VolumeSystem Sandbox.Scene.Volumes { get; set; }PUBLICGETSET

Allows quickly finding components that have a volume

public bool Sandbox.Scene.WantsSystemScene { get; set; }PUBLICGETSET

If true we'll additive load the system scene when this scene is loaded. Defaults to true. You might want to disable this for specific scenes, like menu scenes etc.