Skip to content

Game.Tutorials.TutorialPhaseType

Assembly: Assembly-CSharp
Namespace: Game.Tutorials

Type: enum

Base: System.Enum

Summary:
Represents the visual presentation type used for a tutorial phase in the game's tutorial system. Determines how the tutorial content is shown to the player (e.g., a tooltip/balloon, a card near UI, or a centered card). Useful for modders implementing or extending tutorial definitions and UI handling.

Fields

  • Balloon
    A tooltip-style balloon typically anchored to a UI element or world object to point out something.

  • Card
    A card-style panel (usually placed near the relevant UI or on screen edge) used to show tutorial text and controls.

  • CenterCard
    A centered card UI shown in the middle of the screen for important or blocking tutorial messages.

Properties

  • This enum has no properties. Enums are value types and only expose their named constants.

Constructors

  • This enum has no user-defined constructors. As with all enums, the compiler provides the underlying value semantics and default initialization (the first member has value 0 unless explicitly set).

Methods

  • This enum has no instance methods. Standard System.Enum methods (e.g., ToString(), GetValues()) are available via the base type.

Usage Example

// Example: choosing presentation based on phase type
void ShowTutorialPhase(TutorialPhaseType phase, string text)
{
    switch (phase)
    {
        case TutorialPhaseType.Balloon:
            ShowBalloonTooltip(text);
            break;
        case TutorialPhaseType.Card:
            ShowSideCard(text);
            break;
        case TutorialPhaseType.CenterCard:
            ShowCenteredCard(text);
            break;
    }
}

// Example: storing / reading numeric value
int rawValue = (int)TutorialPhaseType.Card;
TutorialPhaseType fromValue = (TutorialPhaseType)rawValue;