summaryrefslogtreecommitdiff
path: root/docs/spawn_group_template.md
diff options
context:
space:
mode:
authorFrancescoBorzi <borzifrancesco@gmail.com>2019-02-25 19:24:20 +0100
committerFrancescoBorzi <borzifrancesco@gmail.com>2019-02-25 19:24:20 +0100
commita35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3 (patch)
tree91e0cde00f6f27b730b0df3f4338fcf99fa8447a /docs/spawn_group_template.md
parentd8d1823802ded97300fa57405d80b16736603489 (diff)
downloadwiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.tar.gz
wiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.tar.bz2
wiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.zip
Import DB wiki from TC 335
Diffstat (limited to 'docs/spawn_group_template.md')
-rw-r--r--docs/spawn_group_template.md81
1 files changed, 81 insertions, 0 deletions
diff --git a/docs/spawn_group_template.md b/docs/spawn_group_template.md
new file mode 100644
index 0000000..1c76c94
--- /dev/null
+++ b/docs/spawn_group_template.md
@@ -0,0 +1,81 @@
+# spawn\_group\_template
+
+`Back-to:World`
+
+**The \`spawn\_group\_template\` table**
+
+This table contains Spawn Group names and flags.
+
+**Structure**
+
+<table>
+<tbody>
+<tr class="odd">
+<td><p><strong>Field</strong></p></td>
+<td><p><strong>Type</strong></p></td>
+<td><p><strong>Attributes</strong></p></td>
+<td><p><strong>Key</strong></p></td>
+<td><p><strong>Null</strong></p></td>
+<td><p><strong>Default</strong></p></td>
+<td><p><strong>Extra</strong></p></td>
+<td><p><strong>Comment</strong></p></td>
+</tr>
+<tr class="even">
+<td><p><a href="#spawn_group_template-mapId">g</a><a href="#spawn_group_template-groupId">roupId</a></p></td>
+<td><p>int(10)</p></td>
+<td><p>unsigned</p></td>
+<td><p>PRI</p></td>
+<td><p>NO</p></td>
+<td><p>NULL</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+</tr>
+<tr class="odd">
+<td><p><a href="#spawn_group_template-difficulty">g</a><a href="#spawn_group_template-groupName">roupName</a></p></td>
+<td><p>varchar(100)</p></td>
+<td><p><br />
+</p></td>
+<td><p><br />
+</p></td>
+<td><p>NO</p></td>
+<td><p>NULL</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+</tr>
+<tr class="even">
+<td><p><a href="#spawn_group_template-level_min">g</a><a href="#spawn_group_template-groupFlags">roupFlags</a></p></td>
+<td><p>int(10)</p></td>
+<td><p>unsigned</p></td>
+<td><p> </p></td>
+<td><p>NO</p></td>
+<td><p>0</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+</tr>
+</tbody>
+</table>
+
+**Description of the fields**
+
+### groupId
+
+This is the Group ID for the group. It must be a unique number. Groups 0-4 are reserved for system tasks.
+
+### groupName
+
+This is a descriptive name for the group.
+
+### groupFlags
+
+These are the flags that will apply to the group.
+
+| Flag | Number | Description |
+|----------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| SPAWNGROUP\_FLAG\_NONE | 0x00 | No flags applied |
+| SPAWNGROUP\_FLAG\_SYSTEM | 0x01 | This group is a system group (applies to standard groups 0-4) |
+| SPAWNGROUP\_FLAG\_COMPATIBILITY\_MODE | 0x02 | This group will contain legacy objects/creatures that don't work with dynamic spawn changes |
+| SPAWNGROUP\_FLAG\_MANUAL\_SPAWN | 0x04 | This group will not be spawned by core by default. Scripts can manually spawn/despawn these groups on demand. |
+| SPAWNGROUP\_FLAG\_DYNAMIC\_SPAWN\_RATE | 0x08 | This group will have dynamic spawn rates applied (by default quest interested creatures/gos and gather nodes use this) |
+| SPAWNGROUP\_FLAG\_ESCORTQUESTNPC | 0x10 | This group contains Escort quest NPCs. This further enhances Dynamic spawn to begin respawn time at the point a quest is taken and the escort begins |
+
+