Interface ITutorialOverlay
Interface for a fullscreen tutorial overlay.
Namespace: SociallyDistant.Core.Shell
Assembly: SociallyDistant.Framework.dll
Syntax
public interface ITutorialOverlay
Properties
CanUserDismiss
Gets or sets a value indicating whether the player may dismiss the tutorial.
Declaration
bool CanUserDismiss { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Dismissed
Gets or sets a callback to execute when the tutorial is dismissed.
Declaration
Action? Dismissed { get; set; }
Property Value
| Type | Description |
|---|---|
| Action |
Instructions
Gets or sets text to display as instructions to the player.
Declaration
string Instructions { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Title
Gets or sets a headline to show next to the highlighted screen area.
Declaration
string Title { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
Dismiss()
Dismiss the tutorial.
Declaration
void Dismiss()