EditorTool
class in
UnityEditor.EditorTools
/
Inherits from:ScriptableObject
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
Description
Use this class to implement custom editor tools. This is the base class from which all editor tools are inherited.
Properties
gridSnapEnabled | Use this property to allow the current EditorTool to enable/disable grid snapping. |
target | The object being inspected. |
targets | An array of the objects being inspected. |
toolbarIcon | The icon and tooltip for this custom editor tool. If this function is not implemented, the toolbar displays the Inspector icon for the target type. If no target type is defined, the toolbar displays the Tool Mode icon. |
Public Methods
IsAvailable | Checks whether the custom editor tool is available based on the state of the editor. |
OnActivated | Invoked after this EditorTool becomes the active tool. |
OnToolGUI | Use this method to implement a custom editor tool. |
OnWillBeDeactivated | Invoked before this EditorTool stops being the active tool. |
Inherited Members
Properties
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
Operators
bool | Does 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
Awake | This function is called when the ScriptableObject script is started. |
OnDestroy | This function is called when the scriptable object will be destroyed. |
OnDisable | This function is called when the scriptable object goes out of scope. |
OnEnable | This function is called when the object is loaded. |
OnValidate | Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector. |
Reset | Reset to default values. |