summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKitzunu <24550914+Kitzunu@users.noreply.github.com>2021-05-01 12:28:31 +0200
committerGitHub <noreply@github.com>2021-05-01 12:28:31 +0200
commite12fb303c30fcbf83df7197b433beba44171d682 (patch)
tree8a6aae921b54592c55abe608b854d4d314920a5c
parent29b1eb3ed30e0dd50ba1cfe222a33b070e3e6e0b (diff)
downloadwiki-e12fb303c30fcbf83df7197b433beba44171d682.tar.gz
wiki-e12fb303c30fcbf83df7197b433beba44171d682.tar.bz2
wiki-e12fb303c30fcbf83df7197b433beba44171d682.zip
fix(docs): Add dungeon requirement tables (#450)
* fix(docs): Add dungeon requirement tables * Update dungeon_access_template.md * make it more clear * Update dungeon_access_requirements.md * Update dungeon_access_template.md
-rw-r--r--docs/access_requirement.md109
-rw-r--r--docs/database-world.md3
-rw-r--r--docs/dungeon_access_requirements.md69
-rw-r--r--docs/dungeon_access_template.md65
4 files changed, 136 insertions, 110 deletions
diff --git a/docs/access_requirement.md b/docs/access_requirement.md
deleted file mode 100644
index a4d3acb..0000000
--- a/docs/access_requirement.md
+++ /dev/null
@@ -1,109 +0,0 @@
-# access\_requirement
-
-[<-Back-to:World](database-world.md)
-
-**The \`access\_requirement\` table**
-
-This table contains the access requirements to enter an instance.
-**Note:** If you reload this table with `.reload access_r`, you will have to close and reopen the ingame Dungeon Finder/Raid Browser to update its status.
-
-**Structure**
-
-| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|-----------------------------|--------------|------------|-----|------|---------|-------|---------|
-| [mapId][1] | MEDIUMINT | UNSIGNED | PRI | NO | | | |
-| [difficulty][2] | TINYINT | UNSIGNED | PRI | NO | 0 | | |
-| [level_min][3] | TINYINT | UNSIGNED | | NO | 0 | | |
-| [level_max][4] | TINYINT | UNSIGNED | | NO | 0 | | |
-| [item_level][5] | SMALLINT | UNSIGNED | | NO | 0 | | |
-| [item][6] | MEDIUMINT | UNSIGNED | | NO | 0 | | |
-| [item2][7] | MEDIUMINT | UNSIGNED | | NO | 0 | | |
-| [quest_done_A][8] | MEDIUMINT | UNSIGNED | | NO | 0 | | |
-| [quest_done_H][9] | MEDIUMINT | UNSIGNED | | NO | 0 | | |
-| [completed_achievement][10] | MEDIUMINT | UNSIGNED | | NO | 0 | | |
-| [quest_failed_text][11] | text | | | YES | | | |
-| [comment][12] | text | | | YES | | | |
-
-[1]: #mapid
-[2]: #difficulty
-[3]: #level_min
-[4]: #level_max
-[5]: #item_level
-[6]: #item
-[7]: #item2
-[8]: #quest_done_a
-[9]: #quest_done_h
-[10]: #completed_achievement
-[11]: #quest_failed_text
-[12]: #comment
-
-**Description of the fields**
-
-### mapId
-
-This is the [access\_id](instance_template) field from the [instance\_template](instance_template) table. It is an arbitrary number that merely links the requirements to an [instance\_template](instance_template), or [areatrigger\_teleport](areatrigger_teleport)
-
-### difficulty
-
-- 5 man dungeons - 0 for normal, 1 for heroic, 2 for epic (not used yet)
-- 10 man dungeons - 0 for normal, 2 for heroic
-- 25 man dungeons - 1 for normal, 3 for heroic
-
-### level\_min
-
-The minimum level that you must be in order to enter the instance.
-
-### level\_max
-
-The maximum level that you can be in order to enter the instance.
-
-### item\_level
-
-The at least required item level for an instance.
-
-- All WotLK Heroics require at least an average item level of 180.
-- Trial of the Champion, Pit of Saron, and the Forge of Souls require an average item level of 200.
-- Halls of Reflection requires an average item level of 219.
-
-**Note:** this requirement only applies to the Dungeon Finder and the Raid Browser, not to a dungeon/raid portal (and it's blizzlike). This also means a guild could try to clear a raid while being undergeared :)
-
-### item
-
-A horde only [item](item_template) that you must have in your inventory to enter the instance. This item can not be in the bank.
-
-### item2
-
-An alliance only [item](item_template) that you must have in your inventory. This item can not be in the bank.
-
-### quest\_done\_A
-
-A [quest](quest_template) that you must have completed. This field is only for alliance.
-
-### quest\_done\_H
-
-A [quest](quest_template) that you must have completed. This field is only for horde.
-
-### completed\_achievement
-
-An [achievement](Achievement) that must be completed by the player to enter an instance.
-
-### quest\_failed\_text
-
-The text that is shown if you try and enter the instance without having completed the quest.
-
-### comment
-
-This field is for any comment you want to make about the requirements or the instance. It is arbitrary text.
-
-### Example
-
-| mapId | difficulty | level_min | level_max | comment |
-|-------|------------|-----------|-----------|------------------------------|
-| 33 | 0 | 14 | 0 | Shadowfang Keep Entrance |
-| 34 | 0 | 15 | 0 | Stormwind Stockades Entrance |
-
-**Note:** The table, has more attributes, but as an example, it was not necessary to show them all, because most did not have values and thus, avoid the table is very extensive. The executed SQL query is the following:
-
-```sql
-SELECT `mapId`, `difficulty`, `level_min`, `level_max`, `comment` FROM `access_requirement` LIMIT 2;
-```
diff --git a/docs/database-world.md b/docs/database-world.md
index 4fd7a82..2ecdf1e 100644
--- a/docs/database-world.md
+++ b/docs/database-world.md
@@ -2,7 +2,6 @@
The world database has information basically related to creatures, objects, items, dialogs, texts and even scripts can be made through the smart_scripts table. It also has translations, achievements, events... We are currently working to review these tables and try to update those that do not have the correct information. That is why, if you detect any error in any of them, we invite you to open an [issue](https://github.com/azerothcore/wiki/issues), providing the appropriate information, so we can update it. We also invite you to create a [pull request](https://github.com/azerothcore/wiki/pulls), with the corresponding modifications, so that we can analyze the code and incorporate it if it is correct. Currently, we are working on updating. In the next [Update database-world.md](https://github.com/azerothcore/wiki/issues/357)
-- [access_requirement](access_requirement.md)
- [achievement_criteria_data](achievement_criteria_data.md)
- [achievement_dbc](achievement_dbc.md)
- [achievement_reward](achievement_reward.md)
@@ -40,6 +39,8 @@ The world database has information basically related to creatures, objects, item
- [creature_text_locale](creature_text_locale.md)
- [disables](disables.md)
- [disenchant_loot_template](loot_template.md)
+- [dungeon_access_requirements](dungeon_access_requirements.md)
+- [dungeon_access_template](dungeon_access_template.md)
- [event_scripts](event_scripts.md)
- [exploration_basexp](exploration_basexp.md)
- [fishing_loot_template](loot_template.md)
diff --git a/docs/dungeon_access_requirements.md b/docs/dungeon_access_requirements.md
new file mode 100644
index 0000000..cf00ecf
--- /dev/null
+++ b/docs/dungeon_access_requirements.md
@@ -0,0 +1,69 @@
+# dungeon\_access\_requirements
+
+[<-Back-to:World](database-world.md)
+
+**The \`dungeon\_access\_requirements\` table**
+
+**Structure**
+
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+|-----------------------------|--------------|------------|-----|------|---------|-------|---------|
+| [dungeon_access_id][1] | TINYINT | UNSIGNED | PRI | NO | | | |
+| [requirement_type][2] | TINYINT | UNSIGNED | PRI | NO | | | |
+| [requirement_id][3] | MEDIUMINT | UNSIGNED | PRI | NO | | | |
+| [requirement_note][4] | VARCHAR(255) | | | YES | NULL | | |
+| [faction][5] | TINYINT | UNSIGNED | | NO | 2 | | |
+| [priority][6] | TINYINT | UNSIGNED | | YES | NULL | | |
+| [leader_only][7] | TINYINT | SIGNED | | NO | 0 | | |
+| [comment][8] | VARCHAR(255) | | | YES | NULL | | |
+
+[1]: #dungeon_access_id
+[2]: #requirement_type
+[3]: #requirement_id
+[4]: #requirement_note
+[5]: #faction
+[6]: #priority
+[7]: #leader_only
+[8]: #comment
+
+**Description of the fields**
+
+### dungeon_access_id
+
+ID from [dungeon_access_template.id](dungeon_access_template#id).
+
+### requirement_type
+
+| Value | Type | Comment |
+|:------|:------------|:--------------------------------|
+| 0 | Achievement | |
+| 1 | Quest | |
+| 2 | Item | The item cannot be in the bank. |
+
+### requirement_id
+
+ID for Achievement, Quest or Item depending on chosen [requirement_type][2].
+
+### requirement_note
+
+The text that is shown if you try and enter the instance without meeting the requirements.
+
+### faction
+
+| Value | Comment |
+|:------|:------------|
+| 0 | Alliance |
+| 1 | Horde |
+| 2 | Both |
+
+### priority
+
+Priority order for the requirement, sorted by type. 0 is the highest priority.
+
+### leader_only
+
+0 = Check the requirement for each player trying to enter.
+
+1 = Only check the requirement for the party leader.
+
+### comment
diff --git a/docs/dungeon_access_template.md b/docs/dungeon_access_template.md
new file mode 100644
index 0000000..b271dc6
--- /dev/null
+++ b/docs/dungeon_access_template.md
@@ -0,0 +1,65 @@
+# dungeon\_access\_template
+
+[<-Back-to:World](database-world.md)
+
+**The \`dungeon\_access\_template\` table**
+
+**Structure**
+
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+|-----------------------------|--------------|------------|-----|------|---------|-----------------------------------------------|---------|
+| [id][1] | TINYINT | UNSIGNED | PRI | NO | | AUTO_INCREMENT | |
+| [map_id][2] | MEDIUMINT | UNSIGNED | KEY | NO | | FK_dungeon_access_template__instance_template | |
+| [difficulty][3] | TINYINT | UNSIGNED | | NO | 0 | | |
+| [min_level][4] | TINYINT | UNSIGNED | | YES | NULL | | |
+| [max_level][5] | TINYINT | UNSIGNED | | YES | NULL | | |
+| [min_avg_item_level][6] | SMALLINT | UNSIGNED | | YES | NULL | | |
+| [comment][7] | VARCHAR(255) | | | YES | NULL | | |
+
+[1]: #id
+[2]: #map_id
+[3]: #difficulty
+[4]: #min_level
+[5]: #max_level
+[6]: #min_avg_item_level
+[7]: #comment
+
+**Description of the fields**
+
+### id
+
+The dungeon template ID
+
+### map_id
+
+Map ID from [instance_template.map](instance_template#map).
+
+### difficulty
+
+- 5 man: 0 = normal, 1 = heroic, 2 = epic (Mythic, not implemented in 3.3.5)
+
+- 10 man: 0 = normal, 2 = heroic
+
+- 25 man: 1 = normal, 3 = heroic
+
+### min_level
+
+The minimum level you must be to enter the instance.
+
+### max_level
+
+The maximum level you can be to enter the instance.
+
+### min_avg_item_level
+
+Min average ilvl required to enter the instance.
+
+- All WotLK Heroics require at least an average item level of 180.
+
+- Trial of the Champion, Pit of Saron, and the Forge of Souls require an average item level of 200.
+
+- Halls of Reflection requires an average item level of 219.
+
+**Note:** this requirement only applies to the Dungeon Finder and the Raid Browser, not to a dungeon/raid portal (and it's blizzlike). This also means a guild could try to clear a raid while being undergeared :)
+
+### comment