Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ScriptableWizard

class in UnityEditor

/

Inherits from: EditorWindow

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

Sumbission failed

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

Close

Cancel

Switch to Manual

Description

Derive from this class to create an editor wizard.

Editor wizards are typically opened using a menu item.

#pragma strict
// Creates a simple wizard that lets you create a Light GameObject
// or if the user clicks in "Apply", it will set the color of the currently
// object selected to red
public class WizardCreateLight extends ScriptableWizard {
	public var range: float = 500;
	public var color: Color = Color.red;
	@MenuItem("GameObject/Create Light Wizard")
	static function CreateWizard() {
		ScriptableWizard.DisplayWizard.<WizardCreateLight>("Create Light", "Create", "Apply");
		//ScriptableWizard.DisplayWizard<WizardCreateLight>("Create Light", "Create");
	}
	function OnWizardCreate() {
		var go: GameObject = new GameObject("New Light");
		var lt: Light = go.AddComponent.<Light>();
		lt.range = range;
		lt.color = color;
	}
	function OnWizardUpdate() {
		helpString = "Please set the color of the light!";
	}
	// When the user pressed the "Apply" button OnWizardOtherButton is called.
	function OnWizardOtherButton() {
		if (Selection.activeTransform != null) {
			var lt: Light = Selection.activeTransform.GetComponent.<Light>();
			if (lt != null) {
				lt.color = Color.red;
			}
		}
	}
}
// Creates a simple wizard that lets you create a Light GameObject
// or if the user clicks in "Apply", it will set the color of the currently
// object selected to red

using UnityEditor; using UnityEngine;

public class WizardCreateLight : ScriptableWizard { public float range = 500; public Color color = Color.red;

[MenuItem ("GameObject/Create Light Wizard")] static void CreateWizard () { ScriptableWizard.DisplayWizard<WizardCreateLight>("Create Light", "Create", "Apply"); //If you don't want to use the secondary button simply leave it out: //ScriptableWizard.DisplayWizard<WizardCreateLight>("Create Light", "Create"); }

void OnWizardCreate () { GameObject go = new GameObject ("New Light"); Light lt = go.AddComponent<Light>(); lt.range = range; lt.color = color; }

void OnWizardUpdate () { helpString = "Please set the color of the light!"; }

// When the user pressed the "Apply" button OnWizardOtherButton is called. void OnWizardOtherButton () { if (Selection.activeTransform != null) { Light lt = Selection.activeTransform.GetComponent<Light>();

if (lt != null) { lt.color = Color.red; } } } }

Variables

createButtonNameAllows you to set the text shown on the create button of the wizard.
errorStringAllows you to set the error text of the wizard.
helpStringAllows you to set the help text of the wizard.
isValidAllows you to enable and disable the wizard create button, so that the user can not click it.
otherButtonNameAllows you to set the text shown on the optional other button of the wizard. Leave this parameter out to leave the button out.

Public Functions

DrawWizardGUIWill be called for drawing contents when the ScriptableWizard needs to update its GUI.

Protected Functions

DrawWizardGUIWill be called for drawing contents when the ScriptableWizard needs to update its GUI.

Static Functions

DisplayWizardCreates a wizard.

Messages

OnWizardCreateThis is called when the user clicks on the Create button.
OnWizardOtherButtonAllows you to provide an action when the user clicks on the other button.
OnWizardUpdateThis is called when the wizard is opened or whenever the user changes something in the wizard.

Inherited members

Static Variables

focusedWindowThe EditorWindow which currently has keyboard focus. (Read Only)
mouseOverWindowThe EditorWindow currently under the mouse cursor. (Read Only)

Variables

autoRepaintOnSceneChangeDoes the window automatically repaint whenever the scene has changed?
maximizedIs this window maximized.
maxSizeThe maximum size of this window.
minSizeThe minimum size of this window.
positionThe position of the window in screen space.
titleContentThe GUIContent used for drawing the title of EditorWindows.
wantsMouseMoveDoes the GUI in this editor window want MouseMove events?
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

BeginWindowsMark the beginning area of all popup windows.
CloseClose the editor window.
EndWindowsClose a window group started with EditorWindow.BeginWindows.
FocusMoves keyboard focus to this EditorWindow.
RemoveNotificationStop showing notification message.
RepaintMake the window repaint.
SendEventSends an Event to a window.
ShowShow the EditorWindow.
ShowAsDropDownShow window with dropdown behaviour (e.g. window is closed when it loses focus) and having.
ShowAuxWindowShow the editor window in the auxiliary window.
ShowNotificationShow a notification message.
ShowPopupUsed for popup style windows.
ShowUtilityShow the EditorWindow as a floating utility window.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

FocusWindowIfItsOpenFocuses the first found EditorWindow of specified type if it is open.
GetWindowReturns the first EditorWindow of type t which is currently on the screen.
GetWindowWithRectReturns the first EditorWindow of type t which is currently on the screen.
DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.
CreateInstanceCreates an instance of a scriptable object with className.

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

OnDestroyOnDestroy is called when the EditorWindow is closed.
OnFocusCalled when the window gets keyboard focus.
OnGUIImplement your own editor GUI here.
OnHierarchyChangeCalled whenever the scene hierarchy has changed.
OnInspectorUpdateOnInspectorUpdate is called at 10 frames per second to give the inspector a chance to update.
OnLostFocusCalled when the window loses keyboard focus.
OnProjectChangeCalled whenever the project has changed.
OnSelectionChangeCalled whenever the selection has changed.
UpdateCalled 100 times per second on all visible windows.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961