diff --git a/docs/client-cache-wdb.md b/docs/client-cache-wdb.md new file mode 100644 index 00000000..15b1beda --- /dev/null +++ b/docs/client-cache-wdb.md @@ -0,0 +1,19 @@ +# Client Cache (wdb) + +You can see below what's cache by the client and theorically should need to be cleared in the case of changing any content of those databases. + +Cache is not exclusive to a `Database Table` but to certain parts of the `Database Table` (equivalent on the Client side). + +All `Database Tables` below require in theory cache clearing (of the client) when changing them, could be in their entirety or just one field. + +| Database Tables | Packet | Client Cache File | Description | +|-----------------|-------------------------------|---------------------|-------------------------------------------------------------| +| [item_template](item_template) | `SMSG_ITEM_QUERY_RESPONSE` | itemcache.wdb | Item name, description, stats, display ID, quality, icons | +| [creature_template](creature_template) | `SMSG_CREATURE_QUERY_RESPONSE` | creaturecache.wdb | Creature name, subname/title, display ID, type | +| [gameobject_template](gameobject_template) | `SMSG_GAMEOBJECT_QUERY_RESPONSE` | gameobjectcache.wdb | Gameobject name, display ID, type | +| [quest_template](quest_template) | `SMSG_QUEST_QUERY_RESPONSE` | questcache.wdb | Quest title, description, objectives, completion text | +| [page_text](page_text) | `SMSG_PAGE_TEXT_QUERY_RESPONSE` | pagetextcache.wdb | Book/scroll/plaque text | +| [npc_text](npc_text), [gossip_menu](gossip_menu), [gossip_menu_option](gossip_menu_option) | `SMSG_NPC_TEXT_UPDATE`, `SMSG_GOSSIP_MESSAGE` | npccache.wdb (merged with others) | NPC dialogue, gossip menus, greetings | + +The table above doesn't mean it's all `Database Tables` if changed that require a client cache clearing, it's at least something, better than guessing majority of the time, there's no currently much information to what each field may or not be cached and requires the file to be or not deleted. + diff --git a/docs/creature_template.md b/docs/creature_template.md index bdced44d..f2461323 100644 --- a/docs/creature_template.md +++ b/docs/creature_template.md @@ -6,6 +6,9 @@ This table contains the description of creatures. Each spawned creature is an instance of a template present in this table, this means every creature MUST be defined in this table. +This table has `SMSG_CREATURE_QUERY_RESPONSE` packet and creaturecache.wdb cache file associated with: Creature name, subname/title, display ID, type. To see more information about: [Client Cache (wdb)](client-cache-wdb). + + **Table Structure** | Field | Type | Null | Key | Default | Extra | Comment | diff --git a/docs/documentation-index.md b/docs/documentation-index.md index d52e9959..1ac57eaa 100644 --- a/docs/documentation-index.md +++ b/docs/documentation-index.md @@ -20,6 +20,7 @@ redirect_from: /documentation_index * [Bash system](bash_system) * [Bitwise operations](bit-and-bytes-tutorial) * [Changelog](changelog) +* [Client Cache (wdb)](docs/client-cache-wdb.md) * [CMake options](cmake-options) * [Config Overrides with Env Var](config-overrides-with-env-var) * [Core Scripts](core-scripts) diff --git a/docs/gameobject_template.md b/docs/gameobject_template.md index 0889ee8d..d472e82b 100644 --- a/docs/gameobject_template.md +++ b/docs/gameobject_template.md @@ -2,6 +2,8 @@ Contains template of all gameobjects +This table has `SMSG_GAMEOBJECT_QUERY_RESPONSE` packet and gameobjectcache.wdb cache file associated with: Gameobject name, display ID, type. To see more information about: [Client Cache (wdb)](client-cache-wdb). + ## Structure | Field | Type | Attributes | Key | Null | Default | Extra | Comment | diff --git a/docs/gossip_menu.md b/docs/gossip_menu.md index a358bfa7..97c65eda 100644 --- a/docs/gossip_menu.md +++ b/docs/gossip_menu.md @@ -6,6 +6,8 @@ This table is used for displaying gossip when a player talks to an NPC with [npcflag](creature_template#npcflag) set. +This table has `SMSG_NPC_TEXT_UPDATE`, `SMSG_GOSSIP_MESSAGE` packet and npccache.wdb (merged with others) cache file associated with: NPC dialogue, gossip menus, greetings. To see more information about: [Client Cache (wdb)](client-cache-wdb). + **Table Structure** | Field | Type | Attributes | Key | Null | Default | Extra | Comment | diff --git a/docs/gossip_menu_option.md b/docs/gossip_menu_option.md index 967ab3cc..041cb006 100644 --- a/docs/gossip_menu_option.md +++ b/docs/gossip_menu_option.md @@ -4,6 +4,8 @@ This table holds information about menu options a gossip NPC can have. Examples of options: "Train me!", "I want to unlearn my talents" +This table has `SMSG_NPC_TEXT_UPDATE`, `SMSG_GOSSIP_MESSAGE` packet and npccache.wdb (merged with others) cache file associated with: NPC dialogue, gossip menus, greetings. To see more information about: [Client Cache (wdb)](client-cache-wdb). + ## Structure | Field | Type | Attributes | Key | Null | Default | Extra | Comment | diff --git a/docs/item_template.md b/docs/item_template.md index 5107ba25..0f5ae3e5 100644 --- a/docs/item_template.md +++ b/docs/item_template.md @@ -8,6 +8,8 @@ Holds information on every item that exists in the game. All items are created f (See additional information in the *ItemPrototype.h* file.) +This table has `SMSG_ITEM_QUERY_RESPONSE` packet and itemcache.wdb cache file associated with: Item name, description, stats, display ID, quality, icons. To see more information about: [Client Cache (wdb)](client-cache-wdb). + | Field | Type | Attributes | Key | Null | Default | extra | Comment | | ------------------------------- | ------------ | ---------- | --- | ---- | ------- | ----- | ------------------- | | [entry][1] | MEDIUMINT | UNSIGNED | PRI | NO | 0 | | | diff --git a/docs/npc_text.md b/docs/npc_text.md index fe511a3a..8f5590b4 100644 --- a/docs/npc_text.md +++ b/docs/npc_text.md @@ -6,6 +6,8 @@ This table contains the texts that are used for gossip. More research needs to be done on this table. +This table has `SMSG_NPC_TEXT_UPDATE`, `SMSG_GOSSIP_MESSAGE` packet and npccache.wdb (merged with others) cache file associated with: NPC dialogue, gossip menus, greetings. To see more information about: [Client Cache (wdb)](client-cache-wdb). + | Field | Type | Attributes | Key | Null | Default | Extra | Comment | | ------------- | --------- | ---------- | --- | ---- | ------- | ----- | ------- | | ID | MEDIUMINT | UNSIGNED | PRI | NO | 0 | | | diff --git a/docs/page_text.md b/docs/page_text.md index a950c5fd..4aa7488b 100644 --- a/docs/page_text.md +++ b/docs/page_text.md @@ -6,6 +6,8 @@ This table holds the text for letter items or any items that when moused-over turn the cursor into a magnifying glass and on right-click will open up a window where you can read the contents of the letter. +This table has `SMSG_PAGE_TEXT_QUERY_RESPONSE` packet and pagetextcache.wdb cache file associated with: Book/scroll/plaque text. To see more information about: [Client Cache (wdb)](client-cache-wdb). + **Table Structure** | Field | Type | Attributes | Key | Null | Default | Extra | Comment | diff --git a/docs/quest_template.md b/docs/quest_template.md index beb9a68e..638fb1dd 100644 --- a/docs/quest_template.md +++ b/docs/quest_template.md @@ -6,6 +6,8 @@ Contains all basic definitions of available quests. +This table has `SMSG_QUEST_QUERY_RESPONSE` packet and questcache.wdb cache file associated with: Quest title, description, objectives, completion text. To see more information about: [Client Cache (wdb)](client-cache-wdb). + ## **Table Structure** | Field | Type | Attribute | Key | Null | Default | Extra | Comment |