Persistent client (#1218)

* simple replacement first

* small

* fixes

* psosessbyplayer

* make null safe

* tweak

* balls

* fuck dude im so dumb

* fixes

Author: Kapu1178

code/__DEFINES/_helpers.dm

@@ -24,3 +24,6 @@
 // Custom types that we define don't get a unique id, but this is useful for identifying
 // types that don't normally have a way to run istype() on them.
 #define TYPEID(thing) copytext(REF(thing), 4, 6)
+
+/// Abstraction over using mob.client to just check if there's a connected player.
+#define HAS_CONNECTED_PLAYER(mob) (mob.client)

code/__HELPERS/game.dm

@@ -294,7 +294,7 @@
 
 	ghost_player.client.prefs.safe_transfer_prefs_to(new_character)
 	new_character.dna.update_dna_identity()
-	new_character.key = ghost_player.key
+	new_character.PossessByPlayer(ghost_player.ckey)
 
 	return new_character
 

code/__HELPERS/roundend.dm

@@ -652,7 +652,7 @@
 
 /datum/controller/subsystem/ticker/proc/give_show_report_button(client/C)
 	var/datum/action/report/R = new
-	C.player_details.player_actions += R
+	C.persistent_client.player_actions += R
 	R.Grant(C.mob)
 	to_chat(C,"<span class='infoplain'><a href='?src=[REF(R)];report=1'>Show roundend report again</a></span>")
 

code/controllers/subsystem/achievements.dm

@@ -30,8 +30,8 @@ SUBSYSTEM_DEF(achievements)
 
 	for(var/i in GLOB.clients)
 		var/client/C = i
-		if(!C.player_details.achievements.initialized)
-			C.player_details.achievements.InitializeData()
+		if(!C.persistent_client.achievements.initialized)
+			C.persistent_client.achievements.InitializeData()
 
 	return ..()
 
@@ -40,8 +40,8 @@ SUBSYSTEM_DEF(achievements)
 
 /datum/controller/subsystem/achievements/proc/save_achievements_to_db()
 	var/list/cheevos_to_save = list()
-	for(var/ckey in GLOB.player_details)
-		var/datum/player_details/PD = GLOB.player_details[ckey]
+	for(var/ckey in GLOB.persistent_clients_by_ckey)
+		var/datum/persistent_client/PD = GLOB.persistent_clients_by_ckey[ckey]
 		if(!PD || !PD.achievements)
 			continue
 		cheevos_to_save += PD.achievements.get_changed_data()

code/controllers/subsystem/blackbox.dm

@@ -83,9 +83,8 @@ SUBSYSTEM_DEF(blackbox)
 		if (MS.rc_msgs.len)
 			record_feedback("tally", "radio_usage", MS.rc_msgs.len, "request console")
 
-	for(var/player_key in GLOB.player_details)
-		var/datum/player_details/PD = GLOB.player_details[player_key]
-		record_feedback("tally", "client_byond_version", 1, PD.byond_version)
+	for(var/datum/persistent_client/PC as anything in GLOB.persistent_clients)
+		record_feedback("tally", "client_byond_version", 1, PC.full_byond_version())
 
 /datum/controller/subsystem/blackbox/Shutdown()
 	sealed = FALSE

code/controllers/subsystem/vote.dm

@@ -142,7 +142,7 @@ SUBSYSTEM_DEF(vote)
 		V.Grant(C.mob)
 		V.name = "Vote: [current_vote.name]"
 
-		C.player_details.player_actions += V
+		C.persistent_client.player_actions += V
 		generated_actions += V
 
 		if(C.prefs.toggles & SOUND_ANNOUNCEMENTS)
@@ -260,11 +260,11 @@ SUBSYSTEM_DEF(vote)
 
 // We also need to remove our action from the player actions when we're cleaning up.
 /datum/action/vote/Remove(mob/removed_from)
-	if(removed_from.client)
-		removed_from.client?.player_details.player_actions -= src
+	if(removed_from.persistent_client)
+		removed_from.persistent_client?.player_actions -= src
 
 	else if(removed_from.ckey)
-		var/datum/player_details/associated_details = GLOB.player_details[removed_from.ckey]
-		associated_details?.player_actions -= src
+		var/datum/persistent_client/persistent_client = GLOB.persistent_clients_by_ckey[removed_from.ckey]
+		persistent_client?.player_actions -= src
 
 	return ..()

code/datums/achievements/_achievement_data.dm

@@ -146,4 +146,4 @@
 	set name = "Check achievements"
 	set desc = "See all of your achievements!"
 
-	player_details.achievements.ui_interact(usr)
+	persistent_client.achievements.ui_interact(usr)

code/datums/brain_damage/imaginary_friend.dm

@@ -50,7 +50,7 @@
 	var/list/mob/dead/observer/candidates = poll_candidates_for_mob("Do you want to play as [owner.real_name]'s imaginary friend?", ROLE_PAI, null, 7.5 SECONDS, friend, POLL_IGNORE_IMAGINARYFRIEND)
 	if(LAZYLEN(candidates))
 		var/mob/dead/observer/C = pick(candidates)
-		friend.key = C.key
+		friend.PossessByPlayer(C.ckey)
 		friend_initialized = TRUE
 	else
 		qdel(src)

code/datums/brain_damage/split_personality.dm

@@ -36,7 +36,7 @@
 	var/list/mob/dead/observer/candidates = poll_candidates_for_mob("Do you want to play as [owner.real_name]'s split personality?", ROLE_PAI, null, 7.5 SECONDS, stranger_backseat, POLL_IGNORE_SPLITPERSONALITY)
 	if(LAZYLEN(candidates))
 		var/mob/dead/observer/C = pick(candidates)
-		stranger_backseat.key = C.key
+		stranger_backseat.PossessByPlayer(C.ckey)
 		log_game("[key_name(stranger_backseat)] became [key_name(owner)]'s split personality.")
 		message_admins("[ADMIN_LOOKUPFLW(stranger_backseat)] became [ADMIN_LOOKUPFLW(owner)]'s split personality.")
 	else
@@ -92,7 +92,7 @@
 	owner.computer_id = null
 	owner.lastKnownIP = null
 
-	new_backseat.ckey = owner.ckey
+	new_backseat.PossessByPlayer(owner.ckey)
 
 	new_backseat.name = owner.name
 
@@ -208,7 +208,7 @@
 	var/list/mob/dead/observer/candidates = poll_candidates_for_mob("Do you want to play as [owner.real_name]'s brainwashed mind?", null, null, 7.5 SECONDS, stranger_backseat)
 	if(LAZYLEN(candidates))
 		var/mob/dead/observer/C = pick(candidates)
-		stranger_backseat.key = C.key
+		stranger_backseat.PossessByPlayer(C.ckey)
 	else
 		qdel(src)
 

code/datums/components/spirit_holding.dm

@@ -68,7 +68,7 @@
 
 	var/mob/dead/observer/chosen_spirit = pick(candidates)
 	bound_spirit = new(parent)
-	bound_spirit.ckey = chosen_spirit.ckey
+	bound_spirit.PossessByPlayer(chosen_spirit.ckey)
 	bound_spirit.fully_replace_character_name(null, "The spirit of [parent]")
 	bound_spirit.status_flags |= GODMODE
 	bound_spirit.copy_languages(awakener, LANGUAGE_MASTER) //Make sure the sword can understand and communicate with the awakener.

code/datums/mind.dm

@@ -19,9 +19,9 @@
 	- IMPORTANT NOTE 2, if you want a player to become a ghost, use mob.ghostize() It does all the hard work for you.
 
 	- When creating a new mob which will be a new IC character (e.g. putting a shade in a construct or randomly selecting
-		a ghost to become a xeno during an event). Simply assign the key or ckey like you've always done.
+		a ghost to become a xeno during an event). Pass the player's key or ckey into the following proc.
 
-			new_mob.key = key
+			new_mob.PossessByPlayer(ckey)
 
 		The Login proc will handle making a new mind for that mobtype (including setting up stuff like mind.name). Simple!
 		However if you want that mind to have any special properties like being a traitor etc you will have to do that
@@ -187,7 +187,7 @@
 	RegisterSignal(new_character, COMSIG_LIVING_DEATH, PROC_REF(set_death_time))
 
 	if(active || force_key_move)
-		new_character.key = key //now transfer the key to link the client to our new body
+		new_character.PossessByPlayer(key) //now transfer the key to link the client to our new body
 
 	if(new_character.client)
 		LAZYCLEARLIST(new_character.client.recent_examines)

code/datums/pathogens/transformation.dm

@@ -73,7 +73,7 @@
 			if(affected_mob.mind)
 				affected_mob.mind.transfer_to(new_mob)
 			else
-				new_mob.key = affected_mob.key
+				new_mob.PossessByPlayer(affected_mob.ckey)
 		if(transformed_antag_datum)
 			new_mob.mind.add_antag_datum(transformed_antag_datum)
 		new_mob.name = affected_mob.real_name
@@ -89,13 +89,12 @@
 		to_chat(affected_mob, span_userdanger("Your mob has been taken over by a ghost! Appeal your job ban if you want to avoid this in the future!"))
 		message_admins("[key_name_admin(C)] has taken control of ([key_name_admin(affected_mob)]) to replace a jobbanned player.")
 		affected_mob.ghostize(0)
-		affected_mob.key = C.key
+		affected_mob.PossessByPlayer(C.ckey)
 	else
 		to_chat(new_mob, span_userdanger("Your mob has been claimed by death! Appeal your job ban if you want to avoid this in the future!"))
 		new_mob.death()
 		if (!QDELETED(new_mob))
 			new_mob.ghostize(can_reenter_corpse = FALSE)
-			new_mob.key = null
 
 /datum/pathogen/transformation/jungle_flu
 	name = "Jungle Flu"

code/game/gamemodes/dynamic/dynamic_rulesets_midround.dm

@@ -595,7 +595,7 @@
 /datum/dynamic_ruleset/midround/from_ghosts/xenomorph/generate_ruleset_body(mob/applicant)
 	var/obj/vent = pick_n_take(vents)
 	var/mob/living/carbon/alien/larva/new_xeno = new(vent.loc)
-	new_xeno.key = applicant.key
+	new_xeno.PossessByPlayer(applicant.ckey)
 	new_xeno.move_into_vent(vent)
 	message_admins("[ADMIN_LOOKUPFLW(new_xeno)] has been made into an alien by the midround ruleset.")
 	log_game("DYNAMIC: [key_name(new_xeno)] was spawned as an alien by the midround ruleset.")
@@ -791,7 +791,7 @@
 
 /datum/dynamic_ruleset/midround/from_ghosts/revenant/generate_ruleset_body(mob/applicant)
 	var/mob/living/simple_animal/revenant/revenant = new(pick(spawn_locs))
-	revenant.key = applicant.key
+	revenant.PossessByPlayer(applicant.key)
 	message_admins("[ADMIN_LOOKUPFLW(revenant)] has been made into a revenant by the midround ruleset.")
 	log_game("[key_name(revenant)] was spawned as a revenant by the midround ruleset.")
 	return revenant

code/game/machinery/computer/arena.dm

@@ -188,7 +188,7 @@
 	M.set_species(/datum/species/human) // Could use setting per team
 	M.equipOutfit(outfits[team] ? outfits[team] : default_outfit)
 	M.faction += team //In case anyone wants to add team based stuff to arena special effects
-	M.key = ckey
+	M.PossessByPlayer(ckey)
 
 /obj/machinery/computer/arena/proc/change_outfit(mob/user,team)
 	outfits[team] = user.client.robust_dress_shop()

code/game/objects/effects/anomalies.dm

@@ -354,7 +354,7 @@
 	var/list/mob/dead/observer/candidates = poll_candidates_for_mob("Do you want to play as a pyroclastic anomaly slime?", ROLE_SENTIENCE, null, 10 SECONDS, S, POLL_IGNORE_PYROSLIME)
 	if(LAZYLEN(candidates))
 		var/mob/dead/observer/chosen = pick(candidates)
-		S.key = chosen.key
+		S.PossessByPlayer(chosen.ckey)
 		S.mind.special_role = ROLE_PYROCLASTIC_SLIME
 		var/policy = get_policy(ROLE_PYROCLASTIC_SLIME)
 		if (policy)

code/game/objects/items/devices/paicard.dm

@@ -110,7 +110,7 @@
 			/// The newly downloaded pAI personality
 			var/mob/living/silicon/pai/new_pai = new(src)
 			new_pai.set_real_name(candidate.name || pick(GLOB.ninja_names))
-			new_pai.key = candidate.key
+			new_pai.PossessByPlayer(candidate.key)
 			setPersonality(new_pai)
 			SSpai.candidates -= candidate
 		if("fix_speech")

code/modules/admin/admin.dm

@@ -241,7 +241,7 @@
 	log_admin("[key_name(usr)] stuffed [frommob.key] into [tomob.name].")
 	SSblackbox.record_feedback("tally", "admin_verb", 1, "Ghost Drag Control")
 
-	tomob.key = frommob.key
+	tomob.PossessByPlayer(frommob.key)
 	tomob.client?.init_verbs()
 	qdel(frommob)
 

code/modules/admin/fun_balloon.dm

@@ -95,7 +95,7 @@
 
 		message_admins("[key_name_admin(C)] has taken control of ([key_name_admin(body)])")
 		body.ghostize(FALSE)
-		body.key = C.key
+		body.PossessByPlayer(C.key)
 		new /obj/effect/temp_visual/gravpush(get_turf(body))
 
 // ----------- Emergency Shuttle Balloon

code/modules/admin/player_panel.dm

@@ -282,7 +282,7 @@
 			var/M_key = html_encode(M.key)
 			var/previous_names = ""
 			if(M_key)
-				var/datum/player_details/P = GLOB.player_details[ckey(M_key)]
+				var/datum/persistent_client/P = GLOB.persistent_clients_by_ckey[ckey(M_key)]
 				if(P)
 					previous_names = P.played_names.Join(",")
 			previous_names = html_encode(previous_names)

code/modules/admin/smites/imaginary_friend_special.dm

@@ -55,4 +55,4 @@
 	else
 		friend_mob = new /mob/camera/imaginary_friend(get_turf(target), target, friend_candidate_client.prefs)
 
-	friend_mob.key = friend_candidate_client.key
+	friend_mob.PossessByPlayer(friend_candidate_client.key)

code/modules/admin/verbs/admingame.dm

@@ -213,7 +213,7 @@ Traitors and the like can also be revived with the previous role mostly intact.
 				var/mob/living/carbon/human/species/monkey/new_monkey = new
 				SSjob.SendToLateJoin(new_monkey)
 				G_found.mind.transfer_to(new_monkey) //be careful when doing stuff like this! I've already checked the mind isn't in use
-				new_monkey.key = G_found.key
+				new_monkey.PossessByPlayer(G_found.key)
 				to_chat(new_monkey, "You have been fully respawned. Enjoy the game.", confidential = TRUE)
 				var/msg = span_adminnotice("[key_name_admin(usr)] has respawned [new_monkey.key] as a filthy monkey.")
 				message_admins(msg)
@@ -251,7 +251,7 @@ Traitors and the like can also be revived with the previous role mostly intact.
 	if(is_unassigned_job(new_character.mind.assigned_role))
 		new_character.mind.set_assigned_role(SSjob.GetJobType(SSjob.overflow_role))
 
-	new_character.key = G_found.key
+	new_character.PossessByPlayer(G_found.key)
 
 	/*
 	The code below functions with the assumption that the mob is already a traitor if they have a special role.

code/modules/admin/verbs/debug.dm

@@ -61,7 +61,7 @@
 		return
 
 	pai.set_real_name(chosen_name)
-	pai.key = choice.key
+	pai.PossessByPlayer(choice.key)
 	card.setPersonality(pai)
 	for(var/datum/pai_candidate/candidate in SSpai.candidates)
 		if(candidate.key == choice.key)

code/modules/admin/verbs/ert.dm

@@ -124,7 +124,7 @@
 				var/chosen_outfit = usr.client?.prefs?.read_preference(/datum/preference/choiced/brief_outfit)
 				usr.client.prefs.safe_transfer_prefs_to(admin_officer, is_antag = TRUE)
 				admin_officer.equipOutfit(chosen_outfit)
-				admin_officer.key = usr.key
+				admin_officer.PossessByPlayer(usr.key)
 			else
 				to_chat(usr, span_warning("Could not spawn you in as briefing officer as you are not a ghost!"))
 
@@ -178,7 +178,7 @@
 			//Spawn the body
 			var/mob/living/carbon/human/ert_operative = new ertemplate.mobtype(spawnloc)
 			chosen_candidate.client.prefs.safe_transfer_prefs_to(ert_operative, is_antag = TRUE)
-			ert_operative.key = chosen_candidate.key
+			ert_operative.PossessByPlayer(chosen_candidate.key)
 
 			if(ertemplate.enforce_human || !(ert_operative.dna.species.changesource_flags & ERT_SPAWN)) // Don't want any exploding plasmemes
 				ert_operative.set_species(/datum/species/human)

code/modules/admin/verbs/individual_logging.dm

@@ -47,7 +47,7 @@
 
 	var/log_source = M.logging
 	if(source == LOGSRC_CKEY && M.ckey)
-		var/datum/player_details/details = GLOB.player_details[M.ckey]
+		var/datum/persistent_client/details = GLOB.persistent_clients_by_ckey[M.ckey]
 		if(details) //we dont want to runtime if an admin aghosted
 			log_source = details.logging
 	var/list/concatenated_logs = list()

code/modules/admin/verbs/secrets.dm

@@ -571,7 +571,7 @@ GLOBAL_DATUM(everyone_a_traitor, /datum/everyone_is_a_traitor_controller)
 				chosen_candidate = pick(candidates)
 				candidates -= chosen_candidate
 				nerd = new /mob/living/simple_animal/drone/classic(spawnpoint)
-				nerd.key = chosen_candidate.key
+				nerd.PossessByPlayer(chosen_candidate.key)
 				log_game("[key_name(nerd)] has been selected as a Nanotrasen emergency response drone")
 				teamsize--
 
@@ -609,7 +609,7 @@ GLOBAL_DATUM(everyone_a_traitor, /datum/everyone_is_a_traitor_controller)
 			var/mob/chosen = players[1]
 			if (chosen.client)
 				chosen.client.prefs.safe_transfer_prefs_to(spawnedMob, is_antag = TRUE)
-				spawnedMob.key = chosen.key
+				spawnedMob.PossessByPlayer(chosen.key)
 			players -= chosen
 		if (ishuman(spawnedMob) && ispath(humanoutfit, /datum/outfit))
 			var/mob/living/carbon/human/H = spawnedMob

code/modules/antagonists/_common/antag_datum.dm

@@ -204,7 +204,7 @@ GLOBAL_LIST_EMPTY(antagonists)
 		to_chat(owner, "Your mob has been taken over by a ghost! Appeal your job ban if you want to avoid this in the future!")
 		message_admins("[key_name_admin(C)] has taken control of ([key_name_admin(owner)]) to replace a jobbanned player.")
 		owner.current.ghostize(0)
-		owner.current.key = C.key
+		owner.current.PossessByPlayer(C.key)
 
 /**
  * Called by the remove_antag_datum() and remove_all_antag_datums() mind procs for the antag datum to handle its own removal and deletion.

code/modules/antagonists/_common/antag_spawner.dm

@@ -70,7 +70,7 @@
 	new /obj/effect/particle_effect/fluid/smoke(T)
 	var/mob/living/carbon/human/M = new/mob/living/carbon/human(T)
 	C.prefs.safe_transfer_prefs_to(M, is_antag = TRUE)
-	M.key = C.key
+	M.PossessByPlayer(C.key)
 	var/datum/mind/app_mind = M.mind
 
 	var/datum/antagonist/wizard/apprentice/app = new()
@@ -216,7 +216,7 @@
 	borg.mmi.brainmob.set_real_name(brainopsname)
 	borg.set_real_name(borg.name)
 
-	borg.key = C.key
+	borg.PossessByPlayer(C.key)
 
 	var/datum/antagonist/nukeop/new_borg = new()
 	new_borg.send_to_spawnpoint = FALSE
@@ -264,7 +264,7 @@
 	var/mob/living/simple_animal/hostile/imp/slaughter/S = new demon_type(T)
 	new /obj/effect/dummy/phased_mob(T, S)
 
-	S.key = C.key
+	S.PossessByPlayer(C.key)
 	S.mind.set_assigned_role(SSjob.GetJobType(/datum/job/slaughter_demon))
 	S.mind.special_role = ROLE_SLAUGHTER_DEMON
 	S.mind.add_antag_datum(antag_type)

code/modules/antagonists/blob/powers.dm

@@ -168,7 +168,7 @@
 		blobber.adjustHealth(blobber.maxHealth * 0.5)
 		blob_mobs += blobber
 		var/mob/dead/observer/C = pick(candidates)
-		blobber.key = C.key
+		blobber.PossessByPlayer(C.key)
 		SEND_SOUND(blobber, sound('sound/effects/blobattack.ogg'))
 		SEND_SOUND(blobber, sound('sound/effects/attackblob.ogg'))
 		to_chat(blobber, "<b>You are a blobbernaut!</b>")

code/modules/antagonists/cult/runes.dm

@@ -606,7 +606,7 @@ structure_check() searches for nearby cultist structures required for the invoca
 			to_chat(mob_to_revive.mind, "Your physical form has been taken over by another soul due to your inactivity! Ahelp if you wish to regain your form.")
 			message_admins("[key_name_admin(C)] has taken control of ([key_name_admin(mob_to_revive)]) to replace an AFK player.")
 			mob_to_revive.ghostize(0)
-			mob_to_revive.key = C.key
+			mob_to_revive.PossessByPlayer(C.key)
 		else
 			fail_invoke()
 			return
@@ -851,7 +851,7 @@ structure_check() searches for nearby cultist structures required for the invoca
 		visible_message(span_warning("A cloud of red mist forms above [src], and from within steps... a [new_human.gender == FEMALE ? "wo":""]man."))
 		to_chat(user, span_cultitalic("Your blood begins flowing into [src]. You must remain in place and conscious to maintain the forms of those summoned. This will hurt you slowly but surely..."))
 		var/obj/structure/emergency_shield/cult/weak/N = new(T)
-		new_human.key = ghost_to_spawn.key
+		new_human.PossessByPlayer(ghost_to_spawn.key)
 		new_human.mind?.add_antag_datum(/datum/antagonist/cult)
 		to_chat(new_human, span_cultitalic("<b>You are a servant of the Geometer. You have been made semi-corporeal by the cult of Nar'Sie, and you are to serve them at all costs.</b>"))