Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

ScriptableWizard.errorString

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
public var errorString: string;
public string errorString;

Description

Allows you to set the error text of the wizard.

See Also: ScriptableWizard.OnWizardUpdate


Error String on a Scriptable Wizard Window.

	// C#
	// Creates a simple Wizard window and prints an error 
	// string until you set the number to 5
	
	using UnityEngine;
	using UnityEditor;
	
	public class ErrorString : ScriptableWizard {
		public int number = 0;
		[MenuItem ("Example/Show Error String")]
		static void CreateWindow() {
			ScriptableWizard.DisplayWizard("Error String example", typeof(ErrorString), "Close");	
		}
		void OnWizardUpdate() {
			helpString = "Set The number to 5";
			if(number != 5)
				errorString = "The number has to be set to 5!";
			else
				errorString = "";	
		}
	}