VoxeLibre/mods/CORE/mcl_explosions/API.md
Mikita Wiśniewski 19d662dee4 Fix some typos in the API documentation (#4630)
Reviewed-on: https://git.minetest.land/VoxeLibre/VoxeLibre/pulls/4630
Reviewed-by: teknomunk <teknomunk@protonmail.com>
Co-authored-by: Mikita Wiśniewski <rudzik8@protonmail.com>
Co-committed-by: Mikita Wiśniewski <rudzik8@protonmail.com>
2024-09-12 18:13:52 +02:00

1.0 KiB

mcl_explosions

This mod provide helper functions to create explosions.

mcl_explosions.explode(pos, strength, info, puncher)

  • pos: position, initial position of the explosion
  • strength: number, radius of the explosion
  • info: table, explosion informations:
    • drop_chance: number, if specified becomes the drop chance of all nodes in the explosion (default: 1.0 / strength)
    • max_blast_resistance: int, if specified the explosion will treat all non-indestructible nodes as having a blast resistance of no more than this value
    • sound: bool, if true, the explosion will play a sound (default: true)
    • particles: bool, if true, the explosion will create particles (default: true)
    • fire: bool, if true, 1/3 of nodes become fire (default: false)
    • griefing: bool, if true, the explosion will destroy nodes (default: true)
    • grief_protected: bool, if true, the explosion will also destroy nodes which have been protected (default: false)
  • puncher: (optional) entity, will be used as source for damage done by the explosion