From b82f5e4c19ea5e0358221a4042f305652435b5a4 Mon Sep 17 00:00:00 2001 From: Nathan Singer Date: Thu, 24 Apr 2025 18:43:26 -0400 Subject: [PATCH] adds some documentation --- caching.gd | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/caching.gd b/caching.gd index bb3a098..cf9e3fb 100644 --- a/caching.gd +++ b/caching.gd @@ -16,17 +16,24 @@ func _cache_error(err: String) -> String: return "CACHE::ERROR::" + err + "\n" -func get_card_data_from_name(_name: String) -> Dictionary: - return _get_card_data_from_bulk("name", _name) - - func _get_dict_from_file(filepath: String) -> Dictionary: var file = FileAccess.open(filepath, FileAccess.READ) var data = JSON.parse_string(file.get_as_text()) return data +## get_card_data_from_name +## +## _name: String [br] +## A wrapper for searching for a card by name. Use **get_card_data_from_id** where possible, as it avoids an expensive search for the new card, if the card has been cached already. +func get_card_data_from_name(_name: String) -> Dictionary: + return _get_card_data_from_bulk("name", _name) + +## get_card_data_from_id +## +## id: String [br] +## This is the preferred wrapper to use when fetching card data, it checks the cache for preexisting data and uses that if it's available. Otherwise, it will search the bulk json for the data. func get_card_data_from_id(id: String) -> Dictionary: if FileAccess.file_exists("user://card_cache/" + id + "/card.json"): return _get_dict_from_file("user://card_cache/" + id + "/card.json")