Class TutorialParagraph

A section of the TutorialPage.

Inheritance

object

TutorialParagraph

Implements

ISerializationCallbackReceiver

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Tutorials.Core.Editor

Assembly: Unity.Tutorials.Core.Editor.dll

Syntax

[Serializable]
public class TutorialParagraph : ISerializationCallbackReceiver

Fields

Text

Text/description for Narrative/Instruction or button text for SwitchTutorial.

Declaration

[LocalizableTextArea(1, 15)]
public LocalizableString Text

Field Value

Type	Description
LocalizableString

Title

Title for Narrative/Instruction, not applicable for SwitchTutorial currently.

Declaration

public LocalizableString Title

Field Value

Type	Description
LocalizableString

Properties

CodeSample

An optional code sample. If this is empty or null, no code sample zone will be displayed on tutorial

Declaration

public string CodeSample { get; set; }

Property Value

Type	Description
string

Completed

Is this paragraph completed? Applicable if this paragraph's type is Instruction.

Declaration

public bool Completed { get; }

Property Value

Type	Description
bool

Criteria

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

Declaration

public IEnumerable<TypedCriterion> Criteria { get; }

Property Value

Type	Description
IEnumerable<TypedCriterion>

Image

The image if this paragraph's type is Image.

Declaration

public Texture2D Image { get; set; }

Property Value

Type	Description
Texture2D

Media

The media used by the page (image, video or url). This replaced the three separate Image, video and video url properties

Declaration

public MediaContent Media { get; set; }

Property Value

Type	Description
MediaContent

PostInstructionImage

Optional image to display after instruction

Declaration

public Texture2D PostInstructionImage { get; set; }

Property Value

Type	Description
Texture2D

Type

Type of this paragraph.

Declaration

public ParagraphType Type { get; }

Property Value

Type	Description
ParagraphType

Video

The video clip if this paragraph's type is Video.

Declaration

public VideoClip Video { get; set; }

Property Value

Type	Description
VideoClip

VideoUrl

The url for the video if this paragraph's type is Video

Declaration

public string VideoUrl { get; set; }

Property Value

Type	Description
string

Methods

OnAfterDeserialize()

UnityEngine.ISerializationCallbackReceiver override, do not call.

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

UnityEngine.ISerializationCallbackReceiver override, do not call.

Declaration

public void OnBeforeSerialize()

Implements

ISerializationCallbackReceiver