summaryrefslogtreecommitdiff
path: root/docs/creature_summon_groups.md
blob: 3a970f87cb77bc809a5132fceec2aaf7b55be018 (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# creature\_summon\_groups

[<-Back-to:World](database-world.md)

# 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

| Field             | Type         | Attributes | Key | Null | Default | Extra | Comment |
|-------------------|--------------|------------|-----|------|---------|-------|---------|
| [summonerId][1]   | MEDIUMINT | UNSIGNED   |     | NO   | 0       |       |         |
| [summonerType][2] | TINYINT   | UNSIGNED   |     | NO   | 0       |       |         |
| [groupId][3]      | TINYINT   | UNSIGNED   |     | NO   | 0       |       |         |
| [entry][4]        | MEDIUMINT | UNSIGNED   |     | NO   | 0       |       |         |
| [position_x][5]   | FLOAT        |            |     | NO   | 0       |       |         |
| [position_y][6]   | FLOAT        |            |     | NO   | 0       |       |         |
| [position_z][7]   | FLOAT        |            |     | NO   | 0       |       |         |
| [orientation][8]  | FLOAT        |            |     | NO   | 0       |       |         |
| [summonType][9]   | TINYINT   | UNSIGNED   |     | NO   | 0       |       |         |
| [summonTime][10]  | INT      | UNSIGNED   |     | NO   | 0       |       |         |

[1]: #summonerid
[2]: #summonertype
[3]: #groupid
[4]: #entry
[5]: #position_x
[6]: #position_y
[7]: #position_z
[8]: #orientation
[9]: #summontype
[10]: #summontime

## **Description of the fields**

### summonerId

Summoner's id depending on [summonerType](#creature_summon_groups-summonerType)

### summonerType

Summoner's type:

| Value | Type                     |
|-------|--------------------------|
| 0     | SUMMONER_TYPE_CREATURE   |
| 1     | SUMMONER_TYPE_GAMEOBJECT |
| 2     | SUMMONER_TYPE_MAP        |

### 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](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

| Value | Name                                   | Comments                                                            |
|-------|----------------------------------------|---------------------------------------------------------------------|
| 1     | TEMPSUMMON_TIMED_OR_DEAD_DESPAWN       | Despawns after a specified time OR when the creature disappears     |
| 2     | TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN     | Despawns after a specified time OR when the creature dies           |
| 3     | TEMPSUMMON_TIMED_DESPAWN               | Despawns after a specified time                                     |
| 4     | TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT | Despawns after a specified time after the creature is out of combat |
| 5     | TEMPSUMMON_CORPSE_DESPAWN              | Despawns instantly after death                                      |
| 6     | TEMPSUMMON_CORPSE_TIMED_DESPAWN        | Despawns after a specified time after death                         |
| 7     | TEMPSUMMON_DEAD_DESPAWN                | Despawns when the creature disappears                               |
| 8     | TEMPSUMMON_MANUAL_DESPAWN              | Despawns when UnSummon() is called                                  |

### summonTime

Timer linked to summontype