summaryrefslogtreecommitdiff
path: root/docs/creature_summon_groups.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/creature_summon_groups.md
parentd8d1823802ded97300fa57405d80b16736603489 (diff)
downloadwiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.tar.gz
wiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.tar.bz2
wiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.zip
Import DB wiki from TC 335
Diffstat (limited to 'docs/creature_summon_groups.md')
-rw-r--r--docs/creature_summon_groups.md272
1 files changed, 258 insertions, 14 deletions
diff --git a/docs/creature_summon_groups.md b/docs/creature_summon_groups.md
index 807b7fd..9d25a1e 100644
--- a/docs/creature_summon_groups.md
+++ b/docs/creature_summon_groups.md
@@ -1,14 +1,258 @@
-[Database Structure](Database-Structure) > [World-Database](World-Database) > [creature_summon_groups](creature_summon_groups)
-
-Column | Type | Description
---- | --- | ---
-SummonerId | mediumint(8) unsigned |
-SummonerType | tinyint(3) unsigned |
-GroupId | tinyint(3) unsigned |
-Entry | mediumint(8) unsigned |
-Position_x | float |
-Position_y | float |
-Position_z | float |
-Orientation | float |
-SummonType | tinyint(3) unsigned |
-SummonTime | int(10) unsigned |
+# creature\_summon\_groups
+
+`Back-to:World`
+
+# Table: creature\_summon\_groups
+
+This table holds data about temporary summoned creatures. It is possible to group summons and create boss waves of adds etc.
+
+## Structure
+
+<table>
+<colgroup>
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+</colgroup>
+<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="#creature_summon_groups-summo">summonerId</a></p></td>
+<td><p>mediumint(8)</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>
+<tr class="odd">
+<td><p><a href="#creature_summon_groups-summonerType">summonerType</a></p></td>
+<td><p>tinyint(3)</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>
+<tr class="even">
+<td><a href="#creature_summon_groups-groupId">groupId</a></td>
+<td>tinyint(3)</td>
+<td>unsigned</td>
+<td> </td>
+<td>NO</td>
+<td>0</td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="odd">
+<td><a href="#creature_summon_groups-entry">entry</a></td>
+<td>mediumint(8)</td>
+<td>unsigned</td>
+<td> </td>
+<td>NO</td>
+<td>0</td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="even">
+<td><p><a href="#creature_summon_groups-position_x">position_x</a></p></td>
+<td><p>float</p></td>
+<td><p> </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>
+<tr class="odd">
+<td><p><a href="#creature_summon_groups-position_y">position_y</a></p></td>
+<td><p>float</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+<td><p>NO</p></td>
+<td><p>0</p></td>
+<td><p> </p></td>
+<td> </td>
+</tr>
+<tr class="even">
+<td><p><a href="#creature_summon_groups-position_z">position_z</a></p></td>
+<td><p>float</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+<td><p>NO</p></td>
+<td><p>0</p></td>
+<td><p> </p></td>
+<td> </td>
+</tr>
+<tr class="odd">
+<td><p><a href="#creature_summon_groups-orientation">orientation</a></p></td>
+<td><p>float</p></td>
+<td><p> </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>
+<tr class="even">
+<td><a href="#creature_summon_groups-summonType">summonType</a></td>
+<td>tinyint(3)</td>
+<td>unsigned</td>
+<td> </td>
+<td>NO</td>
+<td>0</td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="odd">
+<td><a href="#creature_summon_groups-summonTime">summonTime</a></td>
+<td>int(10)</td>
+<td>unsigned</td>
+<td> </td>
+<td>NO</td>
+<td>0</td>
+<td> </td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+
+## **Description of the fields**
+
+### summonerId
+
+Summoner's id depending on [summonerType](#creature_summon_groups-summonerType)
+
+### summonerType
+
+Summoner's type:
+
+<table>
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th><p>Value</p></th>
+<th><p>Type</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td><p>0</p></td>
+<td><p>SUMMONER_TYPE_CREATURE</p></td>
+</tr>
+<tr class="even">
+<td><p>1</p></td>
+<td><p>SUMMONER_TYPE_GAMEOBJECT</p></td>
+</tr>
+<tr class="odd">
+<td><p>2</p></td>
+<td><p>SUMMONER_TYPE_MAP</p></td>
+</tr>
+</tbody>
+</table>
+
+### groupId
+
+Group identificator, all creatures with the same [groupId](#creature_summon_groups-groupId) will be summoned at once
+
+### entry
+
+Entry of summoned creature from [creature\_template.entry](http://collab.kpsn.org/display/tc/creature_template#entry)
+
+### position\_x
+
+X coordinate of position, where the creature will be spawned
+
+### position\_y
+
+Y coordinate of position, where the creature will be spawned
+
+### position\_z
+
+Z coordinate of position, where the creature will be spawned
+
+### orientation
+
+Orientation the summoned creature will get when spawned
+
+### summonType
+
+<table>
+<colgroup>
+<col width="33%" />
+<col width="33%" />
+<col width="33%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th><p>Value</p></th>
+<th><p>Name</p></th>
+<th><p>Comments</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td><p>1</p></td>
+<td><p>TEMPSUMMON_TIMED_OR_DEAD_DESPAWN</p></td>
+<td><p>Despawns after a specified time OR when the creature disappears</p></td>
+</tr>
+<tr class="even">
+<td><p>2</p></td>
+<td><p>TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN</p></td>
+<td><p>Despawns after a specified time OR when the creature dies</p></td>
+</tr>
+<tr class="odd">
+<td><p>3</p></td>
+<td><p>TEMPSUMMON_TIMED_DESPAWN</p></td>
+<td><p>Despawns after a specified time</p></td>
+</tr>
+<tr class="even">
+<td><p>4</p></td>
+<td><p>TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT</p></td>
+<td><p>Despawns after a specified time after the creature is out of combat</p></td>
+</tr>
+<tr class="odd">
+<td><p>5</p></td>
+<td><p>TEMPSUMMON_CORPSE_DESPAWN</p></td>
+<td><p>Despawns instantly after death</p></td>
+</tr>
+<tr class="even">
+<td><p>6</p></td>
+<td><p>TEMPSUMMON_CORPSE_TIMED_DESPAWN</p></td>
+<td><p>Despawns after a specified time after death</p></td>
+</tr>
+<tr class="odd">
+<td><p>7</p></td>
+<td><p>TEMPSUMMON_DEAD_DESPAWN</p></td>
+<td><p>Despawns when the creature disappears</p></td>
+</tr>
+<tr class="even">
+<td><p>8</p></td>
+<td><p>TEMPSUMMON_MANUAL_DESPAWN</p></td>
+<td><p>Despawns when UnSummon() is called</p></td>
+</tr>
+</tbody>
+</table>
+
+### summonTime
+
+Timer linked to summontype