View as Markdown

Tutorials

Read more about the Tutorials system in Hiro here.

Get all tutorials #

Get the tutorials and current progress step for the player.

1
2

const tutorialList = await hiroClient.tutorialGet(session);
console.log(tutorialList);

Accept a tutorial #

Accept an offer to step through a tutorial.

1
2
3
4
5

const request = new TutorialAcceptRequest();
request.id = "tutorial_1";

const tutorial = await hiroClient.tutorialsAccept(session, request);
console.log(tutorial);

Decline a tutorial #

Decline an offer to start a tutorial.

1
2
3
4
5

const request = new TutorialDeclineRequest();
request.id = "tutorial_1";

const tutorial = await hiroClient.tutorialsDecline(session, request);
console.log(tutorial);

Abandon a tutorial #

Abandon progress on a tutorial.

1
2
3
4
5

const request = new TutorialAbandonRequest();
request.id = "tutorial_1";

const tutorial = await hiroClient.tutorialsAbandon(session, request);
console.log(tutorial);

Update progress of a tutorial #

Update the current progress step in the tutorial by ID.

1
2
3
4
5
6

const request = new TutorialUpdateRequest();
request.id = "tutorial_1";
request.step = 1;

const tutorialList = await hiroClient.tutorialsUpdate(session, request);
console.log(tutorialList);