mirror of
https://github.com/VOREStation/VOREStation.git
synced 2026-07-14 08:35:39 +01:00
up ports the TG overlays subsystem update (#18945)
* up ports the TG overlays subsystem update * . * . * . * . * for spell * . * cutting --------- Co-authored-by: Cameron Lennox <killer65311@gmail.com>
This commit is contained in:
Kashargul
@@ -1,276 +1,156 @@
|
||||
SUBSYSTEM_DEF(overlays)
|
||||
name = "Overlay"
|
||||
flags = SS_TICKER
|
||||
wait = 1 // SS_TICKER - Ticks
|
||||
priority = FIRE_PRIORITY_OVERLAYS
|
||||
dependencies = list(
|
||||
/datum/controller/subsystem/atoms
|
||||
)
|
||||
flags = SS_NO_FIRE|SS_NO_INIT
|
||||
var/list/stats
|
||||
|
||||
/// The queue of atoms that need overlay updates.
|
||||
var/static/tmp/list/queue = list()
|
||||
|
||||
/// A list([icon] = list([state] = [appearance], ...), ...) cache of appearances.
|
||||
var/static/tmp/list/state_cache = list()
|
||||
|
||||
/// A list([icon] = [appearance], ...) cache of appearances.
|
||||
var/static/tmp/list/icon_cache = list()
|
||||
|
||||
/// The number of appearances currently cached.
|
||||
var/static/tmp/cache_size = 0
|
||||
/datum/controller/subsystem/overlays/PreInit()
|
||||
stats = list()
|
||||
|
||||
/datum/controller/subsystem/overlays/Shutdown()
|
||||
WRITE_LOG("[GLOB.log_directory]-overlay.log", render_stats(stats))
|
||||
|
||||
/datum/controller/subsystem/overlays/Recover()
|
||||
queue.Cut()
|
||||
state_cache.Cut()
|
||||
icon_cache.Cut()
|
||||
cache_size = 0
|
||||
for (var/atom/atom)
|
||||
atom.flags &= ~OVERLAY_QUEUED
|
||||
CHECK_TICK
|
||||
stats = SSoverlays.stats
|
||||
|
||||
/// Converts an overlay list into text for debug printing
|
||||
/// Of note: overlays aren't actually mutable appearances, they're just appearances
|
||||
/// Don't have access to that type tho, so this is the best you're gonna get
|
||||
/proc/overlays2text(list/overlays)
|
||||
var/list/unique_overlays = list()
|
||||
// As anything because we're basically doing type coerrsion, rather then actually filtering for mutable apperances
|
||||
for(var/mutable_appearance/overlay as anything in overlays)
|
||||
var/key = "[overlay.icon]-[overlay.icon_state]-[overlay.dir]"
|
||||
unique_overlays[key] += 1
|
||||
var/list/output_text = list()
|
||||
for(var/key in unique_overlays)
|
||||
output_text += "([key]) = [unique_overlays[key]]"
|
||||
return output_text.Join("\n")
|
||||
|
||||
/datum/controller/subsystem/overlays/Initialize()
|
||||
fire(FALSE, TRUE)
|
||||
return SS_INIT_SUCCESS
|
||||
/proc/iconstate2appearance(icon, iconstate)
|
||||
var/static/image/stringbro = new()
|
||||
stringbro.icon = icon
|
||||
stringbro.icon_state = iconstate
|
||||
return stringbro.appearance
|
||||
|
||||
/datum/controller/subsystem/overlays/stat_entry(msg)
|
||||
msg = "Queued Atoms: [queue.len], Cache Size: [cache_size]"
|
||||
return ..()
|
||||
/proc/icon2appearance(icon)
|
||||
var/static/image/iconbro = new()
|
||||
iconbro.icon = icon
|
||||
return iconbro.appearance
|
||||
|
||||
|
||||
/datum/controller/subsystem/overlays/fire(resumed, no_mc_tick)
|
||||
var/count = 1
|
||||
for (var/atom/atom as anything in queue)
|
||||
++count
|
||||
atom?.UpdateOverlays()
|
||||
if (no_mc_tick)
|
||||
CHECK_TICK
|
||||
else if (MC_TICK_CHECK)
|
||||
queue.Cut(1, count)
|
||||
return
|
||||
queue.Cut()
|
||||
|
||||
|
||||
/datum/controller/subsystem/overlays/proc/GetStateAppearance(icon, state)
|
||||
var/list/subcache = state_cache[icon]
|
||||
if (!subcache)
|
||||
subcache = list()
|
||||
state_cache[icon] = subcache
|
||||
if (!subcache[state])
|
||||
var/image/image = new (icon, null, state)
|
||||
subcache[state] = image.appearance
|
||||
++cache_size
|
||||
return subcache[state]
|
||||
|
||||
|
||||
/datum/controller/subsystem/overlays/proc/GetIconAppearance(icon)
|
||||
if (!icon_cache[icon])
|
||||
var/image/image = new (icon)
|
||||
icon_cache[icon] = image.appearance
|
||||
++cache_size
|
||||
return icon_cache[icon]
|
||||
|
||||
|
||||
/datum/controller/subsystem/overlays/proc/GetAppearanceList(atom/subject, list/sources)
|
||||
if (!sources)
|
||||
return list()
|
||||
if (!islist(sources))
|
||||
sources = list(sources)
|
||||
var/list/result = list()
|
||||
var/icon/icon = subject.icon
|
||||
for (var/atom/entry as anything in sources)
|
||||
AppearanceListEntry(entry, result, icon)
|
||||
return result
|
||||
|
||||
//Fixes runtime with overlays present in 515
|
||||
/datum/controller/subsystem/overlays/proc/AppearanceListEntry(var/atom/entry,var/list/result,var/icon/icon)
|
||||
if (!entry)
|
||||
return
|
||||
else if(islist(entry))
|
||||
var/list/entry_list = entry
|
||||
for(var/entry_item in entry_list)
|
||||
AppearanceListEntry(entry_item)
|
||||
else if (istext(entry))
|
||||
result += GetStateAppearance(icon, entry)
|
||||
else if (isicon(entry))
|
||||
result += GetIconAppearance(entry)
|
||||
else
|
||||
if (isloc(entry))
|
||||
if (entry.flags & OVERLAY_QUEUED)
|
||||
entry.ImmediateOverlayUpdate()
|
||||
if (!ispath(entry))
|
||||
if(entry.appearance)
|
||||
result += entry.appearance
|
||||
/atom/proc/build_appearance_list(list/build_overlays)
|
||||
if (!islist(build_overlays))
|
||||
build_overlays = list(build_overlays)
|
||||
if(priority_overlays)
|
||||
var/list/prio_overlay_temp
|
||||
if(!islist(priority_overlays))
|
||||
prio_overlay_temp = list(priority_overlays)
|
||||
else
|
||||
var/image/image = entry
|
||||
result += image.appearance
|
||||
prio_overlay_temp = priority_overlays.Copy()
|
||||
prio_overlay_temp |= build_overlays
|
||||
build_overlays = prio_overlay_temp
|
||||
for (var/overlay in build_overlays)
|
||||
if(!overlay)
|
||||
build_overlays -= overlay
|
||||
continue
|
||||
if (istext(overlay))
|
||||
// This is too expensive to run normally but running it during CI is a good test
|
||||
/*if (PERFORM_ALL_TESTS(focus_only/invalid_overlays))
|
||||
var/list/icon_states_available = icon_states(icon)
|
||||
if(!(overlay in icon_states_available))
|
||||
var/icon_file = "[icon]" || "Unknown Generated Icon"
|
||||
stack_trace("Invalid overlay: Icon object '[icon_file]' [REF(icon)] used in '[src]' [type] is missing icon state [overlay].")
|
||||
continue*/
|
||||
|
||||
/// Enqueues the atom for an overlay update if not already queued
|
||||
/atom/proc/QueueOverlayUpdate()
|
||||
if (flags & OVERLAY_QUEUED)
|
||||
return
|
||||
SSoverlays.queue += src
|
||||
flags |= OVERLAY_QUEUED
|
||||
var/index = build_overlays.Find(overlay)
|
||||
build_overlays[index] = iconstate2appearance(icon, overlay)
|
||||
else if(isicon(overlay))
|
||||
var/index = build_overlays.Find(overlay)
|
||||
build_overlays[index] = icon2appearance(overlay)
|
||||
return build_overlays
|
||||
|
||||
|
||||
/// Builds the atom's overlay state from caches
|
||||
/atom/proc/UpdateOverlays()
|
||||
if (gc_destroyed)
|
||||
if (length(overlays))
|
||||
overlays.Cut()
|
||||
return
|
||||
flags &= ~OVERLAY_QUEUED
|
||||
if (length(priority_overlays))
|
||||
if (length(our_overlays))
|
||||
overlays = priority_overlays + our_overlays
|
||||
else
|
||||
overlays = priority_overlays
|
||||
else if (length(our_overlays))
|
||||
overlays = our_overlays
|
||||
else
|
||||
overlays.Cut()
|
||||
|
||||
|
||||
/// Immediately runs an overlay update and dequeues the atom
|
||||
/atom/proc/ImmediateOverlayUpdate()
|
||||
SSoverlays.queue -= src
|
||||
UpdateOverlays()
|
||||
|
||||
|
||||
/// Clears the atom's overlay cache(s) and queues an update if needed
|
||||
/atom/proc/cut_overlays(priority)
|
||||
if (priority)
|
||||
if (!length(priority_overlays))
|
||||
return
|
||||
priority_overlays.Cut()
|
||||
QueueOverlayUpdate()
|
||||
else if (length(our_overlays))
|
||||
our_overlays.Cut()
|
||||
QueueOverlayUpdate()
|
||||
STAT_START_STOPWATCH
|
||||
if(priority)
|
||||
priority_overlays = null
|
||||
overlays = null
|
||||
//POST_OVERLAY_CHANGE(src)
|
||||
STAT_STOP_STOPWATCH
|
||||
STAT_LOG_ENTRY(SSoverlays.stats, type)
|
||||
|
||||
/atom/proc/cut_overlay(list/remove_overlays, priority)
|
||||
if(!overlays)
|
||||
return
|
||||
STAT_START_STOPWATCH
|
||||
if(priority)
|
||||
priority_overlays -= remove_overlays
|
||||
if(islist(remove_overlays))
|
||||
remove_overlays = remove_overlays.Copy() //May not be ideal to copy, but as build_appearance_list modifies lists in place which breaks certain things
|
||||
overlays -= build_appearance_list(remove_overlays)
|
||||
//POST_OVERLAY_CHANGE(src)
|
||||
STAT_STOP_STOPWATCH
|
||||
STAT_LOG_ENTRY(SSoverlays.stats, type)
|
||||
|
||||
/**
|
||||
* Adds specific overlay(s) to the atom.
|
||||
* It is designed so any of the types allowed to be added to /atom/overlays can be added here too. More details below.
|
||||
*
|
||||
* @param add The overlay(s) to add. These may be
|
||||
* - A string: In which case it is treated as an icon_state of the atom's icon.
|
||||
* - An icon: It is treated as an icon.
|
||||
* - An atom: Its own overlays are compiled and then it's appearance is added. (Meaning its current apperance is frozen).
|
||||
* - An image: Image's apperance is added (i.e. subsequently editing the image will not edit the overlay)
|
||||
* - A type path: Added to overlays as is. Does whatever it is BYOND does when you add paths to overlays.
|
||||
* - Or a list containing any of the above.
|
||||
* @param priority The overlays are added to the "priority" list istead of the normal one.
|
||||
*/
|
||||
/atom/proc/add_overlay(list/add, priority)
|
||||
if (!add)
|
||||
/atom/proc/add_overlay(list/add_overlays, priority)
|
||||
if(!overlays)
|
||||
return
|
||||
add = SSoverlays.GetAppearanceList(src, add)
|
||||
if (!length(add))
|
||||
STAT_START_STOPWATCH
|
||||
if(islist(add_overlays))
|
||||
if(priority)
|
||||
if (priority_overlays)
|
||||
priority_overlays += add_overlays
|
||||
else
|
||||
priority_overlays = add_overlays
|
||||
add_overlays = add_overlays.Copy() //May not be ideal to copy, but as build_appearance_list modifies lists in place which breaks certain things
|
||||
overlays += build_appearance_list(add_overlays) //May not be ideal to copy, but as build_appearance_list modifies lists in place which breaks certain things
|
||||
VALIDATE_OVERLAY_LIMIT(src)
|
||||
//POST_OVERLAY_CHANGE(src)
|
||||
STAT_STOP_STOPWATCH
|
||||
STAT_LOG_ENTRY(SSoverlays.stats, type)
|
||||
|
||||
/atom/proc/copy_overlays(atom/other, cut_old) //copys our_overlays from another atom
|
||||
if(!other)
|
||||
if(cut_old)
|
||||
cut_overlays()
|
||||
return
|
||||
if (priority)
|
||||
if (priority_overlays)
|
||||
priority_overlays += add
|
||||
|
||||
STAT_START_STOPWATCH
|
||||
var/list/cached_other = other.overlays.Copy()
|
||||
if(cut_old)
|
||||
if(cached_other)
|
||||
overlays = cached_other
|
||||
else
|
||||
priority_overlays = add
|
||||
else if (our_overlays)
|
||||
our_overlays += add
|
||||
else
|
||||
our_overlays = add
|
||||
QueueOverlayUpdate()
|
||||
|
||||
|
||||
/**
|
||||
* Removes specific overlay(s) from the atom. Usually does not remove them from "priority" overlays.
|
||||
*
|
||||
* @param overlays The overlays to removed, type can be anything that is allowed for add_overlay().
|
||||
* @param priority If true, also will remove them from the "priority" overlays.
|
||||
*/
|
||||
/atom/proc/cut_overlay(list/cut, priority)
|
||||
if (!cut)
|
||||
return
|
||||
cut = SSoverlays.GetAppearanceList(src, cut)
|
||||
if (!length(cut))
|
||||
return
|
||||
var/update
|
||||
if (priority && length(priority_overlays))
|
||||
priority_overlays -= cut
|
||||
update = TRUE
|
||||
if (length(our_overlays))
|
||||
our_overlays -= cut
|
||||
update = TRUE
|
||||
if (update)
|
||||
QueueOverlayUpdate()
|
||||
|
||||
|
||||
/**
|
||||
* Copy the overlays from another atom, either replacing all of ours or appending to our existing overlays.
|
||||
* Note: This copies only the normal overlays, not the "priority" overlays.
|
||||
*
|
||||
* @param other The atom to copy overlays from.
|
||||
* @param cut_old If true, all of our overlays will be *replaced* by the other's. If other is null, that means cutting all ours.
|
||||
*/
|
||||
/atom/proc/copy_overlays(atom/other, cut)
|
||||
if (!other)
|
||||
if (cut)
|
||||
cut_overlays()
|
||||
return
|
||||
if (!length(other.our_overlays))
|
||||
if (cut)
|
||||
cut_overlays()
|
||||
return
|
||||
if (cut || !length(our_overlays))
|
||||
our_overlays = other.our_overlays.Copy()
|
||||
else
|
||||
our_overlays |= other.our_overlays
|
||||
QueueOverlayUpdate()
|
||||
|
||||
|
||||
/**
|
||||
* Returns a list of overlays that the target atom has
|
||||
*
|
||||
* @param priority If true, returns priority overlays as well
|
||||
* @param special If true, returns special overlays like emissives and em_blockers
|
||||
*/
|
||||
/proc/get_overlays(atom/other, priority, special)
|
||||
var/list/including = list()
|
||||
if (!other)
|
||||
return including
|
||||
for (var/image/I as anything in other.our_overlays)
|
||||
if (!special && I.plane > 0)
|
||||
continue
|
||||
including += I
|
||||
if (!priority)
|
||||
return including
|
||||
for (var/image/I as anything in other.priority_overlays)
|
||||
if (!special && I.plane > 0)
|
||||
continue
|
||||
including += I
|
||||
return including
|
||||
overlays = null
|
||||
VALIDATE_OVERLAY_LIMIT(src)
|
||||
//POST_OVERLAY_CHANGE(src)
|
||||
STAT_STOP_STOPWATCH
|
||||
STAT_LOG_ENTRY(SSoverlays.stats, type)
|
||||
else if(cached_other)
|
||||
overlays += cached_other
|
||||
VALIDATE_OVERLAY_LIMIT(src)
|
||||
//POST_OVERLAY_CHANGE(src)
|
||||
STAT_STOP_STOPWATCH
|
||||
STAT_LOG_ENTRY(SSoverlays.stats, type)
|
||||
|
||||
//TODO: Better solution for these?
|
||||
/image/proc/add_overlay(x)
|
||||
overlays += x
|
||||
|
||||
overlays |= x
|
||||
|
||||
/image/proc/cut_overlay(x)
|
||||
overlays -= x
|
||||
|
||||
|
||||
/image/proc/cut_overlays(x)
|
||||
overlays.Cut()
|
||||
|
||||
|
||||
/image/proc/copy_overlays(atom/other, cut_old)
|
||||
if(!other)
|
||||
if(cut_old)
|
||||
cut_overlays()
|
||||
return
|
||||
|
||||
var/list/cached_other = other.our_overlays
|
||||
var/list/cached_other = other.overlays.Copy()
|
||||
if(cached_other)
|
||||
if(cut_old || !overlays.len)
|
||||
overlays = cached_other.Copy()
|
||||
overlays = cached_other
|
||||
else
|
||||
overlays |= cached_other
|
||||
else if(cut_old)
|
||||
@@ -372,3 +252,10 @@ SUBSYSTEM_DEF(overlays)
|
||||
message_admins(text)
|
||||
log_world(text)
|
||||
return diff_found
|
||||
|
||||
//Legacy, does basically nothing
|
||||
/atom/proc/ImmediateOverlayUpdate()
|
||||
if (gc_destroyed)
|
||||
if (length(overlays))
|
||||
overlays.Cut()
|
||||
return
|
||||
|
||||
Reference in New Issue
Block a user