API References

HSVTutorialManager

public void Setup();

Setup references of Canvas, Camera, Raycaster components for Tutorial Manager.

public void SetCamera(Camera camera);

Sets camera reference to 'camera'.

Stages API

public void PlayStage(int stageStep, bool autoStart = true);

public void PlayStage(string stageName, bool autoStart = true);

public void PlayStage(bool autoStart = true);

public void StopStage();

public HSVTutorialStage GetCurrentStageObject(int stageStep);

public HSVTutorialStage GetCurrentStageObject(string stageName);

Tutorial Object API

public void PlayTutorial(int step);

public void PlayTutorial(string name);

public void PlayTutorial();

public void PlayTutorial(int stageIndex, int tObjIndex);

public void StopTutorial(bool autoAdvance = true);

public void StopTutorial(int step, bool autoAdvance = true);

public void StopTutorial(string name, bool autoAdvance = true);

public void StopTutorial(int stageIndex, int tObjIndex, bool autoAdvance = true);

public void AdvanceTutorial();

public void HighlightTarget(HSVTutorialObject tObj, bool highlight);

public HSVTutorialObject GetCurrentTutorialObject(HSVTutorialStage stageObj, int step);

public HSVTutorialObject GetCurrentTutorialObject(HSVTutorialStage stageObj, string name);

public HSVTutorialObject GetCurrentTutorialObject(int stageIndex, int step);

public bool CheckAllTutorialObjectComplete();

Last updated