Table of Contents

Class Tutorial

Namespace
AO
Assembly
CoreAssembly.dll
public class Tutorial
Inheritance
Tutorial
Inherited Members
Extension Methods

Fields

ConditionChecks

public static Dictionary<string, Func<Player, string, object, bool>> ConditionChecks

Field Value

Dictionary<string, Func<Player, string, object, bool>>

OnStepComplete

public static Dictionary<string, Action<Player, string>> OnStepComplete

Field Value

Dictionary<string, Action<Player, string>>

Properties

Id

public string Id { get; set; }

Property Value

string

Methods

AddStep(TutorialStepDefinition)

public TutorialStep AddStep(TutorialStepDefinition definition)

Parameters

definition TutorialStepDefinition

Returns

TutorialStep

Create(string)

Tutorials must be created in a System.Awake() function.

public static extern Tutorial Create(string id)

Parameters

id string

Returns

Tutorial

DrawHand(string, Rect)

public static extern void DrawHand(string id, Rect target_rect)

Parameters

id string
target_rect Rect

DrawText(string, string)

public static extern bool DrawText(string id, string text)

Parameters

id string
text string

Returns

bool

DrawWorldPoint(string, Vector2, float, float)

public static extern void DrawWorldPoint(string id, Vector2 position, float arrow_scale, float target_scale)

Parameters

id string
position Vector2
arrow_scale float
target_scale float

GetCurrentStep(Player)

public TutorialStep GetCurrentStep(Player player)

Parameters

player Player

Returns

TutorialStep

GetStep(string)

public TutorialStep GetStep(string id)

Parameters

id string

Returns

TutorialStep

IsStepComplete(string, Player)

public bool IsStepComplete(string id, Player player)

Parameters

id string
player Player

Returns

bool

MarkStepComplete(string, Player)

public void MarkStepComplete(string id, Player player)

Parameters

id string
player Player

MarkStepIncomplete(string, Player)

public void MarkStepIncomplete(string id, Player player)

Parameters

id string
player Player

MarkTutorialComplete(Player)

public void MarkTutorialComplete(Player player)

Parameters

player Player

RegisterConditionCheck(string, Func<Player, string, object, bool>)

public static void RegisterConditionCheck(string id, Func<Player, string, object, bool> check)

Parameters

id string
check Func<Player, string, object, bool>

RegisterOnStepComplete(string, Action<Player, string>)

public static void RegisterOnStepComplete(string id, Action<Player, string> callback)

Parameters

id string
callback Action<Player, string>

ResetTutorial(Player)

public void ResetTutorial(Player player)

Parameters

player Player