ISceneEditorSessionclass

object→ISceneEditorSession
Namespace
global
Assembly
Sandbox.Engine
Declaration
public abstract interface Sandbox.Scene.ISceneEditorSession

Methods9

Showing 9 methods

public virtual void AddSelectionUndo()PUBLICVIRTUALOBSOLETE

You have changed the editor's selection, add a new undo entry

Obsolete: This API member is obsolete.

Returns:void—

public virtual void AddUndo(string name, System.Action undo, System.Action redo)PUBLICVIRTUAL

Add a new undo entry

ParameterTypeDescription
namestring—
undoAction—
redoAction—
Returns:void—

public virtual void FrameTo(BBox& modreq(System.Runtime.InteropServices.InAttribute) box)PUBLICVIRTUAL

ParameterTypeDescription
boxBBox& modreq(InAttribute)—
Returns:void—

public virtual Editor.SceneFolder GetSceneFolder()PUBLICVIRTUAL

Get the folder for this scene. This is a folder in which we can store assets that are referenced by this scene. Things like envmap textures, lightmaps, baked data, etc.

Returns:SceneFolder—

public virtual System.Collections.Generic.IEnumerable`1<object> GetSelection()PUBLICVIRTUALOBSOLETE

Gets the current selection from the editor

Obsolete: Use Selection

Returns:IEnumerable<object>—

public virtual void OnEditLog(string name, object source)PUBLICVIRTUALOBSOLETE

Obsolete: This API member is obsolete.

ParameterTypeDescription
namestring—
sourceobject—
Returns:void—

public virtual void RecordChange(Sandbox.SerializedProperty property)PUBLICVIRTUALOBSOLETE

Tell undo about this property change

Obsolete: This API member is obsolete.

ParameterTypeDescription
propertySerializedProperty—
Returns:void—

public virtual void Save(bool forceSaveAs)PUBLICVIRTUAL

Save this scene to disk

ParameterTypeDescription
forceSaveAsbool—
Returns:void—

Properties6

Showing 6 properties

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

True if this scene has unsaved changes

Returns:bool—

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

Whether this is the active editor session. Used for selection-driven previews.

Returns:bool—

public virtual Sandbox.BaseFileSystem Sandbox.Scene.ISceneEditorSession.TransientFilesystem { get; set; }PUBLICVIRTUALGETSET

Get the filesystem in which temporary files can be created. These files can be used (and shipped) by a package, but won't be stored in source control. This is usually used for files that are expected to be re-generated at runtime by the package itself.

Returns:BaseFileSystem—

On this page