/atom/proc/examine() rework. #4836

MistakeNot4892 · 2025-02-03T12:36:24Z

TODO

Split up examine()
Convert all examine() uses to new procs.
Remove examine() stub.

Description of changes

examine() is now examined_by().
examined_by() assembles string lists via three procs, in order:
- get_examine_header()
- get_examine_strings()
- get_examine_hints()

Why and what will this PR improve

Allows control over ordering of examination output.
Nicer, more readable code.
Probably more performant given the removed string ops.

Authorship

Myself.

Changelog

Nothing player-facing.

out-of-phaze

i don't know how i managed to review this but i did.

out-of-phaze · 2025-02-04T18:44:31Z

code/_onclick/hud/screen/screen_maneuver.dm

@@ -8,15 +8,12 @@
 		var/mob/living/user_living = user
 		user_living.prepare_maneuver()

-/obj/screen/maneuver/examine(mob/user, distance)
+/obj/screen/maneuver/examined_by(mob/user, distance, infix, suffix)


Suggested change

/obj/screen/maneuver/examined_by(mob/user, distance, infix, suffix)

/obj/screen/maneuver/get_examine_strings(mob/user, distance, infix, suffix)

Intentional, doesn't need the full proc, same for the other screen elem.

issue is the return type, examined_by doesn't return strings, you need a direct to_chat

Kept as examined_by() but fixed return.

out-of-phaze · 2025-02-04T18:44:43Z

code/_onclick/hud/screen/screen_intent.dm

@@ -34,10 +34,10 @@
 	if(. && intent && parent)
 		parent.set_intent(intent)

-/obj/screen/intent_button/examine(mob/user, distance)
+/obj/screen/intent_button/examined_by(mob/user, distance, infix, suffix)


Suggested change

/obj/screen/intent_button/examined_by(mob/user, distance, infix, suffix)

/obj/screen/intent_button/get_examine_strings(mob/user, distance, infix, suffix)

Per above, kept as examined_by() but fixed return.

out-of-phaze · 2025-02-04T18:45:30Z

code/game/objects/items/rescuebag.dm

 	if(Adjacent(user)) //The bag's rather thick and opaque from a distance.
-		to_chat(user, "<span class='info'>You peer into \the [src].</span>")
+		. += SPAN_INFO("You peer into \the [src].")


examined_by has a bool return type, this is invalid. you probably do legit just want to_chat() here

code/modules/weather/_weather.dm

out-of-phaze

couple more notes i found, think that's it

out-of-phaze · 2025-02-04T18:53:43Z

code/game/machinery/doors/firedoor.dm

@@ -117,16 +117,17 @@
 	RETURN_TYPE(/decl/material)
 	return GET_DECL(/decl/material/solid/metal/steel)

-/obj/machinery/door/firedoor/examine(mob/user, distance)
+/obj/machinery/door/firedoor/get_examine_strings(mob/user, distance, infix, suffix)


missed a to_chat on line 142

out-of-phaze · 2025-02-04T18:57:59Z

code/game/machinery/_machines_base/machinery.dm

 	for(var/path in uncreated_component_parts)
 		var/obj/item/thing = path
-		to_chat(user, "<span class='notice'>	[initial(thing.name)] ([uncreated_component_parts[path] || 1])</span>")
+		. += SPAN_NOTICE("	[initial(thing.name)] ([uncreated_component_parts[path] || 1])")
+	if(length(.) && show_directly)


not a fan of this pattern, i think maybe display_parts should always return a list and stuff that passes show_directly = TRUE should just use to_chat() directly, or there should be a separate proc that does that

out-of-phaze · 2025-02-04T19:22:01Z

code/modules/paperwork/paper_sticky.dm

@@ -50,10 +50,10 @@
 		return .
 	return ..()

-/obj/item/sticky_pad/examine(mob/user)
+/obj/item/sticky_pad/examined_by(mob/user, distance, infix, suffix)


Suggested change

/obj/item/sticky_pad/examined_by(mob/user, distance, infix, suffix)

/obj/item/sticky_pad/get_examine_strings(mob/user, distance, infix, suffix)

Split into examine_strings and examine_hints.

out-of-phaze · 2025-02-04T19:23:23Z

code/game/objects/items/weapons/tape.dm

-/obj/item/duct_tape/examine()
-	return stuck ? stuck.examine(arglist(args)) : ..()
+/obj/item/duct_tape/examined_by(mob/user, distance, infix, suffix)
+	return stuck ? stuck.examined_by(arglist(args)) : ..()


Suggested change

return stuck ? stuck.examined_by(arglist(args)) : ..()

return stuck ? stuck.examined_by(user, distance, infix, suffix) : ..()

i don't really like the use of arglist here tbh. like, we've standardized the args, haven't we?

Yeah I replaced it everywhere I saw it, missed this one.

Addressed

out-of-phaze

tbh maybe display_parts could be named list_part_info as it no longer handles the display part but like. not a big deal tbh

out-of-phaze

2 days + conflict resolution, good to go

MistakeNot4892 added the work in progress This PR is under development and shouldn't be merged. label Feb 3, 2025

MistakeNot4892 force-pushed the rework/examine branch 2 times, most recently from 666f6ea to 78a388c Compare February 4, 2025 05:33

out-of-phaze requested changes Feb 4, 2025

View reviewed changes

out-of-phaze previously requested changes Feb 4, 2025

View reviewed changes

MistakeNot4892 force-pushed the rework/examine branch from 78a388c to 6cbd4e4 Compare February 6, 2025 06:57

MistakeNot4892 added ready for review This PR is ready for review and merge. and removed work in progress This PR is under development and shouldn't be merged. labels Feb 7, 2025

MistakeNot4892 force-pushed the rework/examine branch from 6cbd4e4 to c3dd58d Compare February 7, 2025 00:33

out-of-phaze previously approved these changes Feb 7, 2025

View reviewed changes

out-of-phaze added awaiting author This PR is awaiting action from the author before it can be merged. has conflicts This PR needs updating and conflict resolution before it can be merged. and removed ready for review This PR is ready for review and merge. labels Feb 9, 2025

MistakeNot4892 added 3 commits February 10, 2025 10:15

examine() -> get_examine_strings(), examined_by().

d61b75f

Adjusting for feedback from PR.

14d7f0c

display_parts() no longer displays itself.

e821679

MistakeNot4892 dismissed out-of-phaze’s stale review via e821679 February 9, 2025 23:16

MistakeNot4892 force-pushed the rework/examine branch from c3dd58d to e821679 Compare February 9, 2025 23:16

MistakeNot4892 added ready for review This PR is ready for review and merge. and removed awaiting author This PR is awaiting action from the author before it can be merged. has conflicts This PR needs updating and conflict resolution before it can be merged. labels Feb 10, 2025

out-of-phaze approved these changes Feb 10, 2025

View reviewed changes

out-of-phaze merged commit bccf8ce into NebulaSS13:dev Feb 10, 2025
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

/atom/proc/examine() rework. #4836

/atom/proc/examine() rework. #4836

MistakeNot4892 commented Feb 3, 2025 •

edited

Loading

out-of-phaze left a comment

out-of-phaze Feb 4, 2025

MistakeNot4892 Feb 4, 2025

out-of-phaze Feb 4, 2025 •

edited

Loading

MistakeNot4892 Feb 6, 2025

out-of-phaze Feb 4, 2025

MistakeNot4892 Feb 6, 2025

out-of-phaze Feb 4, 2025

MistakeNot4892 Feb 6, 2025

out-of-phaze left a comment

out-of-phaze Feb 4, 2025

out-of-phaze Feb 4, 2025

MistakeNot4892 Feb 7, 2025

out-of-phaze Feb 4, 2025

MistakeNot4892 Feb 6, 2025

out-of-phaze Feb 4, 2025

MistakeNot4892 Feb 4, 2025

out-of-phaze left a comment

out-of-phaze left a comment

	/obj/screen/maneuver/examined_by(mob/user, distance, infix, suffix)
	/obj/screen/maneuver/get_examine_strings(mob/user, distance, infix, suffix)

	/obj/screen/intent_button/examined_by(mob/user, distance, infix, suffix)
	/obj/screen/intent_button/get_examine_strings(mob/user, distance, infix, suffix)

	/obj/item/sticky_pad/examined_by(mob/user, distance, infix, suffix)
	/obj/item/sticky_pad/get_examine_strings(mob/user, distance, infix, suffix)

	return stuck ? stuck.examined_by(arglist(args)) : ..()
	return stuck ? stuck.examined_by(user, distance, infix, suffix) : ..()

/atom/proc/examine() rework. #4836

/atom/proc/examine() rework. #4836

Conversation

MistakeNot4892 commented Feb 3, 2025 • edited Loading

TODO

Description of changes

Why and what will this PR improve

Authorship

Changelog

out-of-phaze left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

out-of-phaze Feb 4, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

out-of-phaze left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

out-of-phaze left a comment

Choose a reason for hiding this comment

out-of-phaze left a comment

Choose a reason for hiding this comment

MistakeNot4892 commented Feb 3, 2025 •

edited

Loading

out-of-phaze Feb 4, 2025 •

edited

Loading