newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Editor Classes
SceneEditorSession
chevron_left Editor Classes
class
SceneEditorSession

Constructors

lockSceneEditorSession

Properties

data_objectGameSessiondata_objectHasUnsavedChangesdata_objectIsPlayingdata_objectIsPrefabSessiondata_objectOnFrameTodata_objectScenedata_objectSelectiondata_objectShouldUpdatedata_objectUndoSystem

Methods

functionsAddUndofunctionsBringToFrontfunctionsDeserializeSelectionfunctionsDestroyfunctionsFrameToremove_circleFullUndoSnapshotfunctionsGetSceneFolderfunctionsGetSelectionfunctionsMakeActivelockOnEditedremove_circlePushUndoSelectionremove_circleRecordChangefunctionsReloadfunctionsSavefunctionsSerializeSelectionfunctionsSetPlayingfunctionsStopPlayingfunctionsSuppressUndoSoundsfunctionsTickfunctionsUndoScope

Static Properties

data_objectActivedata_objectAll

Static Methods

functionsCreateDefaultfunctionsCreateFromPathfunctionsResolvefunctionsScope
SceneEditorSession
A SceneEditorSession holds a Scene that is open in the editor. It creates a widget, has a selection and undo system.
class Editor .
Sandbox.Tools

build Constructors 1

SceneEditorSession (scene)

data_object Properties 9

GameSession
GameEditorSession
The game session of this editor session, if playing.
HasUnsavedChanges
bool
IsPlaying
bool
IsPrefabSession
bool
Returns true if this session is editing a prefab
OnFrameTo
Action`1
Scene
Scene
Selection
SelectionSystem
ShouldUpdate
bool
Should we call Sandbox.Scene.EditorTick(System.Single,System.Single) while this session is visible?
UndoSystem
UndoSystem

functions Methods 20

AddUndo (name, undo, redo)
BringToFront ()
Bring this scene tab to the front
DeserializeSelection (selection)
Take a json string created by SerializeSelection and turn it into a selection
Destroy ()
FrameTo (box)
FullUndoSnapshot (title)
obsolete
Take a full scene snapshot for the undo system. This is usually a last resort, if you can't do anything more incremental.
GetSceneFolder ()
SceneFolder
GetSelection ()
IEnumerable`1
MakeActive (bringToFront)
Makes this scene active and brings it to the front
OnEdited ()
PushUndoSelection ()
obsolete
Push the current selection into the undo system
RecordChange (property)
obsolete
Reload ()
Save (saveAs)
SerializeSelection ()
string
Serlialize the current selection to a json string. The aim here is to make something we can transfer back to objects.
SetPlaying (scene)
StopPlaying ()
SuppressUndoSounds ()
IDisposable
Temporarily disables undo/redo sounds.
Tick ()
UndoScope (name)
ISceneUndoScope

data_object Static Properties 2

Active
SceneEditorSession
The editor session that is currently active
All
List`1
All open editor sessions

functions Static Methods 4

CreateDefault ()
SceneEditorSession
Make a new SceneEditorSession with a default scene
CreateFromPath (path)
SceneEditorSession
Opens an editor session from an existing scene or prefab
Resolve (scene)
SceneEditorSession
Resolve a scene to an editor session. If it's a game scene, resolves the parent editor session.
Scope ()
IDisposable
Pushes the active scene to the current scope

Inheritance

SceneEditorSession
GameEditorSession
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.