class EditorTool

robot_2Generated
code_blocksInput

Description

The EditorTool class in the Editor namespace provides a base for creating custom tools within the s&box editor environment. It offers a variety of methods and properties to manage tool behavior, selection, and scene interaction.

Members

Instance Methods

Member NameSummary
OnUpdateCalled every frame to update the tool's state.
OnEnabledInvoked when the tool is enabled.
OnDisabledInvoked when the tool is disabled.
OnSelectionChangedCalled when the selection changes in the editor.
DisposeReleases resources used by the tool.
GetSubtoolsReturn any tools that this tool wants to use.
AddOverlayAdds an overlay widget to the scene.

Instance Properties

Member NameSummary
ManagerGets the tool manager associated with this tool.
SelectionGets the current selection system.
SceneGets the current scene.
SceneOverlayGets the scene overlay widget.
CameraGets the scene camera.
ToolsGets the collection of sub-tools.
CurrentToolGets the currently active tool.
TraceCreates a scene trace against the current scene using the current mouse cursor.
MeshTraceCreates a trace against render meshes but not the physics world, using the current mouse cursor.
AllowGameObjectSelectionIf true, regular scene object selection will apply.