Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

ScriptableWizard.DisplayWizard

public static function DisplayWizard(title: string): T;

Parameters

T The class implementing the wizard. It has to derive from ScriptableWizard.
title The title shown at the top of the wizard window.

Returns

T The wizard.

Description

Creates a wizard.

When the user hits the Create button OnWizardCreate function will be called. DisplayWizard will only show one wizard for every wizard class.


Simple Wizard Window that copies a GameObject several times.

	// C#
	// Simple Wizard that clones an object.
	
	using UnityEngine;
	using UnityEditor;
	using System.Collections;
	
	public class ScriptableWizardDisplayWizard : ScriptableWizard {
		
		public GameObject ObjectToCopy = null;
		public int numberOfCopies = 2;
		[MenuItem ("Example/Show DisplayWizard usage")]
		static void CreateWindow() {
			// Creates the wizard for display
			ScriptableWizard.DisplayWizard("Copy an object.", 
				typeof(ScriptableWizardDisplayWizard), 
				"Copy!");
		}
		void OnWizardUpdate() {
			helpString = "Clones an object a number of times";
			if(!ObjectToCopy) {
				errorString = "Please assign an object";
				isValid = false;
			} else {
				errorString = "";
				isValid = true;	
			}
		}
		void OnWizardCreate () {
			for(int i = 0; i < numberOfCopies; i++)
				Instantiate(ObjectToCopy, Vector3.zero, Quaternion.identity);
		}
	}
public static function DisplayWizard(title: string, createButtonName: string): T;
public static function DisplayWizard(title: string, createButtonName: string, otherButtonName: string): T;

Parameters

T The class implementing the wizard. It has to derive from ScriptableWizard.
title The title shown at the top of the wizard window.
class The class implementing the wizard. It has to derive from ScriptableWizard.
createButtonName The text shown on the create button.
otherButtonName The text shown on the optional other button. Leave this parameter out to leave the button out.

Returns

T The wizard.

Description

Creates a wizard.

When the user hits the Create button OnWizardCreate function will be called. DisplayWizard will only show one wizard for every wizard class.

public static function DisplayWizard(title: string, klass: Type, createButtonName: string = "Create", otherButtonName: string = ""): ScriptableWizard;

Description

TODO.