event_logger

Datum for the event logger. One of these is made, and everyone shares it. So be nice. This keeps tracks of everything related to the logger

Vars
awaiting_pick_user	The mob currently waiting to click a target for pick-target mode, or null.
categories	Assoc list: category name -> enabled (TRUE/FALSE).
category_colors	Assoc list: category name -> hex color, assigned when a category is first seen.
category_palette	List of colors we use for categories. We loop around once we run out
display_map	Assoc list: REF(source datum) -> REF(display datum). Events from the source appear under the display datum's track.
events_by_id	Assoc list: string event id -> event assoc list, for quick look-up when selecting events
next_event_id	Incrementing id assigned to each logged event.
running	Whether the logger is actively recording.
selected_ref	Ref string of the currently selected track (for the info panel).
time_start	world.time at which logging first started (null until first start).
tracks	Assoc list: ref string -> /datum/event_logger_track
user_overlays	Assoc list: mob -> list of /image, for overlay cleanup.
Procs
_add_event	Internal: Sets the event up, making a track if necesary. Also turns the instance into a REF() at this point
_apply_event_overlays	Push world-space highlight overlays to the user's client for the given events.
_clear_all_overlays	Remove all overlays for all users.
_clear_user_overlays	Remove all overlays for a specific user.
_end_pick_target	Ends pick-target mode, unregistering the click signal and clearing the awaiting_pick_user var.
_make_line_images	Draw a line of images similar to beams but client-side. I couldn't find anything like this yet so here we are. Maybe making this a global is a good idea.
_make_tile_image	Creates a single coloured tile overlay image.
add_track	Ensures a track exists for ref_string. Safe to call multiple times.
clear	Clears all tracks, categories and overlays.
get_category_color	Returns the hex color string for a category, or white if unknown.
log_event_lines	Log a line event (draws a line between 2 turfs).
log_event_location	Log a location event (highlights a single tile). I should remove this one as turfs does the same thing essentially
log_event_maptext	Log a maptext event (renders a floating text label at the turf when selected). text_string is the string to display at the turf.
log_event_path	Log a path event (renders directional arrows + start/end markers for a list of turfs in order from start to finish).
log_event_text	Log a plain text event. Has no world-visuals, just puts text into the menu
log_event_turfs	Log a turfs event (highlights a set of tiles).
on_pick_target_click	Signal handler: fired when the user clicks something while in pick-target mode.
toggle_pick_target	Enter pick-target mode: the next atom the user clicks gets DF_EVLOGGING set.
ui_assets	Tgui stuff below!!

Var Details

var
awaiting_pick_user
– /mob

The mob currently waiting to click a target for pick-target mode, or null.

var
categories
– /list

Assoc list: category name -> enabled (TRUE/FALSE).

var
category_colors
– /list

Assoc list: category name -> hex color, assigned when a category is first seen.

var
category_palette
– /list

List of colors we use for categories. We loop around once we run out

var
display_map
– /list

Assoc list: REF(source datum) -> REF(display datum). Events from the source appear under the display datum's track.

var
events_by_id
– /list

Assoc list: string event id -> event assoc list, for quick look-up when selecting events

var
next_event_id

Incrementing id assigned to each logged event.

var
running

Whether the logger is actively recording.

var
selected_ref

Ref string of the currently selected track (for the info panel).

var
time_start

world.time at which logging first started (null until first start).

var
tracks
– /list

Assoc list: ref string -> /datum/event_logger_track

var
user_overlays
– /list

Assoc list: mob -> list of /image, for overlay cleanup.

Proc Details

proc
_add_event
(/datum/source, /list/event_data)

Internal: Sets the event up, making a track if necesary. Also turns the instance into a REF() at this point

proc
_apply_event_overlays
(/mob/user, /list/events_to_show)

Push world-space highlight overlays to the user's client for the given events.

proc
_clear_all_overlays
()

Remove all overlays for all users.

proc
_clear_user_overlays
(/mob/user)

Remove all overlays for a specific user.

proc
_end_pick_target
()

Ends pick-target mode, unregistering the click signal and clearing the awaiting_pick_user var.

proc
_make_line_images
(/turf/turf_A, /turf/turf_B, color)

Draw a line of images similar to beams but client-side. I couldn't find anything like this yet so here we are. Maybe making this a global is a good idea.

proc
_make_tile_image
(/turf/selected_turf, icon_state, color, alpha_fraction)

Creates a single coloured tile overlay image.

proc
add_track
(ref_string, track_name, /list/info_data)

Ensures a track exists for ref_string. Safe to call multiple times.

proc
clear
()

Clears all tracks, categories and overlays.

proc
get_category_color
(category)

Returns the hex color string for a category, or white if unknown.

proc
log_event_lines
(/datum/source, category, info_string, /turf/A, /turf/B)

Log a line event (draws a line between 2 turfs).

proc
log_event_location
(/datum/source, category, info_string, /turf/T)

Log a location event (highlights a single tile). I should remove this one as turfs does the same thing essentially

proc
log_event_maptext
(/datum/source, category, info_string, /turf/T, text_string)

Log a maptext event (renders a floating text label at the turf when selected). text_string is the string to display at the turf.

proc
log_event_path
(/datum/source, category, info_string, /list/turfs)

Log a path event (renders directional arrows + start/end markers for a list of turfs in order from start to finish).

proc
log_event_text
(/datum/source, category, info_string)

Log a plain text event. Has no world-visuals, just puts text into the menu

proc
log_event_turfs
(/datum/source, category, info_string, /list/turfs)

Log a turfs event (highlights a set of tiles).

proc
on_pick_target_click
(/mob/source, /atom/clicked, /list/modifiers)

Signal handler: fired when the user clicks something while in pick-target mode.

proc
toggle_pick_target
(/mob/user)

Enter pick-target mode: the next atom the user clicks gets DF_EVLOGGING set.

↑
ui_assets
(/mob/user)

Tgui stuff below!!

event_logger /datum/event_logger

Vars

Procs

Var Details

var awaiting_pick_user – /mob

var categories – /list

var category_colors – /list

var category_palette – /list

var display_map – /list

var events_by_id – /list

var next_event_id

var running

var selected_ref

var time_start

var tracks – /list

var user_overlays – /list

Proc Details

proc _add_event(/datum/source, /list/event_data)

proc _apply_event_overlays(/mob/user, /list/events_to_show)

proc _clear_all_overlays()

proc _clear_user_overlays(/mob/user)

proc _end_pick_target()

proc _make_line_images(/turf/turf_A, /turf/turf_B, color)

proc _make_tile_image(/turf/selected_turf, icon_state, color, alpha_fraction)

proc add_track(ref_string, track_name, /list/info_data)

proc clear()

proc get_category_color(category)

proc log_event_lines(/datum/source, category, info_string, /turf/A, /turf/B)

proc log_event_location(/datum/source, category, info_string, /turf/T)

proc log_event_maptext(/datum/source, category, info_string, /turf/T, text_string)

proc log_event_path(/datum/source, category, info_string, /list/turfs)

proc log_event_text(/datum/source, category, info_string)

proc log_event_turfs(/datum/source, category, info_string, /list/turfs)

proc on_pick_target_click(/mob/source, /atom/clicked, /list/modifiers)

proc toggle_pick_target(/mob/user)

↑ui_assets(/mob/user)