update_appearance (tgstation#55468)

Creates update_name and update_desc Creates the wrapper proc update_appearance to batch update_name, update_desc, and update_icon together Less non-icon handling code in update_icon and friends Signal hooks for things that want to change names and descriptions 99%+ of the changes in this are just from switching everything over to update_appearance from update_icon
hmlm2001 · Feb 19, 2021 · e4079c8 · e4079c8
1 parent dc4b722
commit e4079c8
Show file tree

Hide file tree

Showing 585 changed files with 4,688 additions and 4,132 deletions.
diff --git a/code/__DEFINES/dcs/signals.dm b/code/__DEFINES/dcs/signals.dm
@@ -82,13 +82,30 @@
 	#define EXAMINE_POSITION_BEFORE (1<<1)
 	//End positions
 	#define COMPONENT_EXNAME_CHANGED (1<<0)
-///from base of atom/update_icon(): ()
+
+///from base of [/atom/proc/update_appearance]: (updates)
+#define COMSIG_ATOM_UPDATE_APPEARANCE "atom_update_appearance"
+	/// If returned from [COMSIG_ATOM_UPDATE_APPEARANCE] it prevents the atom from updating its name.
+	#define COMSIG_ATOM_NO_UPDATE_NAME UPDATE_NAME
+	/// If returned from [COMSIG_ATOM_UPDATE_APPEARANCE] it prevents the atom from updating its desc.
+	#define COMSIG_ATOM_NO_UPDATE_DESC UPDATE_DESC
+	/// If returned from [COMSIG_ATOM_UPDATE_APPEARANCE] it prevents the atom from updating its icon.
+	#define COMSIG_ATOM_NO_UPDATE_ICON UPDATE_ICON
+///from base of [/atom/proc/update_name]: (updates)
+#define COMSIG_ATOM_UPDATE_NAME "atom_update_name"
+///from base of [/atom/proc/update_desc]: (updates)
+#define COMSIG_ATOM_UPDATE_DESC "atom_update_desc"
+///from base of [/atom/update_icon]: ()
 #define COMSIG_ATOM_UPDATE_ICON "atom_update_icon"
-	#define COMSIG_ATOM_NO_UPDATE_ICON_STATE (1<<0)
-	#define COMSIG_ATOM_NO_UPDATE_OVERLAYS (1<<1)
-///from base of atom/update_overlays(): (list/new_overlays)
+	/// If returned from [COMSIG_ATOM_UPDATE_ICON] it prevents the atom from updating its icon state.
+	#define COMSIG_ATOM_NO_UPDATE_ICON_STATE UPDATE_ICON_STATE
+	/// If returned from [COMSIG_ATOM_UPDATE_ICON] it prevents the atom from updating its overlays.
+	#define COMSIG_ATOM_NO_UPDATE_OVERLAYS UPDATE_OVERLAYS
+///from base of [atom/update_icon_state]: ()
+#define COMSIG_ATOM_UPDATE_ICON_STATE "atom_update_icon_state"
+///from base of [/atom/update_overlays]: (list/new_overlays)
 #define COMSIG_ATOM_UPDATE_OVERLAYS "atom_update_overlays"
-///from base of atom/update_icon(): (signalOut, did_anything)
+///from base of [/atom/update_icon]: (signalOut, did_anything)
 #define COMSIG_ATOM_UPDATED_ICON "atom_updated_icon"
 ///from base of atom/Entered(): (atom/movable/entering, /atom)
 #define COMSIG_ATOM_ENTERED "atom_entered"

diff --git a/code/__DEFINES/flags.dm b/code/__DEFINES/flags.dm
@@ -62,6 +62,18 @@ GLOBAL_LIST_INIT(bitflags, list(1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 204
 #define SUPERMATTER_IGNORES_1 (1 << 23)
 
 
+// Update flags for [/atom/proc/update_appearance]
+/// Update the atom's name
+#define UPDATE_NAME (1<<0)
+/// Update the atom's desc
+#define UPDATE_DESC (1<<1)
+/// Update the atom's icon state
+#define UPDATE_ICON_STATE (1<<2)
+/// Update the atom's overlays
+#define UPDATE_OVERLAYS (1<<3)
+/// Update the atom's icon
+#define UPDATE_ICON (UPDATE_ICON_STATE|UPDATE_OVERLAYS)
+
 /// If the thing can reflect light (lasers/energy)
 #define RICOCHET_SHINY (1<<0)
 /// If the thing can reflect matter (bullets/bomb shrapnel)

diff --git a/code/_onclick/hud/action_button.dm b/code/_onclick/hud/action_button.dm
@@ -130,7 +130,7 @@
 		name = "Show Buttons"
 	else
 		name = "Hide Buttons"
-	update_icon()
+	update_appearance()
 	usr.update_action_buttons()
 
 /atom/movable/screen/movable/action_button/hide_toggle/AltClick(mob/user)
@@ -151,14 +151,11 @@
 	hide_icon = settings["toggle_icon"]
 	hide_state = settings["toggle_hide"]
 	show_state = settings["toggle_show"]
-	update_icon()
+	update_appearance()
 
 /atom/movable/screen/movable/action_button/hide_toggle/update_overlays()
 	. = ..()
-	if(hidden)
-		. += show_appearance
-	else
-		. += hide_appearance
+	. += hidden ? show_appearance : hide_appearance
 
 /atom/movable/screen/movable/action_button/MouseEntered(location,control,params)
 	if(!QDELETED(src))

diff --git a/code/_onclick/hud/alien.dm b/code/_onclick/hud/alien.dm
@@ -87,7 +87,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = ui_style
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_above_movement
 	pull_icon.hud = src
 	static_inventory += pull_icon
@@ -109,14 +109,14 @@
 
 	zone_select = new /atom/movable/screen/zone_sel/alien()
 	zone_select.hud = src
-	zone_select.update_icon()
+	zone_select.update_appearance()
 	static_inventory += zone_select
 
 	for(var/atom/movable/screen/inventory/inv in (static_inventory + toggleable_inventory))
 		if(inv.slot_id)
 			inv.hud = src
 			inv_slots[TOBITSHIFT(inv.slot_id) + 1] = inv
-			inv.update_icon()
+			inv.update_appearance()
 
 /datum/hud/alien/persistent_inventory_update()
 	if(!mymob)

diff --git a/code/_onclick/hud/alien_larva.dm b/code/_onclick/hud/alien_larva.dm
@@ -21,7 +21,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = 'icons/hud/screen_alien.dmi'
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_above_movement
 	pull_icon.hud = src
 	hotkeybuttons += pull_icon
@@ -33,5 +33,5 @@
 
 	zone_select = new /atom/movable/screen/zone_sel/alien()
 	zone_select.hud = src
-	zone_select.update_icon()
+	zone_select.update_appearance()
 	static_inventory += zone_select
diff --git a/code/_onclick/hud/drones.dm b/code/_onclick/hud/drones.dm
@@ -26,7 +26,7 @@
 		if(inv.slot_id)
 			inv.hud = src
 			inv_slots[TOBITSHIFT(inv.slot_id) + 1] = inv
-			inv.update_icon()
+			inv.update_appearance()
 
 
 /datum/hud/dextrous/drone/persistent_inventory_update()

diff --git a/code/_onclick/hud/families.dm b/code/_onclick/hud/families.dm
@@ -3,6 +3,7 @@
 	desc = "Shows the current level of hostility the space police is planning to rain down on you. Better be careful."
 	icon = 'icons/obj/gang/wanted_160x32.dmi'
 	icon_state = "wanted_0"
+	base_icon_state = "wanted"
 	screen_loc = ui_wanted_lvl
 	/// Wanted level, affects the hud icon. Level 0 is default, and the level 0 icon is blank, so in case of no families gamemode (and thus no wanted level), this HUD element will never appear.
 	var/level = 0
@@ -14,7 +15,7 @@
 
 /atom/movable/screen/wanted/Initialize()
 	. = ..()
-	update_icon()
+	update_appearance()
 
 /atom/movable/screen/wanted/MouseEntered(location,control,params)
 	openToolTip(usr,src,params,title = name,content = desc, theme = "alerttooltipstyle")
@@ -23,5 +24,5 @@
 	closeToolTip(usr)
 
 /atom/movable/screen/wanted/update_icon_state()
-	. = ..()
-	icon_state = "wanted_[level][cops_arrived ? "_active" : ""]"
+	icon_state = "[base_icon_state]_[level][cops_arrived ? "_active" : null]"
+	return ..()
diff --git a/code/_onclick/hud/generic_dextrous.dm b/code/_onclick/hud/generic_dextrous.dm
@@ -11,7 +11,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = ui_style
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_drone_pull
 	pull_icon.hud = src
 	static_inventory += pull_icon
@@ -42,7 +42,7 @@
 	zone_select = new /atom/movable/screen/zone_sel()
 	zone_select.icon = ui_style
 	zone_select.hud = src
-	zone_select.update_icon()
+	zone_select.update_appearance()
 	static_inventory += zone_select
 
 	using = new /atom/movable/screen/area_creator
@@ -56,7 +56,7 @@
 		if(inv.slot_id)
 			inv.hud = src
 			inv_slots[TOBITSHIFT(inv.slot_id) + 1] = inv
-			inv.update_icon()
+			inv.update_appearance()
 
 /datum/hud/dextrous/persistent_inventory_update()
 	if(!mymob)

diff --git a/code/_onclick/hud/guardian.dm b/code/_onclick/hud/guardian.dm
@@ -7,7 +7,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = ui_style
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_living_pull
 	pull_icon.hud = src
 	static_inventory += pull_icon
@@ -70,7 +70,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = 'icons/hud/guardian.dmi'
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_living_pull
 	pull_icon.hud = src
 	static_inventory += pull_icon

diff --git a/code/_onclick/hud/hud.dm b/code/_onclick/hud/hud.dm
@@ -297,7 +297,7 @@ GLOBAL_LIST_INIT(available_ui_styles, list(
 		hand_slots["[i]"] = hand_box
 		hand_box.hud = src
 		static_inventory += hand_box
-		hand_box.update_icon()
+		hand_box.update_appearance()
 
 	var/i = 1
 	for(var/atom/movable/screen/swap_hand/SH in static_inventory)

diff --git a/code/_onclick/hud/human.dm b/code/_onclick/hud/human.dm
@@ -293,7 +293,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = ui_style
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_above_intent
 	pull_icon.hud = src
 	static_inventory += pull_icon
@@ -309,7 +309,7 @@
 	zone_select =  new /atom/movable/screen/zone_sel()
 	zone_select.icon = ui_style
 	zone_select.hud = src
-	zone_select.update_icon()
+	zone_select.update_appearance()
 	static_inventory += zone_select
 
 	combo_display = new /atom/movable/screen/combo()
@@ -319,7 +319,7 @@
 		if(inv.slot_id)
 			inv.hud = src
 			inv_slots[TOBITSHIFT(inv.slot_id) + 1] = inv
-			inv.update_icon()
+			inv.update_appearance()
 
 	update_locked_slots()
 

diff --git a/code/_onclick/hud/living.dm b/code/_onclick/hud/living.dm
@@ -6,7 +6,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = ui_style
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_living_pull
 	pull_icon.hud = src
 	static_inventory += pull_icon

diff --git a/code/_onclick/hud/ooze.dm b/code/_onclick/hud/ooze.dm
@@ -5,7 +5,7 @@
 	zone_select = new /atom/movable/screen/zone_sel()
 	zone_select.icon = ui_style
 	zone_select.hud = src
-	zone_select.update_icon()
+	zone_select.update_appearance()
 	static_inventory += zone_select
 
 	alien_plasma_display = new /atom/movable/screen/ooze_nutrition_display //Just going to use the alien plasma display because making new vars for each object is braindead.

diff --git a/code/_onclick/hud/revenanthud.dm b/code/_onclick/hud/revenanthud.dm
@@ -6,7 +6,7 @@
 
 	pull_icon = new /atom/movable/screen/pull()
 	pull_icon.icon = ui_style
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	pull_icon.screen_loc = ui_living_pull
 	pull_icon.hud = src
 	static_inventory += pull_icon

diff --git a/code/_onclick/hud/robot.dm b/code/_onclick/hud/robot.dm
@@ -168,13 +168,13 @@
 	pull_icon.icon = 'icons/hud/screen_cyborg.dmi'
 	pull_icon.screen_loc = ui_borg_pull
 	pull_icon.hud = src
-	pull_icon.update_icon()
+	pull_icon.update_appearance()
 	hotkeybuttons += pull_icon
 
 
 	zone_select = new /atom/movable/screen/zone_sel/robot()
 	zone_select.hud = src
-	zone_select.update_icon()
+	zone_select.update_appearance()
 	static_inventory += zone_select
 
 
@@ -273,20 +273,19 @@
 /atom/movable/screen/robot/lamp
 	name = "headlamp"
 	icon_state = "lamp_off"
+	base_icon_state = "lamp"
 	var/mob/living/silicon/robot/robot
 
 /atom/movable/screen/robot/lamp/Click()
 	. = ..()
 	if(.)
 		return
 	robot?.toggle_headlamp()
-	update_icon()
+	update_appearance()
 
-/atom/movable/screen/robot/lamp/update_icon()
-	if(robot?.lamp_enabled)
-		icon_state = "lamp_on"
-	else
-		icon_state = "lamp_off"
+/atom/movable/screen/robot/lamp/update_icon_state()
+	icon_state = "[base_icon_state]_[robot?.lamp_enabled ? "on" : "off"]"
+	return ..()
 
 /atom/movable/screen/robot/modPC
 	name = "Modular Interface"