tutorialTips

Table of Contents

• tutorialTips
  • add
  • reset
  • resetAll
  • trigger

 

tutorialTips

A library providing functions to add and trigger tutorial tips. Tips can be triggered only once per profile, unless reset by reset or resetAll.

Note: Each mod using this library must each have their unique instance of it.

 

add

Argument name	Type	Description
self	table	tutorialTips itself
tip	table	a table describing the tutorial tip

The tip object, passed as first argument, can have the following fields:

Field	Type	Description
id	string	id of tutorial tip - unique to your mod
title	string	description title of tutorial tip
text	Point	description text of tutorial tip

Adds a tutorial tip that can be triggered exactly once with trigger.

 

reset

Argument name	Type	Description
self	table	tutorialTips itself
id	string	id of tutorial tip you want to reset

Resets the tutorial tip, so it can be triggered again.

 

resetAll

Argument name	Type	Description
self	table	tutorialTips itself

Resets every tutorial tip added by your mod, so you can trigger them again.

 

trigger

Argument name	Type	Description
self	table	tutorialTips itself
id	string	id of tutorial tip you want to trigger
loc	Point	the tile you want the tutorial tip to point at

Triggers tutorial tip with the specified id at the specified location; displaying the tip's title and text until the player dismisses the tip.

Additional calls to trigger will no longer do anything on the current profile unless reset or resetAll is used to reset this tutorial tip.