Class InstructionsParagraph

A paragraph of a TutorialPage used to display a series of instructions. The block will initially show a blue icon, then a green checkmark when the instructions are performed. The success state is evaluated using the paragraph's Criterias().

Inheritance

object

Object

ScriptableObject

ParagraphBase

InstructionsParagraph

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Tutorials.Editor.Paragraphs

Assembly: Unity.Tutorials.Editor.dll

Syntax

public class InstructionsParagraph : ParagraphBase

Fields

Text

The text that makes the paragraph.

Declaration

[LocalizableTextArea(3, 15)]
public LocalizableString Text

Field Value

Type	Description
LocalizableString

Title

The title displayed at the top of the paragraph.

Declaration

public LocalizableString Title

Field Value

Type	Description
LocalizableString

Properties

Criteria

The completion criteria if this paragraph's type is Instruction.

Declaration

public IEnumerable<TypedCriterion> Criteria { get; }

Property Value

Type	Description
IEnumerable<TypedCriterion>

Methods

CanMask()

Override to return true when inheriting from this class, if the Paragraph type can mask the editor. MaskSetting will be used for that paragraph type.

Declaration

public override bool CanMask()

Returns

Type	Description
bool	If true, this paragraph provide MaskSettings to be applied.

Overrides

ParagraphBase.CanMask()

Criterias()

List of criteria to satisfy in order to complete the paragraph.

Declaration

public override TypedCriterionCollection Criterias()

Returns

Type	Description
TypedCriterionCollection	The criteria list.

Overrides

ParagraphBase.Criterias()

GetDisplayRoot()

Creates the VisualElement representing the paragraph for usage in the Tutorials window. To customise how the Paragraph appears in the Inspector of its TutorialPage SO, use a custom PropertyDrawer.

Declaration

public override VisualElement GetDisplayRoot()

Returns

Type	Description
VisualElement	The VisualElement that contains the paragraph.

Overrides

ParagraphBase.GetDisplayRoot()

HasCriteria()

Whether the paragraph type has criterias that need to be satisfied to complete the instructions.

Declaration

public override bool HasCriteria()

Returns

Type	Description
bool	If the paragraph has criterias at all.

Overrides

ParagraphBase.HasCriteria()

IsCompleted()

Returns whether the paragraph has been completed.

Declaration

public override bool IsCompleted()

Returns

Type	Description
bool	The paragraph completion state.

Overrides

ParagraphBase.IsCompleted()

OnCriterionUpdated()

Callback that fires when one of the criteria has been updated.

Declaration

public override void OnCriterionUpdated()

Overrides

ParagraphBase.OnCriterionUpdated()