codex

Vars
all_entries	All entries. Unkeyed.
codex_categories	All categories.
codex_index	Codex Database Connection
entries_by_path	All STATIC entries, By path. Does not include dynamic entries.
entries_by_string	All entries, by name.
index_file	The same as above, but sorted (?)
search_cache	Search result cache, so we don't need to hit the DB every time.
Procs
build_db_index	Holds the revision the index was compiled for. If it's different then live, we need to regenerate the index.
get_codex_entry	Returns a codex entry for the given query. May return a list if multiple are found, or null if none.
prepare_search_database	Prepare the search database.
present_codex_entry	Presents a codex entry to a mob. If it receives a list of entries, it will prompt them to choose one.
present_codex_search	Presents a list of codex entries to a mob.
retrieve_entries_for_string	Perform a full-text search through all codex entries. Entries matching the query by name will be shown first. Results are cached. Relies on the index database.
text_search_no_db	Straight-DM implimentation of full text search. Objectively garbage. Does not use the DB. Used when database loading is skipped. Argument has already been sanitized. Safety checks have already been done. Cache has already been checked.

Var Details

var
all_entries
– /list

All entries. Unkeyed.

var
codex_categories
– /list

All categories.

var
codex_index
– /database

Codex Database Connection

var
entries_by_path
– /list

All STATIC entries, By path. Does not include dynamic entries.

var
entries_by_string
– /list

All entries, by name.

var
index_file
– /list

The same as above, but sorted (?)

var
search_cache
– /list

Search result cache, so we don't need to hit the DB every time.

Proc Details

proc
build_db_index
()

Holds the revision the index was compiled for. If it's different then live, we need to regenerate the index.

proc
get_codex_entry
(entry)

Returns a codex entry for the given query. May return a list if multiple are found, or null if none.

proc
prepare_search_database
(drop_existing)

Prepare the search database.

proc
present_codex_entry
(/mob/presenting_to, /datum/codex_entry/entry)

Presents a codex entry to a mob. If it receives a list of entries, it will prompt them to choose one.

proc
present_codex_search
(/mob/presenting_to, /list/entries, search_query)

Presents a list of codex entries to a mob.

proc
retrieve_entries_for_string
(searching)

Perform a full-text search through all codex entries. Entries matching the query by name will be shown first. Results are cached. Relies on the index database.

proc
text_search_no_db
(searching)

Straight-DM implimentation of full text search. Objectively garbage. Does not use the DB. Used when database loading is skipped. Argument has already been sanitized. Safety checks have already been done. Cache has already been checked.

codex /datum/controller/subsystem/codex

Vars

Procs

Var Details

var all_entries – /list

var codex_categories – /list

var codex_index – /database

var entries_by_path – /list

var entries_by_string – /list

var index_file – /list

var search_cache – /list

Proc Details

proc build_db_index()

proc get_codex_entry(entry)

proc prepare_search_database(drop_existing)

proc present_codex_entry(/mob/presenting_to, /datum/codex_entry/entry)

proc present_codex_search(/mob/presenting_to, /list/entries, search_query)

proc retrieve_entries_for_string(searching)

proc text_search_no_db(searching)