[MIRROR] Adds Custom Announcement Dividers [MDB IGNORE] (#189)

* Adds Custom Announcement Dividers

* Skyrat custom announcements

---------

Co-authored-by: san7890 <[email protected]>
Co-authored-by: lessthanthree <[email protected]>

code/__DEFINES/announcements.dm

@@ -0,0 +1,7 @@
+// Priority-type announcement messages for `priority_announcement()`
+/// Prefix this announcement with "Priority Announcement"
+#define ANNOUNCEMENT_TYPE_PRIORITY "Priority"
+/// Make it sound like it's coming from the Captain
+#define ANNOUNCEMENT_TYPE_CAPTAIN "Captain"
+/// Make it sound like it's coming from the Syndicate
+#define ANNOUNCEMENT_TYPE_SYNDICATE "Syndicate"

code/__HELPERS/priority_announce.dm

@@ -1,3 +1,15 @@
+// please don't use these defines outside of this file in order to ensure a unified framework. unless you have a really good reason to make them global, then whatever
+
+// these four are just text spans that furnish the TEXT itself with the appropriate CSS classes
+#define MAJOR_ANNOUNCEMENT_TITLE(string) ("<span class='major_announcement_title'>" + string + "</span>")
+#define MAJOR_ANNOUNCEMENT_TEXT(string) ("<span class='major_announcement_text'>" + string + "</span>")
+#define MINOR_ANNOUNCEMENT_TITLE(string) ("<span class='minor_announcement_title'>" + string + "</span>")
+#define MINOR_ANNOUNCEMENT_TEXT(string) ("<span class='minor_announcement_text'>" + string + "</span>")
+
+// these two are the ones that actually give the striped background
+#define CHAT_ALERT_DEFAULT_SPAN(string) ("<div class='chat_alert_default'>" + string + "</div>")
+#define CHAT_ALERT_COLORED_SPAN(color, string) ("<div class='chat_alert_" + color + "'>" + string + "</div>")
+
 /**
  * Make a big red text announcement to
  *
@@ -13,7 +25,7 @@
  * * text - required, the text to announce
  * * title - optional, the title of the announcement.
  * * sound - optional, the sound played accompanying the announcement
- * * type - optional, the type of the announcement, for some "preset" announcement templates. "Priority", "Captain", "Syndicate Captain"
+ * * type - optional, the type of the announcement, for some "preset" announcement templates. See __DEFINES/announcements.dm
  * * sender_override - optional, modifies the sender of the announcement
  * * has_important_message - is this message critical to the game (and should not be overridden by station traits), or not
  * * players - a list of all players to send the message to. defaults to all players (not including new players)
@@ -31,66 +43,44 @@
 		if(!length(text))
 			return
 
-	var/announcement
+	var/list/announcement_strings = list()
+
 	if(!sound)
 		sound = SSstation.announcer.get_rand_alert_sound()
 	else if(SSstation.announcer.event_sounds[sound])
 		sound = SSstation.announcer.event_sounds[sound]
 
-	announcement += "<br>"
-
-	if(type == "Priority")
-		announcement += "[span_priorityannounce("<u>Priority Announcement</u>")]"
-		if (title && length(title) > 0)
-			announcement += "[span_prioritytitle("<br>[title]")]"
-	else if(type == "Captain")
-		announcement += "[span_priorityannounce("<u>Captain Announces</u>")]"
-		GLOB.news_network.submit_article(text, "Captain's Announcement", "Station Announcements", null)
-	else if(type == "Syndicate Captain")
-		announcement += "[span_priorityannounce("<u>Syndicate Captain Announces</u>")]"
-
-	else
-		if(!sender_override)
-			announcement += "[span_priorityannounce("<u>[command_name()] Update</u>")]"
+	var/header
+	switch(type)
+		if(ANNOUNCEMENT_TYPE_PRIORITY)
+			header = MAJOR_ANNOUNCEMENT_TITLE("Priority Announcement")
+			if(length(title) > 0)
+				header += MINOR_ANNOUNCEMENT_TITLE(title)
+		if(ANNOUNCEMENT_TYPE_CAPTAIN)
+			header = MAJOR_ANNOUNCEMENT_TITLE("Captain's Announcement")
+			GLOB.news_network.submit_article(text, "Captain's Announcement", "Station Announcements", null)
+		if(ANNOUNCEMENT_TYPE_SYNDICATE)
+			header = MAJOR_ANNOUNCEMENT_TITLE("Syndicate Captain's Announcement")
 		else
-			announcement += "[span_priorityannounce("<u>[sender_override]</u>")]"
-		if (title && length(title) > 0)
-			announcement += "[span_prioritytitle("<br>[title]")]"
+			header += generate_unique_announcement_header(title, sender_override)
 
-		if(!sender_override)
-			if(title == "")
-				GLOB.news_network.submit_article(text, "Central Command Update", "Station Announcements", null)
-			else
-				GLOB.news_network.submit_article(title + "<br><br>" + text, "Central Command", "Station Announcements", null)
+	announcement_strings += header
 
 	///If the announcer overrides alert messages, use that message.
 	if(SSstation.announcer.custom_alert_message && !has_important_message)
-		announcement += "[span_priorityalert("<br>[SSstation.announcer.custom_alert_message]<br>")]"
+		announcement_strings += SSstation.announcer.custom_alert_message
 	else
-		announcement += "[span_priorityalert("<br>[text]<br>")]"
-
-	announcement += "<br>"
+		announcement_strings += MAJOR_ANNOUNCEMENT_TEXT(text)
 
-	if(!players)
-		players = GLOB.player_list
-	// SKYRAT EDIT CHANGE BEGIN - ANNOUNCEMENTS
-	/* Original
-			if(target.client.prefs.read_preference(/datum/preference/toggle/sound_announcements))
-				SEND_SOUND(target, sound_to_play)
-	*/
-	if(!sound)
-		sound = SSstation.announcer.get_rand_alert_sound()
-	else if(SSstation.announcer.event_sounds[sound])
-		var/list/announcer_key = SSstation.announcer.event_sounds[sound]
-		sound = pick(announcer_key)
+	var/finalized_announcement = CHAT_ALERT_DEFAULT_SPAN(jointext(announcement_strings, "<br>"))
 
-	var/sound_to_play = sound(sound)
-	for(var/mob/target in players)
-		if(!isnewplayer(target) && target.can_hear())
-			to_chat(target, announcement)
+	dispatch_announcement_to_players(finalized_announcement, players, sound)
 
-	alert_sound_to_playing(sound_to_play, players = players)
-	// SKYRAT EDIT CHANGE END - ANNOUNCEMENTS
+	if(isnull(sender_override))
+		if(length(title) > 0)
+			GLOB.news_network.submit_article(title + "<br><br>" + text, "Central Command", "Station Announcements", null)
+		else
+			GLOB.news_network.submit_article(text, "Central Command Update", "Station Announcements", null)
 
 /proc/print_command_report(text = "", title = null, announce=TRUE)
 	if(!title)
@@ -118,37 +108,105 @@
  * sound_override - optional, use the passed sound file instead of the default notice sounds.
  * should_play_sound - Whether the notice sound should be played or not.
  */
-/proc/minor_announce(message, title = "Attention:", alert, html_encode = TRUE, list/players = null, sound_override = null, should_play_sound = TRUE)
+/proc/minor_announce(message, title = "Attention:", alert = FALSE, html_encode = TRUE, list/players = null, sound_override = null, should_play_sound = TRUE)
 	if(!message)
 		return
 
 	if (html_encode)
 		title = html_encode(title)
 		message = html_encode(message)
 
+	var/list/minor_announcement_strings = list()
+	minor_announcement_strings += MINOR_ANNOUNCEMENT_TITLE(title)
+	minor_announcement_strings += MINOR_ANNOUNCEMENT_TEXT(message)
+
+	var/finalized_announcement = CHAT_ALERT_DEFAULT_SPAN(jointext(minor_announcement_strings, "<br>"))
+
+	var/custom_sound = sound_override || (alert ? 'modular_skyrat/modules/alerts/sound/alerts/alert1.ogg' : 'sound/misc/notice2.ogg') // SKYRAT EDIT CHANGE - CUSTOM ANNOUNCEMENTS - Original: 'sound/misc/notice1.ogg'
+	dispatch_announcement_to_players(finalized_announcement, players, custom_sound, should_play_sound)
+
+/// Sends an announcement about the level changing to players. Uses the passed in datum and the subsystem's previous security level to generate the message.
+/proc/level_announce(datum/security_level/selected_level, previous_level_number)
+	var/current_level_number = selected_level.number_level
+	var/current_level_name = selected_level.name
+	var/current_level_color = selected_level.announcement_color
+	var/current_level_sound = selected_level.sound
+
+	var/title
+	var/message
+
+	if(current_level_number > previous_level_number)
+		title = "Attention! Security level elevated to [current_level_name]:"
+		message = selected_level.elevating_to_announcement
+	else
+		title = "Attention! Security level lowered to [current_level_name]:"
+		message = selected_level.lowering_to_announcement
+
+	var/list/level_announcement_strings = list()
+	level_announcement_strings += MINOR_ANNOUNCEMENT_TITLE(title)
+	level_announcement_strings += MINOR_ANNOUNCEMENT_TEXT(message)
+
+	var/finalized_announcement = CHAT_ALERT_COLORED_SPAN(current_level_color, jointext(level_announcement_strings, "<br>"))
+
+	dispatch_announcement_to_players(finalized_announcement, GLOB.player_list, current_level_sound)
+
+/// Proc that just generates a custom header based on variables fed into `priority_announce()`
+/// Will return a string.
+/proc/generate_unique_announcement_header(title, sender_override)
+	var/list/returnable_strings = list()
+	if(isnull(sender_override))
+		returnable_strings += MAJOR_ANNOUNCEMENT_TITLE("[command_name()] Update")
+	else
+		returnable_strings += MAJOR_ANNOUNCEMENT_TITLE(sender_override)
+
+	if(length(title) > 0)
+		returnable_strings += MINOR_ANNOUNCEMENT_TITLE(title)
+
+	return jointext(returnable_strings, "<br>")
+
+/// Proc that just dispatches the announcement to our applicable audience. Only the announcement is a mandatory arg.
+/proc/dispatch_announcement_to_players(announcement, list/players, sound_override = null, should_play_sound = TRUE)
 	if(!players)
 		players = GLOB.player_list
 
+	// SKYRAT EDIT CHANGE BEGIN - CUSTOM ANNOUNCEMENTS
+	/* Original:
+
+	var/sound_to_play = !isnull(sound_override) ? sound_override : 'sound/misc/notice2.ogg'
+
 	for(var/mob/target in players)
-		if(isnewplayer(target))
+		if(isnewplayer(target) || !target.can_hear())
 			continue
-		if(!target.can_hear())
+
+		to_chat(target, announcement)
+		if(!should_play_sound)
 			continue
 
-		to_chat(target, "<br>[span_minorannounce(title)]<br>")
-		to_chat(target, "[span_minoralert(message)]<br><br><br>")
-	// SKYRAT EDIT CHANGE START - ANNOUNCEMENTS
-	/* Original
-		if(should_play_sound && target.client?.prefs.read_preference(/datum/preference/toggle/sound_announcements))
-			var/sound_to_play = sound_override || (alert ? 'sound/misc/notice1.ogg' : 'sound/misc/notice2.ogg')
+		if(target.client?.prefs.read_preference(/datum/preference/toggle/sound_announcements))
 			SEND_SOUND(target, sound(sound_to_play))
 	*/
-	if(sound_override)
-		if(SSstation.announcer.event_sounds[sound_override])
-			var/list/announcement_key = SSstation.announcer.event_sounds[sound_override]
-			sound_override = pick(announcement_key)
+	if(!sound_override)
+		sound_override = SSstation.announcer.get_rand_alert_sound()
+	else if(SSstation.announcer.event_sounds[sound_override])
+		var/list/announcer_key = SSstation.announcer.event_sounds[sound_override]
+		sound_override = pick(announcer_key)
+
+	if(!isnull(sound_override))
+		sound_override = sound(sound_override)
 
-	var/sound_to_play = sound_override || (alert ? 'modular_skyrat/modules/alerts/sound/alerts/alert1.ogg' : 'sound/misc/notice2.ogg')
+	var/sound_to_play = !isnull(sound_override) ? sound_override : 'sound/misc/notice2.ogg'
 	alert_sound_to_playing(sound_to_play, players = players)
-	// SKYRAT EDIT CHANGE END - ANNOUNCEMENTS
 
+	for(var/mob/target in players)
+		if(isnewplayer(target) || !target.can_hear())
+			continue
+
+		to_chat(target, announcement)
+	// SKYRAT EDIT CHANGE END - CUSTOM ANNOUNCEMENTS
+
+#undef MAJOR_ANNOUNCEMENT_TITLE
+#undef MAJOR_ANNOUNCEMENT_TEXT
+#undef MINOR_ANNOUNCEMENT_TITLE
+#undef MINOR_ANNOUNCEMENT_TEXT
+#undef CHAT_ALERT_DEFAULT_SPAN
+#undef CHAT_ALERT_COLORED_SPAN

code/controllers/subsystem/communications.dm

@@ -38,9 +38,9 @@ SUBSYSTEM_DEF(communications)
 	else
 		var/list/message_data = user.treat_message(input)
 		if(syndicate)
-			priority_announce(html_decode(message_data["message"]), null, 'sound/misc/announce_syndi.ogg', "Syndicate Captain", has_important_message = TRUE, players = players)
+			priority_announce(html_decode(message_data["message"]), null, 'sound/misc/announce_syndi.ogg', ANNOUNCEMENT_TYPE_SYNDICATE, has_important_message = TRUE, players = players)
 		else
-			priority_announce(html_decode(message_data["message"]), null, ANNOUNCER_CAPTAIN, "Captain", has_important_message = TRUE, players = players) // SKYRAT EDIT CHANGE - Announcer Sounds
+			priority_announce(html_decode(message_data["message"]), null, ANNOUNCER_CAPTAIN, ANNOUNCEMENT_TYPE_CAPTAIN, has_important_message = TRUE, players = players) // SKYRAT EDIT CHANGE - 'sound/misc/announce.ogg' to ANNOUNCER_CAPTAIN
 		COOLDOWN_START(src, nonsilicon_message_cooldown, COMMUNICATION_COOLDOWN)
 	user.log_talk(input, LOG_SAY, tag="priority announcement")
 	message_admins("[ADMIN_LOOKUPFLW(user)] has made a priority announcement.")

code/controllers/subsystem/security_level.dm

@@ -39,7 +39,7 @@ SUBSYSTEM_DEF(security_level)
 	if(!selected_level)
 		CRASH("set_level was called with an invalid security level([new_level])")
 
-	announce_security_level(selected_level) // We want to announce BEFORE updating to the new level
+	level_announce(selected_level, current_security_level.number_level) // We want to announce BEFORE updating to the new level
 
 	SSsecurity_level.current_security_level = selected_level
 
@@ -56,18 +56,6 @@ SUBSYSTEM_DEF(security_level)
 	SSnightshift.check_nightshift()
 	SSblackbox.record_feedback("tally", "security_level_changes", 1, selected_level.name)
 
-/**
- * Handles announcements of the newly set security level
- *
- * Arguments:
- * * selected_level - The new security level that has been set
- */
-/datum/controller/subsystem/security_level/proc/announce_security_level(datum/security_level/selected_level)
-	if(selected_level.number_level > current_security_level.number_level) // We are elevating to this level.
-		minor_announce(selected_level.elevating_to_announcemnt, "Attention! Security level elevated to [selected_level.name]:", sound_override = selected_level.sound)
-	else // Going down
-		minor_announce(selected_level.lowering_to_announcement, "Attention! Security level lowered to [selected_level.name]:", sound_override = selected_level.sound)
-
 /**
  * Returns the current security level as a number
  */

code/controllers/subsystem/shuttle.dm

@@ -521,13 +521,13 @@ SUBSYSTEM_DEF(shuttle)
 		emergency.sound_played = FALSE
 		priority_announce("Hostile environment detected. \
 			Departure has been postponed indefinitely pending \
-			conflict resolution.", null, 'sound/misc/notice1.ogg', "Priority")
+			conflict resolution.", null, 'sound/misc/notice1.ogg', ANNOUNCEMENT_TYPE_PRIORITY)
 	if(!emergency_no_escape && (emergency.mode == SHUTTLE_STRANDED))
 		emergency.mode = SHUTTLE_DOCKED
 		emergency.setTimer(emergency_dock_time)
 		priority_announce("Hostile environment resolved. \
 			You have 3 minutes to board the Emergency Shuttle.",
-			null, ANNOUNCER_SHUTTLEDOCK, "Priority")
+			null, ANNOUNCER_SHUTTLEDOCK, ANNOUNCEMENT_TYPE_PRIORITY)
 
 //try to move/request to dock_home if possible, otherwise dock_away. Mainly used for admin buttons
 /datum/controller/subsystem/shuttle/proc/toggleShuttle(shuttle_id, dock_home, dock_away, timed)

code/modules/security_levels/security_level_datums.dm

@@ -9,6 +9,8 @@
 /datum/security_level
 	/// The name of this security level.
 	var/name = "not set"
+	/// The color of our announcement divider.
+	var/announcement_color = "default"
 	/// The numerical level of this security level, see defines for more information.
 	var/number_level = -1
 	/// The sound that we will play when this security level is set
@@ -22,7 +24,7 @@
 	/// Our announcement when lowering to this level
 	var/lowering_to_announcement
 	/// Our announcement when elevating to this level
-	var/elevating_to_announcemnt
+	var/elevating_to_announcement
 	/// Our configuration key for lowering to text, if set, will override the default lowering to announcement.
 	var/lowering_to_configuration_key
 	/// Our configuration key for elevating to text, if set, will override the default elevating to announcement.
@@ -33,7 +35,7 @@
 	if(lowering_to_configuration_key) // I'm not sure about you, but isn't there an easier way to do this?
 		lowering_to_announcement = global.config.Get(lowering_to_configuration_key)
 	if(elevating_to_configuration_key)
-		elevating_to_announcemnt = global.config.Get(elevating_to_configuration_key)
+		elevating_to_announcement = global.config.Get(elevating_to_configuration_key)
 
 /**
  * GREEN
@@ -42,6 +44,7 @@
  */
 /datum/security_level/green
 	name = "green"
+	announcement_color = "green"
 	sound = 'sound/misc/notice2.ogg' // Friendly beep
 	number_level = SEC_LEVEL_GREEN
 	lowering_to_configuration_key = /datum/config_entry/string/alert_green
@@ -54,6 +57,7 @@
  */
 /datum/security_level/blue
 	name = "blue"
+	announcement_color = "blue"
 	sound = 'sound/misc/notice1.ogg' // Angry alarm
 	number_level = SEC_LEVEL_BLUE
 	lowering_to_configuration_key = /datum/config_entry/string/alert_blue_downto
@@ -67,6 +71,7 @@
  */
 /datum/security_level/red
 	name = "red"
+	announcement_color = "red"
 	sound = 'sound/misc/notice3.ogg' // More angry alarm
 	number_level = SEC_LEVEL_RED
 	lowering_to_configuration_key = /datum/config_entry/string/alert_red_downto
@@ -80,6 +85,7 @@
  */
 /datum/security_level/delta
 	name = "delta"
+	announcement_color = "purple"
 	sound = 'sound/misc/airraid.ogg' // Air alarm to signify importance
 	number_level = SEC_LEVEL_DELTA
 	elevating_to_configuration_key = /datum/config_entry/string/alert_delta