Skip to content

Commit b90cb73

Browse files
engsr6982ShrBox
engsr6982
authored and
ShrBox
committed
docs: update ActorDamageCause enum documentation
1 parent e3b27bf commit b90cb73

File tree

6 files changed

+236
-219
lines changed

6 files changed

+236
-219
lines changed

‎docs/apis/EventAPI/EntityEvents.md‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -33,45 +33,45 @@ Note that when the player dies, in addition to triggering `onPlayerDie` event, t
3333

3434
Here are values of `ActorDamageCause`:
3535

36-
| ActorDamageCause | Enum Value |
37-
|------------------|------------|
38-
| None | -1 |
39-
| Override | 0 |
40-
| Contact | 1 |
41-
| EntityAttack | 2 |
42-
| Projectile | 3 |
43-
| Suffocation | 4 |
44-
| Fall | 5 |
45-
| Fire | 6 |
46-
| FireTick | 7 |
47-
| Lava | 8 |
48-
| Drowning | 9 |
49-
| BlockExplosion | 10 |
50-
| EntityExplosion | 11 |
51-
| Void | 12 |
52-
| Suicide | 13 |
53-
| Magic | 14 |
54-
| Wither | 15 |
55-
| Starve | 16 |
56-
| Anvil | 17 |
57-
| Thorns | 18 |
58-
| FallingBlock | 19 |
59-
| Piston | 20 |
60-
| FlyIntoWall | 21 |
61-
| Magma | 22 |
62-
| Fireworks | 23 |
63-
| Lightning | 24 |
64-
| Charging | 25 |
65-
| Temperature | 26 |
66-
| Freezing | 27 |
67-
| Stalactite | 28 |
68-
| Stalagmite | 29 |
69-
| RamAttack | 30 |
70-
| SonicBoom | 31 |
71-
| Campfire | 32 |
72-
| SoulCampfire | 33 |
73-
| MaceSmash | 34 |
74-
| All | 35 |
36+
| `ActorDamageCause` ENUM | Value |
37+
| ---------------------------------- | --- |
38+
| `ActorDamageCause.None` | -1 |
39+
| `ActorDamageCause.Override` | 0 |
40+
| `ActorDamageCause.Contact` | 1 |
41+
| `ActorDamageCause.EntityAttack` | 2 |
42+
| `ActorDamageCause.Projectile` | 3 |
43+
| `ActorDamageCause.Suffocation` | 4 |
44+
| `ActorDamageCause.Fall` | 5 |
45+
| `ActorDamageCause.Fire` | 6 |
46+
| `ActorDamageCause.FireTick` | 7 |
47+
| `ActorDamageCause.Lava` | 8 |
48+
| `ActorDamageCause.Drowning` | 9 |
49+
| `ActorDamageCause.BlockExplosion` | 10 |
50+
| `ActorDamageCause.EntityExplosion` | 11 |
51+
| `ActorDamageCause.Void` | 12 |
52+
| `ActorDamageCause.SelfDestruct` | 13 |
53+
| `ActorDamageCause.Magic` | 14 |
54+
| `ActorDamageCause.Wither` | 15 |
55+
| `ActorDamageCause.Starve` | 16 |
56+
| `ActorDamageCause.Anvil` | 17 |
57+
| `ActorDamageCause.Thorns` | 18 |
58+
| `ActorDamageCause.FallingBlock` | 19 |
59+
| `ActorDamageCause.Piston` | 20 |
60+
| `ActorDamageCause.FlyIntoWall` | 21 |
61+
| `ActorDamageCause.Magma` | 22 |
62+
| `ActorDamageCause.Fireworks` | 23 |
63+
| `ActorDamageCause.Lightning` | 24 |
64+
| `ActorDamageCause.Charging` | 25 |
65+
| `ActorDamageCause.Temperature` | 26 |
66+
| `ActorDamageCause.Freezing` | 27 |
67+
| `ActorDamageCause.Stalactite` | 28 |
68+
| `ActorDamageCause.Stalagmite` | 29 |
69+
| `ActorDamageCause.RamAttack` | 30 |
70+
| `ActorDamageCause.SonicBoom` | 31 |
71+
| `ActorDamageCause.Campfire` | 32 |
72+
| `ActorDamageCause.SoulCampfire` | 33 |
73+
| `ActorDamageCause.MaceSmash` | 34 |
74+
| `ActorDamageCause.All` | 35 |
7575

7676
#### `"onEntityExplode"` - Entity Explosion Event
7777

‎docs/apis/EventAPI/EntityEvents.zh.md‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -33,45 +33,45 @@
3333

3434
ActorDamageCause 为伤害原因枚举，枚举值如下，有问号的待验证，？？？待补充
3535

36-
| 伤害原因 | 枚举值 | 解释 |
37-
|-----------------|-----|----------------------------------------|
38-
| None | -1 | 其他 |
39-
| Override | 0 | 非正常方式（如脚本直接设置血量为0），这种方式的伤害不会被盔甲与buff吸收 |
40-
| Contact | 1 | 接触伤害（如仙人掌） |
41-
| EntityAttack | 2 | 实体攻击 |
42-
| Projectile | 3 | 抛射物攻击 |
43-
| Suffocation | 4 | 窒息（密封空间） |
44-
| Fall | 5 | 掉落 |
45-
| Fire | 6 | 燃烧 |
46-
| FireTick | 7 | 点燃 |
47-
| Lava | 8 | 熔岩 |
48-
| Drowning | 9 | 溺水 |
49-
| BlockExplosion | 10 | 方块爆炸 |
50-
| EntityExplosion | 11 | 实体爆炸 |
51-
| Void | 12 | 虚空 |
52-
| Suicide | 13 | 自杀 |
53-
| Magic | 14 | 尖牙对生物造成的伤害、守卫者对生物造成的魔法伤害和药水伤害等 |
54-
| Wither | 15 | 凋零效果 |
55-
| Starve | 16 | 饥饿 |
56-
| Anvil | 17 | 下落的铁砧 |
57-
| Thorns | 18 | 荆棘 |
58-
| FallingBlock | 19 | 下落的方块 |
59-
| Piston | 20 | 活塞 |
60-
| FlyIntoWall | 21 | 动能（滑翔撞墙） |
61-
| Magma | 22 | 岩浆块 |
62-
| Fireworks | 23 | 烟花 |
63-
| Lightning | 24 | 闪电 |
64-
| Charging | 25 | 充能（？） |
65-
| Temperature | 26 | 温度 （雪人？） |
66-
| Freezing | 27 | 冰冻 |
67-
| Stalactite | 28 | 被钟乳石砸到 |
68-
| Stalagmite | 29 | 掉落到石笋上 |
69-
| RamAttack | 30 | 山羊冲撞 |
70-
| SonicBoom | 31 | 坚守着音爆攻击 |
71-
| Campfire | 32 | 营火 |
72-
| SoulCampfire | 33 | 灵魂营火 |
73-
| MaceSmash | 34 | 下落攻击 |
74-
| All | 35 | 所有 |
36+
| `ActorDamageCause` 枚举 | 值 | 解释 |
37+
| ---------------------------------- | --- | ---------------------------------------- |
38+
| `ActorDamageCause.None` | -1 | 其他 |
39+
| `ActorDamageCause.Override` | 0 | 非正常方式（如脚本直接设置血量为0），这种方式的伤害不会被盔甲与buff吸收 |
40+
| `ActorDamageCause.Contact` | 1 | 接触伤害（如仙人掌） |
41+
| `ActorDamageCause.EntityAttack` | 2 | 实体攻击 |
42+
| `ActorDamageCause.Projectile` | 3 | 抛射物攻击 |
43+
| `ActorDamageCause.Suffocation` | 4 | 窒息（密封空间） |
44+
| `ActorDamageCause.Fall` | 5 | 掉落 |
45+
| `ActorDamageCause.Fire` | 6 | 燃烧 |
46+
| `ActorDamageCause.FireTick` | 7 | 点燃 |
47+
| `ActorDamageCause.Lava` | 8 | 熔岩 |
48+
| `ActorDamageCause.Drowning` | 9 | 溺水 |
49+
| `ActorDamageCause.BlockExplosion` | 10 | 方块爆炸 |
50+
| `ActorDamageCause.EntityExplosion` | 11 | 实体爆炸 |
51+
| `ActorDamageCause.Void` | 12 | 虚空 |
52+
| `ActorDamageCause.SelfDestruct` | 13 | 自杀 |
53+
| `ActorDamageCause.Magic` | 14 | 尖牙对生物造成的伤害、守卫者对生物造成的魔法伤害和药水伤害等 |
54+
| `ActorDamageCause.Wither` | 15 | 凋零效果 |
55+
| `ActorDamageCause.Starve` | 16 | 饥饿 |
56+
| `ActorDamageCause.Anvil` | 17 | 下落的铁砧 |
57+
| `ActorDamageCause.Thorns` | 18 | 荆棘 |
58+
| `ActorDamageCause.FallingBlock` | 19 | 下落的方块 |
59+
| `ActorDamageCause.Piston` | 20 | 活塞 |
60+
| `ActorDamageCause.FlyIntoWall` | 21 | 动能（滑翔撞墙） |
61+
| `ActorDamageCause.Magma` | 22 | 岩浆块 |
62+
| `ActorDamageCause.Fireworks` | 23 | 烟花 |
63+
| `ActorDamageCause.Lightning` | 24 | 闪电 |
64+
| `ActorDamageCause.Charging` | 25 | 充能（？） |
65+
| `ActorDamageCause.Temperature` | 26 | 温度 （雪人？） |
66+
| `ActorDamageCause.Freezing` | 27 | 冰冻 |
67+
| `ActorDamageCause.Stalactite` | 28 | 被钟乳石砸到 |
68+
| `ActorDamageCause.Stalagmite` | 29 | 掉落到石笋上 |
69+
| `ActorDamageCause.RamAttack` | 30 | 山羊冲撞 |
70+
| `ActorDamageCause.SonicBoom` | 31 | 坚守着音爆攻击 |
71+
| `ActorDamageCause.Campfire` | 32 | 营火 |
72+
| `ActorDamageCause.SoulCampfire` | 33 | 灵魂营火 |
73+
| `ActorDamageCause.MaceSmash` | 34 | 下落攻击 |
74+
| `ActorDamageCause.All` | 35 | 所有 |
7575

7676
#### `"onEntityExplode"` - 发生由实体引起的爆炸
7777

‎docs/apis/GameAPI/Entity.md‎

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -204,44 +204,45 @@ Each entity object contains some member functions (member methods) that can be e
204204

205205
Note that the damage dealt here is real damage and cannot be reduced by protective equipment such as armor.
206206

207-
| ActorDamageCause ENUM | Value |
208-
|------------------------------------|-------|
209-
| `ActorDamageCause.Override` | -1 |
210-
| `ActorDamageCause.Contact ` | 0 |
211-
| `ActorDamageCause.EntityAttack` | 1 |
212-
| `ActorDamageCause.Projectile` | 2 |
213-
| `ActorDamageCause.Suffocation` | 3 |
214-
| `ActorDamageCause.All` | 4 |
215-
| `ActorDamageCause.Fire` | 5 |
216-
| `ActorDamageCause.FireTick` | 6 |
217-
| `ActorDamageCause.Lava` | 7 |
218-
| `ActorDamageCause.Drowning ` | 8 |
219-
| `ActorDamageCause.BlockExplosion` | 9 |
220-
| `ActorDamageCause.EntityExplosion` | 10 |
221-
| `ActorDamageCause.Void` | 11 |
222-
| `ActorDamageCause.Suicide` | 12 |
223-
| `ActorDamageCause.Magic` | 13 |
224-
| `ActorDamageCause.Wither` | 14 |
225-
| `ActorDamageCause.Starve` | 15 |
226-
| `ActorDamageCause.Anvil` | 16 |
227-
| `ActorDamageCause.Thorns` | 17 |
228-
| `ActorDamageCause.FallingBlock` | 18 |
229-
| `ActorDamageCause.Piston` | 19 |
230-
| `ActorDamageCause.FlyIntoWall` | 20 |
231-
| `ActorDamageCause.Magma` | 21 |
232-
| `ActorDamageCause.Fireworks` | 22 |
233-
| `ActorDamageCause.Lightning` | 23 |
234-
| `ActorDamageCause.Charging` | 24 |
235-
| `ActorDamageCause.Temperature` | 25 |
236-
| `ActorDamageCause.Freezing` | 26 |
237-
| `ActorDamageCause.Stalactite` | 27 |
238-
| `ActorDamageCause.Stalagmite` | 28 |
239-
| `ActorDamageCause.RamAttack` | 29 |
240-
| `ActorDamageCause.SonicBoom` | 30 |
241-
| `ActorDamageCause.Campfire` | 31 |
242-
| `ActorDamageCause.SoulCampfire` | 32 |
243-
| `ActorDamageCause.MaceSmash` | 33 |
244-
| `ActorDamageCause.All` | 34 |
207+
| `ActorDamageCause` ENUM | Value |
208+
| ---------------------------------- | --- |
209+
| `ActorDamageCause.None` | -1 |
210+
| `ActorDamageCause.Override` | 0 |
211+
| `ActorDamageCause.Contact` | 1 |
212+
| `ActorDamageCause.EntityAttack` | 2 |
213+
| `ActorDamageCause.Projectile` | 3 |
214+
| `ActorDamageCause.Suffocation` | 4 |
215+
| `ActorDamageCause.Fall` | 5 |
216+
| `ActorDamageCause.Fire` | 6 |
217+
| `ActorDamageCause.FireTick` | 7 |
218+
| `ActorDamageCause.Lava` | 8 |
219+
| `ActorDamageCause.Drowning` | 9 |
220+
| `ActorDamageCause.BlockExplosion` | 10 |
221+
| `ActorDamageCause.EntityExplosion` | 11 |
222+
| `ActorDamageCause.Void` | 12 |
223+
| `ActorDamageCause.SelfDestruct` | 13 |
224+
| `ActorDamageCause.Magic` | 14 |
225+
| `ActorDamageCause.Wither` | 15 |
226+
| `ActorDamageCause.Starve` | 16 |
227+
| `ActorDamageCause.Anvil` | 17 |
228+
| `ActorDamageCause.Thorns` | 18 |
229+
| `ActorDamageCause.FallingBlock` | 19 |
230+
| `ActorDamageCause.Piston` | 20 |
231+
| `ActorDamageCause.FlyIntoWall` | 21 |
232+
| `ActorDamageCause.Magma` | 22 |
233+
| `ActorDamageCause.Fireworks` | 23 |
234+
| `ActorDamageCause.Lightning` | 24 |
235+
| `ActorDamageCause.Charging` | 25 |
236+
| `ActorDamageCause.Temperature` | 26 |
237+
| `ActorDamageCause.Freezing` | 27 |
238+
| `ActorDamageCause.Stalactite` | 28 |
239+
| `ActorDamageCause.Stalagmite` | 29 |
240+
| `ActorDamageCause.RamAttack` | 30 |
241+
| `ActorDamageCause.SonicBoom` | 31 |
242+
| `ActorDamageCause.Campfire` | 32 |
243+
| `ActorDamageCause.SoulCampfire` | 33 |
244+
| `ActorDamageCause.MaceSmash` | 34 |
245+
| `ActorDamageCause.All` | 35 |
245246

246247
#### Heal the Entity
247248

‎docs/apis/GameAPI/Entity.zh.md‎

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -194,44 +194,45 @@
194194

195195
注意，此处造成的伤害为真实伤害，无法被盔甲等保护装备减免
196196

197-
| 伤害类型枚举 | 枚举值 |
198-
|------------------------------------|-----|
199-
| `ActorDamageCause.Override` | -1 |
200-
| `ActorDamageCause.Contact ` | 0 |
201-
| `ActorDamageCause.EntityAttack` | 1 |
202-
| `ActorDamageCause.Projectile` | 2 |
203-
| `ActorDamageCause.Suffocation` | 3 |
204-
| `ActorDamageCause.All` | 4 |
205-
| `ActorDamageCause.Fire` | 5 |
206-
| `ActorDamageCause.FireTick` | 6 |
207-
| `ActorDamageCause.Lava` | 7 |
208-
| `ActorDamageCause.Drowning ` | 8 |
209-
| `ActorDamageCause.BlockExplosion` | 9 |
210-
| `ActorDamageCause.EntityExplosion` | 10 |
211-
| `ActorDamageCause.Void` | 11 |
212-
| `ActorDamageCause.Suicide` | 12 |
213-
| `ActorDamageCause.Magic` | 13 |
214-
| `ActorDamageCause.Wither` | 14 |
215-
| `ActorDamageCause.Starve` | 15 |
216-
| `ActorDamageCause.Anvil` | 16 |
217-
| `ActorDamageCause.Thorns` | 17 |
218-
| `ActorDamageCause.FallingBlock` | 18 |
219-
| `ActorDamageCause.Piston` | 19 |
220-
| `ActorDamageCause.FlyIntoWall` | 20 |
221-
| `ActorDamageCause.Magma` | 21 |
222-
| `ActorDamageCause.Fireworks` | 22 |
223-
| `ActorDamageCause.Lightning` | 23 |
224-
| `ActorDamageCause.Charging` | 24 |
225-
| `ActorDamageCause.Temperature` | 25 |
226-
| `ActorDamageCause.Freezing` | 26 |
227-
| `ActorDamageCause.Stalactite` | 27 |
228-
| `ActorDamageCause.Stalagmite` | 28 |
229-
| `ActorDamageCause.RamAttack` | 29 |
230-
| `ActorDamageCause.SonicBoom` | 30 |
231-
| `ActorDamageCause.Campfire` | 31 |
232-
| `ActorDamageCause.SoulCampfire` | 32 |
233-
| `ActorDamageCause.MaceSmash` | 33 |
234-
| `ActorDamageCause.All` | 34 |
197+
| `ActorDamageCause` 枚举 | 值 |
198+
| ---------------------------------- | --- |
199+
| `ActorDamageCause.None` | -1 |
200+
| `ActorDamageCause.Override` | 0 |
201+
| `ActorDamageCause.Contact` | 1 |
202+
| `ActorDamageCause.EntityAttack` | 2 |
203+
| `ActorDamageCause.Projectile` | 3 |
204+
| `ActorDamageCause.Suffocation` | 4 |
205+
| `ActorDamageCause.Fall` | 5 |
206+
| `ActorDamageCause.Fire` | 6 |
207+
| `ActorDamageCause.FireTick` | 7 |
208+
| `ActorDamageCause.Lava` | 8 |
209+
| `ActorDamageCause.Drowning` | 9 |
210+
| `ActorDamageCause.BlockExplosion` | 10 |
211+
| `ActorDamageCause.EntityExplosion` | 11 |
212+
| `ActorDamageCause.Void` | 12 |
213+
| `ActorDamageCause.SelfDestruct` | 13 |
214+
| `ActorDamageCause.Magic` | 14 |
215+
| `ActorDamageCause.Wither` | 15 |
216+
| `ActorDamageCause.Starve` | 16 |
217+
| `ActorDamageCause.Anvil` | 17 |
218+
| `ActorDamageCause.Thorns` | 18 |
219+
| `ActorDamageCause.FallingBlock` | 19 |
220+
| `ActorDamageCause.Piston` | 20 |
221+
| `ActorDamageCause.FlyIntoWall` | 21 |
222+
| `ActorDamageCause.Magma` | 22 |
223+
| `ActorDamageCause.Fireworks` | 23 |
224+
| `ActorDamageCause.Lightning` | 24 |
225+
| `ActorDamageCause.Charging` | 25 |
226+
| `ActorDamageCause.Temperature` | 26 |
227+
| `ActorDamageCause.Freezing` | 27 |
228+
| `ActorDamageCause.Stalactite` | 28 |
229+
| `ActorDamageCause.Stalagmite` | 29 |
230+
| `ActorDamageCause.RamAttack` | 30 |
231+
| `ActorDamageCause.SonicBoom` | 31 |
232+
| `ActorDamageCause.Campfire` | 32 |
233+
| `ActorDamageCause.SoulCampfire` | 33 |
234+
| `ActorDamageCause.MaceSmash` | 34 |
235+
| `ActorDamageCause.All` | 35 |
235236

236237
#### 治疗实体
237238

0 commit comments

Comments
 (0)