CanReach rewrite

Author: Kapu1178

code/__DEFINES/dcs/signals/signals_atom/signals_atom_main.dm

@@ -60,9 +60,6 @@
 #define COMSIG_ATOM_CONTENTS_DEL "atom_contents_del"
 ///from base of atom/has_gravity(): (turf/location, list/forced_gravities)
 #define COMSIG_ATOM_HAS_GRAVITY "atom_has_gravity"
-///from internal loop in atom/movable/proc/CanReach(): (list/next)
-#define COMSIG_ATOM_CANREACH "atom_can_reach"
-	#define COMPONENT_ALLOW_REACH (1<<0)
 ///for when an atom has been created through processing (atom/original_atom, list/chosen_processing_option)
 #define COMSIG_ATOM_CREATEDBY_PROCESSING "atom_createdby_processing"
 ///when an atom is processed (mob/living/user, obj/item/I, list/atom/results)

code/__DEFINES/inventory.dm

@@ -16,8 +16,12 @@
 
 //Inventory depth: limits how many nested storage items you can access directly.
 //1: stuff in mob, 2: stuff in backpack, 3: stuff in box in backpack, etc
-#define INVENTORY_DEPTH 3
-#define STORAGE_VIEW_DEPTH 2
+///
+#define REACH_DEPTH_SELF 1
+/// A storage depth ontop of SELF. REACH_DEPTH_STORAGE(1) would allow an item inside of a backpack you are carrying.
+#define REACH_DEPTH_STORAGE(level) (level + REACH_DEPTH_SELF)
+/// An arbitrary depth value for keeping storage UIs open on Move().
+#define REACH_DEPTH_STORAGE_SANITY 5
 
 //ITEM INVENTORY SLOT BITMASKS
 /// Suit slot (armors, costumes, space suits, etc.)

code/_onclick/click.dm

@@ -169,7 +169,7 @@
 			UnarmedAttack(item_atom, TRUE, modifiers)
 
 	//Standard reach turf to turf or reaching inside storage
-	if(CanReach(A,W))
+	if(A.IsReachableBy(src, W))
 		if(W)
 			W.melee_attack_chain(src, A, params)
 		else
@@ -212,49 +212,49 @@
 	return FALSE
 
 /**
- * A backwards depth-limited breadth-first-search to see if the target is
- * logically "in" anything adjacent to us.
+ * Returns TRUE if a movable can "Reach" this atom. This is defined as adjacency
+ *
+ * This is used for crafting by hitting the floor with items.
+ * The inital use case is glass sheets breaking in to shards when the floor is hit.
+ * Args:
+ * * user: The movable trying to reach us.
+ * * tool: An optional item being used.
+ * * depth: How deep nested inside of an atom contents stack an object can be.
+ * * direct_access: Do not override. Used for recursion.
  */
-/atom/movable/proc/CanReach(atom/ultimate_target, obj/item/tool, view_only = FALSE)
-	var/list/direct_access = DirectAccess()
-	var/depth = 1 + (view_only ? STORAGE_VIEW_DEPTH : INVENTORY_DEPTH)
-
-	var/list/closed = list()
-	var/list/checking = list(ultimate_target)
-
-	while (checking.len && depth > 0)
-		var/list/next = list()
-		--depth
-
-		for(var/atom/target in checking)  // will filter out nulls
-			if(closed[target] || isarea(target))  // avoid infinity situations
-				continue
-
-			// Before we check CanBeReached() (adjacency), let's do some less expensive checks to see if we need to bother.
-			// A target that is not a turf or on a turf is unclickable, exceptions:
-			// * The object is directly accessible to the user (DirectAccess())
-			// * The object has the ALWAYS_CLICKABLE trait.
-			// * The object is inside of an atom with an associated atom_storage datum.
-			// If any of the above are true, we THEN check adjacency.
-			if(isturf(target) || isturf(target.loc) || (target in direct_access) || (HAS_TRAIT(target, TRAIT_SKIP_BASIC_REACH_CHECK)) || target.loc?.atom_storage)
-				if(target.CanBeReached(src, tool))
-					return TRUE
+/atom/proc/IsReachableBy(atom/movable/user, obj/item/tool, depth = INFINITY, direct_access = user.DirectAccess())
+	SHOULD_NOT_OVERRIDE(TRUE)
 
-			closed[target] = TRUE
+	if(isnull(user))
+		return FALSE
 
-			if (!target.loc)
-				continue
+	if(src in direct_access)
+		return TRUE
 
-			if(target.loc.atom_storage)
-				next += target.loc
+	if(isturf(loc) || isturf(src) || HAS_TRAIT(src, TRAIT_SKIP_BASIC_REACH_CHECK))
+		if(CheckReachableAdjacency(user, tool))
+			return TRUE
 
-		checking = next
-	return FALSE
+	depth--
+	if(depth <= 0)
+		return FALSE
 
-/// Reciprocal function for CanReach().
-/atom/proc/CanBeReached(atom/movable/reacher, obj/item/tool)
+	if(isnull(loc) || isarea(loc) || !loc.IsContainedAtomAccessible(src))
+		return FALSE
+
+	return loc.IsReachableBy(user, tool, depth, direct_access)
+
+/// Checks if a reacher is adjacent to us.
+/atom/proc/CheckReachableAdjacency(atom/movable/reacher, obj/item/tool)
 	return reacher.Adjacent(src) || (tool && CheckToolReach(reacher, src, tool.reach))
 
+/// Returns TRUE if an atom contained within our contents is reachable.
+/atom/proc/IsContainedAtomAccessible(atom/contained)
+	return TRUE
+
+/atom/movable/IsContainedAtomAccessible(atom/contained)
+	return !!atom_storage
+
 /atom/movable/proc/DirectAccess()
 	return list(src, loc)
 
@@ -284,7 +284,7 @@
 			dummy.invisibility = INVISIBILITY_ABSTRACT
 			for(var/i in 1 to reach) //Limit it to that many tries
 				var/turf/T = get_step(dummy, get_dir(dummy, there))
-				if(dummy.CanReach(there))
+				if(there.IsReachableBy(dummy))
 					qdel(dummy)
 					return TRUE
 				if(!dummy.Move(T)) //we're blocked!
@@ -388,7 +388,7 @@
 		return FALSE
 
 /mob/living/CtrlClick(mob/user, list/params)
-	if(!isliving(user) || !user.CanReach(src) || user.incapacitated())
+	if(!isliving(user) || !IsReachableBy(user) || user.incapacitated())
 		return ..()
 
 	if(world.time < user.next_move)
@@ -404,7 +404,7 @@
 
 /mob/living/carbon/human/CtrlClick(mob/user, list/params)
 
-	if(!ishuman(user) || !user.CanReach(src) || user.incapacitated())
+	if(!ishuman(user) || !IsReachableBy(user) || user.incapacitated())
 		return ..()
 
 	if(world.time < user.next_move)

code/_onclick/hud/screen_objects.dm

@@ -340,7 +340,7 @@
 	if(ismecha(user.loc)) // stops inventory actions in a mech
 		return TRUE
 
-	if(!user.CanReach(dropping))
+	if(!dropping.IsReachableBy(user))
 		return TRUE
 
 	var/obj/item/I = dropping
@@ -588,7 +588,7 @@
 	if(ismecha(user.loc)) // stops inventory actions in a mech
 		return TRUE
 
-	if(!user.CanReach(dropping))
+	if(!dropping.IsReachableBy(user))
 		return TRUE
 
 	var/obj/item/I = dropping

code/datums/ai/_ai_behavior.dm

@@ -42,7 +42,7 @@
 		if(atom_basic_score < best_score)
 			continue
 
-		if(pawn.CanReach(A))
+		if(A.IsReachableBy(pawn))
 			best_score = atom_basic_score
 			ideal_atom = A
 			continue

code/datums/ai/_ai_controller.dm

@@ -180,7 +180,7 @@ multiple modular subtrees with behaviors
 
 		///Stops pawns from performing such actions that should require the target to be adjacent.
 		var/atom/movable/moving_pawn = pawn
-		var/can_reach = !(current_behavior.behavior_flags & AI_BEHAVIOR_REQUIRE_REACH) || moving_pawn.CanReach(current_movement_target)
+		var/can_reach = !(current_behavior.behavior_flags & AI_BEHAVIOR_REQUIRE_REACH) || current_movement_target.IsReachableBy(moving_pawn)
 		if(can_reach && current_behavior.required_distance >= get_dist(moving_pawn, current_movement_target)) ///Are we close enough to engage?
 			if(ai_movement.moving_controllers[src] == current_movement_target) //We are close enough, if we're moving stop.
 				ai_movement.stop_moving_towards(src)

code/datums/ai/dog/dog_behaviors.dm

@@ -11,7 +11,7 @@
 	var/obj/item/fetch_thing = controller.blackboard[BB_FETCH_TARGET]
 
 	//either we can't pick it up, or we'd rather eat it, so stop trying.
-	if(fetch_thing.anchored || !isturf(fetch_thing.loc) || IS_EDIBLE(fetch_thing) || !living_pawn.CanReach(fetch_thing))
+	if(fetch_thing.anchored || !isturf(fetch_thing.loc) || IS_EDIBLE(fetch_thing) || !fetch_thing.IsReachableBy(living_pawn))
 		return BEHAVIOR_PERFORM_FAILURE
 
 	return BEHAVIOR_PERFORM_SUCCESS

code/datums/ai/generic/generic_behaviors.dm

@@ -92,7 +92,7 @@
 	var/obj/item/held_item = pawn.get_item_by_slot(pawn.get_active_hand())
 	var/atom/target = controller.blackboard[target_key]
 
-	if(!target || !pawn.CanReach(target))
+	if(!target || !target.IsReachableBy(pawn))
 		return BEHAVIOR_PERFORM_COOLDOWN | BEHAVIOR_PERFORM_FAILURE
 
 	pawn.set_combat_mode(FALSE)
@@ -118,7 +118,7 @@
 	var/obj/item/held_item = pawn.get_item_by_slot(pawn.get_active_hand())
 	var/atom/target = controller.blackboard[target_key]
 
-	if(!target || !pawn.CanReach(target) || !isliving(target))
+	if(!target || !target.IsReachableBy(pawn) || !isliving(target))
 		return BEHAVIOR_PERFORM_COOLDOWN | BEHAVIOR_PERFORM_FAILURE
 
 	var/mob/living/living_target = target

code/datums/ai/monkey/monkey_behaviors.dm

@@ -70,7 +70,7 @@
 	var/mob/living/victim = target.loc
 	var/mob/living/living_pawn = controller.pawn
 
-	if(!istype(victim) || !living_pawn.CanReach(victim))
+	if(!istype(victim) || !victim.IsReachableBy(living_pawn))
 		finish_action(controller, FALSE)
 		return
 
@@ -82,7 +82,7 @@
 
 	var/success = FALSE
 
-	if(do_after(living_pawn, victim, MONKEY_ITEM_SNATCH_DELAY, DO_PUBLIC, display = image('icons/hud/do_after.dmi', "pickpocket")) && target && living_pawn.CanReach(victim))
+	if(do_after(living_pawn, victim, MONKEY_ITEM_SNATCH_DELAY, DO_PUBLIC, display = image('icons/hud/do_after.dmi', "pickpocket")) && target && victim.IsReachableBy(living_pawn))
 
 		for(var/obj/item/I in victim.held_items)
 			if(I == target)
@@ -188,7 +188,7 @@
 		controller.set_blackboard_key(BB_MONKEY_GUN_WORKED, TRUE)
 
 	// attack with weapon if we have one
-	if(living_pawn.CanReach(target, weapon))
+	if(target.IsReachableBy(living_pawn, weapon))
 		if(weapon)
 			weapon.melee_attack_chain(living_pawn, target)
 		else

code/datums/elements/openspace_item_click_handler.dm

@@ -21,4 +21,4 @@
 		return
 	var/turf/turf_above = GetAbove(target)
 	if(turf_above?.z == user.z)
-		INVOKE_ASYNC(source, TYPE_PROC_REF(/obj/item, handle_openspace_click), turf_above, user, user.CanReach(turf_above, source), click_parameters)
+		INVOKE_ASYNC(source, TYPE_PROC_REF(/obj/item, handle_openspace_click), turf_above, user, turf_above.IsReachableBy(user, source), click_parameters)

code/datums/status_effects/neutral.dm

@@ -135,11 +135,11 @@
 	if(give_alert_override)
 		give_alert_type = give_alert_override
 
-	if(offered && owner.CanReach(offered) && !IS_DEAD_OR_INCAP(offered) && offered.can_hold_items())
+	if(offered && offered.IsReachableBy(owner) && !IS_DEAD_OR_INCAP(offered) && offered.can_hold_items())
 		register_candidate(offered)
 	else
 		for(var/mob/living/carbon/possible_taker in orange(1, owner))
-			if(!owner.CanReach(possible_taker) || IS_DEAD_OR_INCAP(possible_taker) || !possible_taker.can_hold_items())
+			if(!possible_taker.IsReachableBy(owner) || IS_DEAD_OR_INCAP(possible_taker) || !possible_taker.can_hold_items())
 				continue
 			register_candidate(possible_taker)
 
@@ -178,7 +178,7 @@
 /// One of our possible takers moved, see if they left us hanging
 /datum/status_effect/offering/proc/check_taker_in_range(mob/living/carbon/taker)
 	SIGNAL_HANDLER
-	if(owner.CanReach(taker) && !IS_DEAD_OR_INCAP(taker))
+	if(taker.IsReachableBy(owner) && !IS_DEAD_OR_INCAP(taker))
 		return
 
 	to_chat(taker, span_warning("You moved out of range of [owner]!"))
@@ -190,7 +190,7 @@
 
 	for(var/i in possible_takers)
 		var/mob/living/carbon/checking_taker = i
-		if(!istype(checking_taker) || !owner.CanReach(checking_taker) || IS_DEAD_OR_INCAP(checking_taker))
+		if(!istype(checking_taker) || !checking_taker.IsReachableBy(owner) || IS_DEAD_OR_INCAP(checking_taker))
 			remove_candidate(checking_taker)
 
 /// We lost the item, give it up

code/datums/wires/_wires.dm

@@ -14,7 +14,7 @@
 /atom/proc/attempt_wire_interaction(mob/user)
 	if(!wires)
 		return WIRE_INTERACTION_FAIL
-	if(!user.CanReach(src))
+	if(!IsReachableBy(user))
 		return WIRE_INTERACTION_FAIL
 	wires.interact(user)
 	return WIRE_INTERACTION_BLOCK

code/game/machinery/doors/airlock.dm

@@ -804,7 +804,7 @@
 		security_level = AIRLOCK_SECURITY_PLASTEEL_O
 		return .
 	if(note)
-		if(user.CanReach(src))
+		if(IsReachableBy(user))
 			user.visible_message(span_notice("[user] cuts down [note] from [src]."), span_notice("You remove [note] from [src]."))
 		else //telekinesis
 			visible_message(span_notice("[tool] cuts down [note] from [src]."))

code/game/machinery/fax_machine.dm

@@ -590,7 +590,7 @@ GLOBAL_LIST_EMPTY(fax_machines)
 	if(!paper)
 		return
 
-	if(user && user.CanReach(src))
+	if(user && IsReachableBy(user))
 		user.put_in_hands(paper)
 	else
 		paper.forceMove(drop_location())
@@ -622,7 +622,7 @@ GLOBAL_LIST_EMPTY(fax_machines)
 	if(!silent)
 		z_flick("fax_receive", src)
 		balloon_alert_to_viewers("removed [stored_paper]")
-	if(user && user.CanReach(src))
+	if(user && IsReachableBy(user))
 		user.put_in_hands(stored_paper)
 	else
 		stored_paper.forceMove(drop_location())
@@ -642,7 +642,7 @@ GLOBAL_LIST_EMPTY(fax_machines)
 	if(!silent)
 		z_flick("fax_receive", src)
 		balloon_alert_to_viewers("removed [received_paper]")
-	if(user && user.CanReach(src))
+	if(user && IsReachableBy(user))
 		user.put_in_hands(received_paper)
 	else
 		received_paper.forceMove(drop_location())

code/game/objects/buckling.dm

@@ -343,7 +343,7 @@
  * user - The mob unbuckling buckled_mob
  */
 /atom/movable/proc/user_unbuckle_mob(mob/living/buckled_mob, mob/user)
-	if(!(buckled_mob in buckled_mobs) || !user.CanReach(buckled_mob))
+	if(!(buckled_mob in buckled_mobs) || !buckled_mob.IsReachableBy(user))
 		return
 	var/mob/living/M = unbuckle_mob(buckled_mob)
 	if(M)

code/game/objects/items/dyekit.dm

@@ -35,7 +35,7 @@
 		return
 
 	var/new_grad_color = input(user, "Choose a secondary hair color:", "Character Preference",human_target.grad_color) as color|null
-	if(!new_grad_color || !user.canUseTopic(src, USE_CLOSE|USE_DEXTERITY) || !user.CanReach(target))
+	if(!new_grad_color || !user.canUseTopic(src, USE_CLOSE|USE_DEXTERITY) || !target.IsReachableBy(user))
 		return
 
 	to_chat(user, span_notice("You start applying the hair dye..."))

code/game/objects/items/stacks/medical.dm

@@ -168,7 +168,7 @@
 			to_chat(user, span_warning("You need at least two gauzes to do this!"))
 			return
 		new /obj/item/stack/sheet/cloth(I.drop_location())
-		if(user.CanReach(src))
+		if(IsReachableBy(user))
 			user.visible_message(span_notice("[user] cuts [src] into pieces of cloth with [I]."), \
 				span_notice("You cut [src] into pieces of cloth with [I]."), \
 				span_hear("You hear cutting."))

code/game/objects/structures/bedsheet_bin.dm

@@ -38,7 +38,7 @@ LINEN BINS
 		dying_key = DYE_REGISTRY_DOUBLE_BEDSHEET
 
 /obj/item/bedsheet/attack_self(mob/living/user)
-	if(!user.CanReach(src)) //No telekenetic grabbing.
+	if(!IsReachableBy(user)) //No telekenetic grabbing.
 		return
 	if(!user.dropItemToGround(src))
 		return

code/game/objects/structures/watercloset.dm

@@ -29,7 +29,7 @@
 		log_combat(user, swirlie, "swirlied (brute)")
 		swirlie.adjustBruteLoss(5)
 
-	else if(cistern && !open && user.CanReach(src))
+	else if(cistern && !open && IsReachableBy(user))
 		if(!contents.len)
 			to_chat(user, span_notice("The cistern is empty."))
 		else

code/modules/antagonists/wizard/equipment/soulstone.dm

@@ -335,7 +335,7 @@
 /obj/item/soulstone/proc/check_menu(mob/user, obj/structure/constructshell/shell)
 	if(!istype(user))
 		return FALSE
-	if(user.incapacitated() || !user.is_holding(src) || !user.CanReach(shell, src))
+	if(user.incapacitated() || !user.is_holding(src) || !shell.IsReachableBy(user, src))
 		return FALSE
 	return TRUE
 
@@ -448,7 +448,7 @@
 		var/list/consenting_candidates = poll_ghost_candidates("Would you like to play as a Shade?", "Cultist", ROLE_CULTIST, 50, POLL_IGNORE_SHADE)
 		if(consenting_candidates.len)
 			chosen_ghost = pick(consenting_candidates)
-	if(!victim || user.incapacitated() || !user.is_holding(src) || !user.CanReach(victim, src))
+	if(!victim || user.incapacitated() || !user.is_holding(src) || !victim.IsReachableBy(user, src))
 		return FALSE
 	if(!chosen_ghost || !chosen_ghost.client)
 		to_chat(user, span_danger("There were no spirits willing to become a shade."))

code/modules/art/paintings.dm

@@ -248,7 +248,7 @@
 /obj/item/canvas/proc/can_select_frame(mob/user)
 	if(!istype(loc, /obj/structure/sign/painting))
 		return FALSE
-	if(!user?.CanReach(loc) || IS_DEAD_OR_INCAP(user))
+	if(!loc.IsReachableBy(user) || IS_DEAD_OR_INCAP(user))
 		return FALSE
 	if(!last_patron || !IS_WEAKREF_OF(user?.mind, last_patron))
 		return FALSE
@@ -634,7 +634,7 @@
 	var/our_dir = get_dir(user, on_wall)
 	var/check_dir = our_dir & (EAST|WEST) ? NORTH : EAST
 	var/turf/closed/wall/second_wall = get_step(on_wall, check_dir)
-	if(!istype(second_wall) || !user.CanReach(second_wall))
+	if(!istype(second_wall) || !second_wall.IsReachableBy(user))
 		to_chat(user, span_warning("You need a reachable wall to the [check_dir == EAST ? "right" : "left"] of this one to mount this frame!"))
 		return FALSE
 	if(check_wall_item(second_wall, our_dir, wall_external))