tutorial_manager
A singleton that manages when to create tutorials of a specific tutorial type.
Vars | |
| finished_ckeys | ckeys that we know have finished the tutorial |
|---|---|
| performing_ckeys | ckeys that have performed the tutorial, but have not completed it. Doesn't mean that they can still see the tutorial, might have meant the tutorial was dismissed without being completed, such as during a log out. |
Procs | |
| complete | Marks the tutorial as completed.
Call /datum/tutorial/proc/complete() instead. |
| dismiss | Dismisses the tutorial, not marking it as completed in the database.
Call /datum/tutorial/proc/dismiss() instead. |
| get_key | Gives the key that will be saved in the database. Must be 64 characters or less. |
| mark_as_completed | Given a ckey, will mark them as being completed without affecting the database.
Call /datum/tutorial/proc/complete() instead. |
| should_run | Checks if the user should be given this tutorial |
| try_perform | Checks if we should perform the tutorial for the given user, and performs if so.
Use SStutorials.suggest_tutorial instead of calling this directly. |
Var Details
finished_ckeys
ckeys that we know have finished the tutorial
performing_ckeys
ckeys that have performed the tutorial, but have not completed it. Doesn't mean that they can still see the tutorial, might have meant the tutorial was dismissed without being completed, such as during a log out.
Proc Details
complete
Marks the tutorial as completed.
Call /datum/tutorial/proc/complete() instead.
dismiss
Dismisses the tutorial, not marking it as completed in the database.
Call /datum/tutorial/proc/dismiss() instead.
get_key
Gives the key that will be saved in the database. Must be 64 characters or less.
mark_as_completed
Given a ckey, will mark them as being completed without affecting the database.
Call /datum/tutorial/proc/complete() instead.
should_run
Checks if the user should be given this tutorial
try_perform
Checks if we should perform the tutorial for the given user, and performs if so.
Use SStutorials.suggest_tutorial instead of calling this directly.