Class TutorialParagraph
A section of the TutorialPage.
Namespace: Unity.InteractiveTutorials
Syntax
[Serializable]
public class TutorialParagraph : ISerializationCallbackReceiverFields
Text
Text/description for Narrative/Instruction or button text for SwitchTutorial.
Declaration
[LocalizableTextArea(1, 15)]
public LocalizableString TextField Value
| Type | Description |
|---|---|
| LocalizableString |
Title
Title for Narrative/Instruction, not applicable for SwitchTutorial currently.
Declaration
public LocalizableString TitleField Value
| Type | Description |
|---|---|
| LocalizableString |
Properties
completed
TODO 2.0 Deprecated, will be renamed to Completed
Declaration
public bool completed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Completed
Is this paragraph completed? Applicable if this paragraph's type is Instruction.
Declaration
public bool Completed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
criteria
The completion criteria if this paragraph's type is Instruction.
Declaration
public IEnumerable<TypedCriterion> criteria { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<TypedCriterion> |
Description
TODO 2.0 Deprecated, remove
Declaration
[Obsolete]
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| String |
icons
TODO 2.0 Deprecated, remove.
Declaration
public IEnumerable<InlineIcon> icons { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<InlineIcon> |
image
TODO 2.0 remove
Declaration
public Texture2D image { get; set; }Property Value
| Type | Description |
|---|---|
| Texture2D |
Image
The image if this paragraph's type is Image.
Declaration
public Texture2D Image { get; set; }Property Value
| Type | Description |
|---|---|
| Texture2D |
InstructionText
TODO 2.0 Deprecated, remove
Declaration
[Obsolete]
public string InstructionText { get; set; }Property Value
| Type | Description |
|---|---|
| String |
InstructionTitle
TODO 2.0 Deprecated, remove
Declaration
[Obsolete]
public string InstructionTitle { get; set; }Property Value
| Type | Description |
|---|---|
| String |
maskingSettings
The masking settings for this paragraph.
Declaration
public MaskingSettings maskingSettings { get; }Property Value
| Type | Description |
|---|---|
| MaskingSettings |
summary
TODO 2.0 Deprecated, remove
Declaration
[Obsolete]
public string summary { get; set; }Property Value
| Type | Description |
|---|---|
| String |
type
TODO 2.0 remove
Declaration
public ParagraphType type { get; }Property Value
| Type | Description |
|---|---|
| ParagraphType |
Type
Type of this paragraph.
Declaration
public ParagraphType Type { get; }Property Value
| Type | Description |
|---|---|
| ParagraphType |
video
TODO 2.0 remove
Declaration
public VideoClip video { get; set; }Property Value
| Type | Description |
|---|---|
| VideoClip |
Video
The video clip if this paragraph's type is Video.
Declaration
public VideoClip Video { get; set; }Property Value
| Type | Description |
|---|---|
| VideoClip |
Methods
OnAfterDeserialize()
UnityEngine.ISerializationCallbackReceiver override, do not call.
Declaration
public void OnAfterDeserialize()Implements
OnBeforeSerialize()
UnityEngine.ISerializationCallbackReceiver override, do not call.
Declaration
public void OnBeforeSerialize()