Files
Bubberstation/code/controllers/subsystem/tutorials.dm
T
Alexis 21b4095dfd [MDB IGNORE] [IDB IGNORE] Upstream Sync - 04/17/2026 (#5453)
Upstream 04/17/2026

fixes https://github.com/Bubberstation/Bubberstation/issues/5549

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: tgstation-ci[bot] <179393467+tgstation-ci[bot]@users.noreply.github.com>
Co-authored-by: ArcaneMusic <41715314+ArcaneMusic@users.noreply.github.com>
Co-authored-by: MrMelbert <51863163+MrMelbert@users.noreply.github.com>
Co-authored-by: Rhials <28870487+Rhials@users.noreply.github.com>
Co-authored-by: rageguy505 <54517726+rageguy505@users.noreply.github.com>
Co-authored-by: LemonInTheDark <58055496+LemonInTheDark@users.noreply.github.com>
Co-authored-by: John Willard <53777086+JohnFulpWillard@users.noreply.github.com>
Co-authored-by: Aliceee2ch <160794176+Aliceee2ch@users.noreply.github.com>
Co-authored-by: Time-Green <7501474+Time-Green@users.noreply.github.com>
Co-authored-by: Tsar-Salat <62388554+Tsar-Salat@users.noreply.github.com>
Co-authored-by: SmArtKar <44720187+SmArtKar@users.noreply.github.com>
Co-authored-by: Maxipat <108554989+Maxipat112@users.noreply.github.com>
Co-authored-by: SyncIt21 <110812394+SyncIt21@users.noreply.github.com>
Co-authored-by: deltanedas <39013340+deltanedas@users.noreply.github.com>
Co-authored-by: SimplyLogan <47579821+loganuk@users.noreply.github.com>
Co-authored-by: loganuk <fakeemail123@aol.com>
Co-authored-by: Leland Kemble <70413276+lelandkemble@users.noreply.github.com>
Co-authored-by: FalloutFalcon <86381784+FalloutFalcon@users.noreply.github.com>
Co-authored-by: Roxy <75404941+TealSeer@users.noreply.github.com>
Co-authored-by: Lucy <lucy@absolucy.moe>
Co-authored-by: siliconOpossum <138069572+siliconOpossum@users.noreply.github.com>
Co-authored-by: Isratosh <Isratosh@hotmail.com>
Co-authored-by: TheRyeGuyWhoWillNowDie <70169560+TheRyeGuyWhoWillNowDie@users.noreply.github.com>
Co-authored-by: Neocloudy <88008002+Neocloudy@users.noreply.github.com>
Co-authored-by: Alexander V. <volas@ya.ru>
Co-authored-by: ElGitificador <168473461+ElGitificador@users.noreply.github.com>
Co-authored-by: Twaticus <46540570+Twaticus@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Bloop <13398309+vinylspiders@users.noreply.github.com>
Co-authored-by: Cameron Lennox <killer65311@gmail.com>
Co-authored-by: Tim <timothymtorres@gmail.com>
Co-authored-by: Iamgoofball <iamgoofball@gmail.com>
Co-authored-by: Layzu666 <121319428+Layzu666@users.noreply.github.com>
Co-authored-by: Arturlang <24881678+Arturlang@users.noreply.github.com>
Co-authored-by: _0Steven <42909981+00-Steven@users.noreply.github.com>
Co-authored-by: mrmanlikesbt <99309552+mrmanlikesbt@users.noreply.github.com>
Co-authored-by: Ben10Omintrix <138636438+Ben10Omintrix@users.noreply.github.com>
Co-authored-by: John F. Kennedy <54908920+MacaroniCritter@users.noreply.github.com>
Co-authored-by: Cursor <102828457+theselfish@users.noreply.github.com>
Co-authored-by: Josh <josh.adam.powell@gmail.com>
Co-authored-by: Josh Powell <josh.powell@softwire.com>
Co-authored-by: Yobrocharlie <Charliemiller5617@gmail.com>
Co-authored-by: Hardly3D <66234359+Hardly3D@users.noreply.github.com>
Co-authored-by: shayoki <96078776+shayoki@users.noreply.github.com>
Co-authored-by: LT3 <83487515+lessthnthree@users.noreply.github.com>
2026-05-16 00:56:00 +02:00

113 lines
3.7 KiB
Plaintext

/// Namespace for housing code relating to giving contextual tutorials to users.
SUBSYSTEM_DEF(tutorials)
name = "Tutorials"
ss_flags = SS_NO_FIRE
/// A mapping of /datum/tutorial type to their manager singleton.
/// You probably shouldn't be indexing this directly.
var/list/datum/tutorial_manager/tutorial_managers = list()
VAR_PRIVATE/list/datum/tutorial_manager/tutorial_managers_by_key = list()
/datum/controller/subsystem/tutorials/Initialize()
init_tutorial_managers()
load_initial_tutorial_completions()
RegisterSignal(SSdcs, COMSIG_GLOB_CLIENT_CONNECT, PROC_REF(on_client_connect))
return SS_INIT_SUCCESS
/// Will suggest the passed tutorial type to the user.
/// Will check that they should actually see it, e.g. hasn't completed it yet, etc.
/// Then, calls `/datum/tutorial/subtype/perform` with the extra arguments passed in.
/datum/controller/subsystem/tutorials/proc/suggest_tutorial(mob/user, datum/tutorial/tutorial_type, ...)
var/datum/tutorial_manager/tutorial_manager = tutorial_managers[tutorial_type]
if (isnull(tutorial_manager))
CRASH("[tutorial_type] is not a valid tutorial type")
if (!tutorial_manager.should_run(user))
return
INVOKE_ASYNC(tutorial_manager, TYPE_PROC_REF(/datum/tutorial_manager, try_perform), user, args.Copy(3))
/datum/controller/subsystem/tutorials/proc/init_tutorial_managers()
PRIVATE_PROC(TRUE)
for (var/datum/tutorial/tutorial_type as anything in subtypesof(/datum/tutorial))
var/datum/tutorial_manager/tutorial_manager = new /datum/tutorial_manager(tutorial_type)
tutorial_managers[tutorial_type] = tutorial_manager
tutorial_managers_by_key[tutorial_manager.get_key()] = tutorial_manager
/datum/controller/subsystem/tutorials/proc/load_initial_tutorial_completions()
PRIVATE_PROC(TRUE)
set waitfor = FALSE // There's no reason to halt init for this
var/list/ckey_options = list()
var/list/ckeys = list()
for (var/client/client as anything in GLOB.clients)
var/ckey = client?.ckey
if (!ckey)
continue // client shenanigans, never trust
var/index = ckeys.len + 1
ckey_options += ":ckey[index]"
ckeys["ckey[index]"] = ckey
if (ckey_options.len == 0)
return
var/datum/db_query/select_all_query = SSdbcore.NewQuery(
"SELECT ckey, tutorial_key FROM [format_table_name("tutorial_completions")] WHERE ckey in ([ckey_options.Join(", ")])",
ckeys,
)
if (!select_all_query.Execute())
qdel(select_all_query)
return
while (select_all_query.NextRow())
var/ckey = select_all_query.item[1]
var/tutorial_key = select_all_query.item[2]
mark_ckey_completed_tutorial(ckey, tutorial_key)
qdel(select_all_query)
/datum/controller/subsystem/tutorials/proc/on_client_connect(datum/source, client/client)
SIGNAL_HANDLER
var/ckey = client.ckey
if (!ckey)
return
INVOKE_ASYNC(src, PROC_REF(check_completed_tutorials_for_ckey), ckey)
/datum/controller/subsystem/tutorials/proc/check_completed_tutorials_for_ckey(ckey)
if (!SSdbcore.IsConnected())
return
var/datum/db_query/select_tutorials_for_ckey = SSdbcore.NewQuery(
"SELECT tutorial_key FROM [format_table_name("tutorial_completions")] WHERE ckey = :ckey",
list("ckey" = ckey)
)
if (!select_tutorials_for_ckey.Execute())
qdel(select_tutorials_for_ckey)
return
while (select_tutorials_for_ckey.NextRow())
var/tutorial_key = select_tutorials_for_ckey.item[1]
mark_ckey_completed_tutorial(ckey, tutorial_key)
qdel(select_tutorials_for_ckey)
/datum/controller/subsystem/tutorials/proc/mark_ckey_completed_tutorial(ckey, tutorial_key)
var/datum/tutorial_manager/tutorial_manager = tutorial_managers_by_key[tutorial_key]
if (isnull(tutorial_manager))
// Not necessarily a bug.
// Could be an outdated server or a removed tutorial.
return
tutorial_manager.mark_as_completed(ckey)