summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/EmpyPopTracker/nms/README.md
blob: 38b7f51c90f22f837227098c64a382b380db59e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# NM data

The data structure for each trackable NM uses a series of nested NM entities. A standard NM entity contains the following data:

| Key                      | Type      | Required? | Description                         |
| ------------------------ | --------- | --------- | ----------------------------------- |
| name                     | String    | Required  | Name of the NM                      |
| collectable              | Number    | Optional  | The ID of the collectable item      |
| collectable_target_count | Number    | Optional  | The target no. of collectable items |
| pops                     | Table     | Optional  | The pop information for the NM      |
| pops{}.id                | Number    | Required  | The ID of the item/key item         |
| pops{}.type              | String    | Required  | Either "key item" or "item"         |
| pops{}.dropped_from      | NM Entity | Required  | A nested set of NM information      |

A simple example of the above would be:

```lua
{
    name = 'Azdaja',
    collectable = 3292, --Azdaja's Horn
    collectable_target_count = 75,
    pops = { {
        id = 1531, --Vacant Bugard Eye
        type = 'key item',
        dropped_from = { name = 'Deelgeed, Timed (F-9/F-10)' }
    } }
}
```

A larger example with multiple nested entities:

```lua
{
    name = 'Bukhis',
    collectable = 2966, --Bukhis's Wing
    collectable_target_count = 50,
    pops = { {
        id = 1508, --Ingrown Taurus Nail
        type = 'key item',
        dropped_from = {
            name = 'Khalkotaur, Forced (F-4)',
            pops = { {
                id = 3098, --Gnarled Taurus Horn
                type = 'item',
                dropped_from = { name = 'Aestutaur (G-9/G-10)' }
            } }
        }
    }, {
        id = 1509, --Ossified Gargouille Hand
        type = 'key item',
        dropped_from = {
            name = 'Quasimodo, Forced (F-4)',
            pops = { {
                id = 3099, --Gargouille Stone
                type = 'item',
                dropped_from = {
                    name = 'Gruesome Gargouille (F-10/G-10)'
                }
            } }
        }
    }, {
        id = 1510, --Imbrued Vampyr Fang
        type = 'key item',
        dropped_from = { name = 'Lord Varney, Timed (G-10/H-10)' }
    } }
}

```

The main addon file requires the index.lua file which in turn is responsible for requiring and returning data for each nm.