Game.Tutorials.TutorialMode
Assembly:
Game (assembly containing the game's runtime types)
Namespace: Game.Tutorials
Type:
public enum
Base:
System.Enum (underlying type: System.Int32)
Summary:
Represents the different tutorial modes used by the game's tutorial system. This enum is used to select or report which tutorial sequence or state should be active (or that no special tutorial is running).
Fields
-
Default = 0
Represents the default state (no special tutorial sequence). Typically used when normal gameplay should run without tutorial overlays or steps. -
Intro = 1
Represents an introductory/tutorial sequence (single-step or general introduction). Used for standard intro flows where a single tutorial sequence is presented. -
ListIntro = 2
Represents the start/introduction of a list-based tutorial sequence. Useful when tutorials present a list of items or steps and this is the beginning state. -
ListOutro = 3
Represents the end/outro of a list-based tutorial sequence. Used when concluding a list-style tutorial.
Properties
- (None)
This enum defines named constants and has no properties.
Constructors
- (None)
Enums do not expose constructors in typical use. Instances are created by assigning one of the named constants.
Methods
- (None)
No methods are defined on the enum itself. Use standard enum methods from System.Enum if needed (e.g., ToString, Enum.Parse).
Usage Example
using Game.Tutorials;
public class TutorialManager
{
private TutorialMode currentMode = TutorialMode.Default;
public void StartMode(TutorialMode mode)
{
currentMode = mode;
switch (mode)
{
case TutorialMode.Default:
// Normal gameplay
break;
case TutorialMode.Intro:
// Start intro sequence
break;
case TutorialMode.ListIntro:
// Start list-based tutorial (intro)
break;
case TutorialMode.ListOutro:
// Play outro/cleanup for list-based tutorial
break;
}
}
public bool IsTutorialActive()
{
return currentMode != TutorialMode.Default;
}
}