Namespace Unity.Tutorials.Core.Editor

Classes

ActiveToolCriterion

Criterion for checking that a specific Editor Tool is selected.

Allows tutorial author to specify arbitrary completion criterion. Create a new ScriptableObject for your criterion and provide e.g. "bool IsMyCriterionSatisfied()" function as Callback to evalute the criterion. Provide a function that completes your criterion as AutoCompleteCallback if you wish to be able to auto-complete the page.

ArbitraryCriterion.BoolCallback

Needed for serialization.

BaseSetting<T>

Base class for implementing Tutorial Framework settings.

BuildStartedCriterion

Tests if a build has started.

CollectionWrapper

Abstract base class for CollectionWrapper implementations.

CollectionWrapper<T>

Represents an abstract collection of items. The items are stored internally as List. Implement your own concrete collections by inheriting from this class.

ComponentAddedCriterion

Criterion for checking that specific Components are added to a GameObject.

ComponentAddedCriterion.SerializedTypeCollection

Wrapper class for serialization purposes.

ComponentAddedCriterion.TypeAndFutureReference

A SerializedType-FutureObjectReference pair.

Criterion

Base class for Criterion implementations.

CriterionEvent

A generic event for signaling changes in a criterion. Parameters: sender.

EditorWindowCriterion

Criterion for checking that a specific EditorWindow is opened.

EditorWindowProxy

Proxy class for accessing UnityEditor.EditorWindow.

EditorWindowUtils

Utilities for EditorWindows.

FaqEntry

An entry for the FAQ Array in the tutorial and tutorial page. A question with its associated answer

FrameSelectedCriterion

Criterion for checking that a specific object is framed in the Scene view.

FutureObjectReference

Future Object Reference is a reference to a Unity Object that might not exist yet (prefab instance).

GoingBackEvent

Raised when going back to the previous page. Parameters:

sender
the page we were on before beginning to go back

GuiControlSelector

Used the select which GUI controls are unmasked.

HelpPanelHandler

A Window that display the FAQ from the given tutorial and current page

InstantiatePrefabCriterion

Criterion for checking that a specific prefab is instantiated.

InstantiatePrefabCriterion.FuturePrefabInstance

Future prefab instance.

LocalizableString

A serializable string that is localized at run-time.

LocalizableTextAreaAttribute

Same as TextAreaAttribute but used for LocalizableStrings.

MaterialPropertyModifiedCriterion

Criterion for checking a Material's property modification.

MediaContent

Container class for a type of media used in a TutorialPage. Can be either an image, or a video (clip or url)

MediaContentDrawer

Property Drawer for MediaContent properties

MenuItems

Contains the names for the menu items used by the In-Editor Tutorials packages.

ObjectReference

Used to refer Unity Objects in different Criterion implementations.

PackageInstalledCriterion

Criterion for checking that a specific package is installed in the project

PageInitiatedEvent

Raised when a page has been initiated. Parameters:

sender
current page
current page index

PlayModeStateCriterion

Criterion for checking a specific Play Mode state.

PrefabInstanceCountCriterion

Criterion for checking that a specific amount of prefab instances are created.

ProjectMode

Can be used to query the mode of the Tutorial Project.

ProjectSetting<T>

Wrapper for defining IET Project Settings conveniently.

PropertyModificationCriterion

Criterion for checking a property modification.

RequiredSelectionCriterion

Criterion for checking that specific objects are selected.

RichTextParser

Creates UIToolkit elements from a rich text.

RichTextParser.BoldLabel

Text label with bold style

RichTextParser.HyperlinkLabel

Text label for links

RichTextParser.ItalicLabel

Text label with italic style

RichTextParser.ParseErrorLabel

Label for the red parser error displayed where the parsing fails

RichTextParser.TextLabel

Text label for text that wraps per word

RichTextParser.WhiteSpaceLabel

Text label for white space used to indent lines

SceneAddedToBuildCriterion

Criterion for checking that a specific scene is added to the build.

SceneObjectReference

Used to reference different Unity Objects.

SceneObjectReferenceHolder

SceneObjectReference holder.

SceneViewCameraMovedCriterion

Criterion for checking that Scene View Camera has moved.

SceneViewCameraSettings

Used to store and apply scene view camera settings

SerializedType

Used to serialize System.Type using Type.AssemblyQualifiedName.

SerializedTypeFilterAttribute

Use to create type filter for any type.

SerializedTypeFilterAttributeBase

Base class for different SerializedTypeFilter attribute implementations.

SerializedTypeGuiViewFilterAttribute

Specialization for typeof(GUIView).

StringExt

Static helper functions for System.String. Useful for example in LINQ queries.

StringExtensions

Extension methods for System.String.

Tutorial

A container for tutorial pages which implement the tutorial's functionality.

Tutorial.TutorialPageCollection

A wrapper class for serialization purposes.

TutorialContainer

A tutorial container is a collection of tutorial content, and is used to access the actual tutorials in the project.

TutorialContainer.Section

A section/card for starting a tutorial or opening a web page.

TutorialContainerEvent

A generic event for signaling changes in a tutorial container. Parameters: sender.

TutorialEditorUtils

Contains different utilities used in Tutorials custom editors

TutorialEvent

A generic event for signaling changes in a tutorial. Parameters: sender.

TutorialManager

Manages the startup and transitions of tutorials.

TutorialModalWindow

A modal/utility window that can display TutorialWelcomePage as its content. Optionally utilizes masking for modality.

TutorialPage

A TutorialPage consists of TutorialParagraphs which define the content of the page.

TutorialPageEvent

A generic event for signaling changes in a tutorial page. Parameters: sender.

TutorialParagraph

A section of the TutorialPage.

TutorialParagraphCollection

A wrapper class for serialization purposes.

TutorialProjectSettings

Controls start-up and initial settings and behavior of the tutorial project.

TutorialStyles

Controls masking and highlighting styles, and style sheets for the tutorials.

TutorialWelcomePage

Welcome page/dialog for a project shown using TutorialModalWindow.

TutorialWelcomePage.ButtonData

Data for a customizable button.

TutorialWelcomePageEvent

A generic event for signaling changes in a tutorial welcome page. Parameters: sender.

TutorialWindow

The window used to display tutorials and their content

TutorialWindowUtils

Wrapper class for TutorialWindow public APIs

TypedCriterion

Holder for SerializedType and Criterion.

UserSetting<T>

Wrapper for defining IET Preferences (User Settings) conveniently.

UserStartupCode

Runs IET project initialization logic.

Namespace Unity.Tutorials.Core.Editor

Classes

Enums