Version: 2021.2
LanguageEnglish
  • C#

LightEditor

class in UnityEditor

/

Inherits from:Editor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The class used to render the Light Editor when a Light is selected in the Unity Editor.

Properties

settingsThe settings helper that can be used for rendering a custom LightEditor.

Public Methods

OnInspectorGUISee Editor.OnInspectorGUI.

Protected Methods

OnDestroySee ScriptableObject.OnDestroy.
OnEnableSee ScriptableObject.OnEnable.
OnSceneGUISee Editor.OnSceneGUI.

Inherited Members

Properties

serializedObjectA SerializedObject representing the object or objects being inspected.
targetThe object being inspected.
targetsAn array of all the object being inspected.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

CreateInspectorGUIImplement this method to make a custom UIElements inspector.
DrawDefaultInspectorDraws the built-in inspector.
DrawHeaderCall this function to draw the header of the editor.
DrawPreviewThe first entry point for Preview Drawing.
GetInfoStringImplement this method to show asset information on top of the asset preview.
GetPreviewTitleOverride this method if you want to change the label of the Preview area.
HasPreviewGUIOverride this method in subclasses if you implement OnPreviewGUI.
OnInteractivePreviewGUIImplement to create your own interactive custom preview. Interactive custom previews are used in the preview area of the inspector and the object selector.
OnPreviewGUIImplement to create your own custom preview for the preview area of the inspector, the headers of the primary editor, and the object selector.
OnPreviewSettingsOverride this method if you want to show custom controls in the preview header.
RenderStaticPreviewOverride this method if you want to render a static preview.
RepaintRedraw any inspectors that shows this editor.
RequiresConstantRepaintChecks if this editor requires constant repaints in its current state.
UseDefaultMarginsOverride this method in subclasses to return false if you don't want default margins.
GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Protected Methods

ShouldHideOpenButtonReturns the visibility setting of the "open" button in the Inspector.

Static Methods

CreateCachedEditorOn return previousEditor is an editor for targetObject or targetObjects. The function either returns if the editor is already tracking the objects, or destroys the previous editor and creates a new one.
CreateCachedEditorWithContextCreates a cached editor using a context object.
CreateEditorMake a custom editor for targetObject or targetObjects.
CreateEditorWithContextMake a custom editor for targetObject or targetObjects with a context object.
DrawFoldoutInspectorDraws the inspector GUI with a foldout header for target.
DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
CreateInstanceCreates an instance of a scriptable object.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

HasFrameBoundsValidates whether custom bounds can be calculated for this editor.
OnGetFrameBoundsGets custom bounds for the target of this editor.
AwakeThis function is called when the ScriptableObject script is started.
OnDisableThis function is called when the scriptable object goes out of scope.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.

Events

finishedDefaultHeaderGUIAn event raised while drawing the header of the Inspector window, after the default header items have been drawn.