Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

ScriptableWizard.helpString

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

public var helpString: string;
public string helpString;

Description

Allows you to set the help text of the wizard.

See Also: ScriptableWizard.OnWizardUpdate


Help string on a ScriptableWizard window.

#pragma strict
// Creates a simple Wizard window and prints the HelpString
// in the Wizard window.
public class HelpString extends ScriptableWizard {
	@MenuItem("Example/Show Help String")
	static function CreateWindow() {
		ScriptableWizard.DisplayWizard("", HelpString, "Finish");
	}
	function OnWizardUpdate() {
		helpString = "This string describes what the Scriptable Wizard does.";
	}
}
// Creates a simple Wizard window and prints the HelpString
// in the Wizard window.

using UnityEngine; using UnityEditor;

public class HelpString : ScriptableWizard { [MenuItem ("Example/Show Help String")] static void CreateWindow() { ScriptableWizard.DisplayWizard("", typeof(HelpString), "Finish"); } void OnWizardUpdate() { helpString = "This string describes what the Scriptable Wizard does."; } }