Explosion functions & Explosion types ID list

FileEX · FileEX · commit 28a23a9d098a · 2026-01-23T20:24:02.000+01:00
diff --git a/functions/Explosion/createExplosion.yaml b/functions/Explosion/createExplosion.yaml
@@ -1,82 +1,78 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CreateExplosion
-client:
+shared: &shared
   name: createExplosion
   description: Creates an explosion of a certain type at a specified point in the
     world. If creator is specified, the explosion will occur only in its dimension.
+  parameters: []
+  returns:
+    values:
+    - type: bool
+      name: result
+    description: Return **true** if the explosion was created. **false** if invalid parameters were
+      passed.
+
+client:
+  <<: *shared
   parameters:
   - name: x
     type: float
-    description: a float value that specifies the X world coordinate where the explosion
+    description: A float value that specifies the X world coordinate where the explosion
       is created at.
   - name: "y"
     type: float
-    description: a float value that specifies the Y world coordinate where the explosion
+    description: A float value that specifies the Y world coordinate where the explosion
       is created at.
   - name: z
     type: float
-    description: a float value that specifies the Z world coordinate where the explosion
+    description: A float value that specifies the Z world coordinate where the explosion
       is created at.
   - name: theType
     type: int
-    description: 'a integer specifying the explosion type, see: Explosion types'
+    description: 'An integer specifying the explosion type, see: [Explosion types](/reference/ID_Lists/Explosion_types).'
   - name: makeSound
     type: bool
-    description: a boolean specifying whether the explosion should be heard or not.
+    description: A boolean specifying whether the explosion should be heard or not.
     default: 'true'
   - name: camShake
     type: float
-    description: a float specifying the camera shake's intensity.
+    description: A float specifying the camera shake's intensity.
     default: '-1.0'
   - name: damaging
     type: bool
-    description: a boolean specifying whether the explosion should cause damage or
+    description: A boolean specifying whether the explosion should cause damage or
       not.
     default: 'true'
   examples:
-  - path: examples/createExplosion-2.lua
-    description: Example 1:This code will create an explosion for the local player
-      when they spawn.
-    side: client
-  returns:
-    values:
-    - type: bool
-      name: value
-    description: true if the explosion was created. false if invalid parameters were
-      passed.
-  requires_review: true
+    - path: examples/createExplosion-4.lua
+      description: This code will create an explosion for the local player when they spawn.
+    - path: examples/createExplosion-5.lua
+      description: This will cause an explosion that will not harm the player.
+
 server:
-  name: createExplosion
-  description: Creates an explosion of a certain type at a specified point in the
-    world. If creator is specified, the explosion will occur only in its dimension.
+  <<: *shared
   parameters:
   - name: x
     type: float
-    description: a float value that specifies the X world coordinate where the explosion
+    description: A float value that specifies the X world coordinate where the explosion
       is created at.
   - name: "y"
     type: float
-    description: a float value that specifies the Y world coordinate where the explosion
+    description: A float value that specifies the Y world coordinate where the explosion
       is created at.
   - name: z
     type: float
-    description: a float value that specifies the Z world coordinate where the explosion
+    description: A float value that specifies the Z world coordinate where the explosion
       is created at.
   - name: theType
     type: int
-    description: 'an integer specifying the explosion type, see: Explosion types'
+    description: 'An integer specifying the explosion type, see: [Explosion types](/reference/ID_Lists/Explosion_types).'
   - name: creator
     type: player
-    description: the explosion's simulated creator, the player responsible for it.
+    description: The explosion's simulated creator, the player responsible for it.
     default: nil
   examples:
   - path: examples/createExplosion-1.lua
-    description: Example 1:This code will create an explosion at the player's position
-      when they spawn.
-    side: server
-  returns:
-    values:
-    - type: bool
-      name: value
-    description: true if the explosion was created. false if invalid parameters were
-      passed.
-  requires_review: true
+    description: This code will create an explosion at the player's position when they spawn.
+  - path: examples/createExplosion-2.lua
+    description: This example allows creation of claymore mines, which trigger and explode.
+  - path: examples/createExplosion-3.lua
+    description: This will cause an explosion that will not harm the player.
diff --git a/functions/Explosion/examples/createExplosion-1.lua b/functions/Explosion/examples/createExplosion-1.lua
@@ -1,8 +1,8 @@
-function explosionOnSpawn ( )
-  -- get the spawned player's position
-  local pX, pY, pZ = getElementPosition ( source )
-  -- and create an explosion there, making him the creator
-  createExplosion ( pX, pY, pZ, 6, source )
+function explosionOnSpawn()
+    -- get the spawned player's position
+    local pX, pY, pZ = getElementPosition(source)
+    -- and create an explosion there, making him the creator
+    createExplosion(pX, pY, pZ, 6, source)
 end
 -- add this function as a handler for any player that spawns
-addEventHandler ( "onPlayerSpawn", root, explosionOnSpawn )
+addEventHandler("onPlayerSpawn", root, explosionOnSpawn)
diff --git a/functions/Explosion/examples/createExplosion-2.lua b/functions/Explosion/examples/createExplosion-2.lua
@@ -1,8 +1,23 @@
-function explosionOnSpawn ( )
-  -- get the spawned player's position
-  local pX, pY, pZ = getElementPosition ( source )
-  -- and create an explosion there
-  createExplosion ( pX, pY, pZ, 6 )
+function createClaymore(creator)
+    local x, y, z = getElementPosition(creator)
+    local claymoreObject = createObject(1945, x, y, z - 1, 0, 0, 90) -- create an object which looks like a claymore
+    local claymoreCol = createColSphere(x, y, z, 1) -- create a collision sphere with radius 1
+    setElementData(claymoreCol, "type", "claymore") -- store the type of colshape so it can be retrieved
+    setElementData(claymoreCol, "object", claymoreObject) -- store the object of the claymore
+    setElementData(claymoreCol, "creatorPlayer", creator) -- store the person who created it
 end
--- add this function as a handler for any player that spawns
-addEventHandler ( "onClientPlayerSpawn", localPlayer, explosionOnSpawn )
+
+function claymoreHit(player)
+    if getElementData(source, "type") == "claymore" then -- ensure its a claymore
+        -- retrieve the object associated to the claymore, and who created it
+        local claymoreObject = getElementData(source, "object")
+        local claymoreCreator = getElementData(source, "creatorPlayer")
+        -- get the position of the claymore
+        local x, y, z = getElementPosition(source)
+        createExplosion(x, y, z, 12, claymoreCreator) -- create an explosion, associated to the creator, of a small size at the col's position
+        -- destroy the claymore object, and the col shape so it doesnt trigger again.
+        destroyElement(claymoreObject)
+        destroyElement(source)
+    end
+end
+addEventHandler("onColShapeHit", root, claymoreHit)
diff --git a/functions/Explosion/examples/createExplosion-3.lua b/functions/Explosion/examples/createExplosion-3.lua
@@ -0,0 +1,25 @@
+function fakeBombAt(el)
+    if isElement(el) then
+        local x, y, z = getElementPosition(el)
+        triggerClientEvent("fakeBomb", root, x, y, z, 0)
+    end
+end
+
+function onPlayerSpawnEvent(spawnpoint, team)
+    fakeBombAt(source)
+end
+
+function onPlayerQuitEvent(reason)
+    fakeBombAt(source)
+end
+
+function onPlayerDiedEvent(totalAmmo, killer, killerWeapon, bodypart)
+    setTimer(fadeCamera, 2000, 1, source, false)
+    fakeBombAt(source)
+    setTimer(spawnPlayer, 4000, 1, source, 0, 0, 0)
+    setTimer(fadeCamera, 4500, 1, source, true)
+end
+
+addEventHandler("onPlayerQuit", root, onPlayerQuitEvent)
+addEventHandler("onPlayerWasted", root, onPlayerDiedEvent)
+addEventHandler("onPlayerSpawn", root, onPlayerSpawnEvent)
diff --git a/functions/Explosion/examples/createExplosion-4.lua b/functions/Explosion/examples/createExplosion-4.lua
@@ -0,0 +1,8 @@
+function explosionOnSpawn()
+    -- get the spawned player's position
+    local pX, pY, pZ = getElementPosition(source)
+    -- and create an explosion there
+    createExplosion(pX, pY, pZ, 6)
+end
+-- add this function as a handler for any player that spawns
+addEventHandler("onClientPlayerSpawn", localPlayer, explosionOnSpawn)
diff --git a/functions/Explosion/examples/createExplosion-5.lua b/functions/Explosion/examples/createExplosion-5.lua
@@ -0,0 +1,13 @@
+function fakeBomb(x, y, z, d)
+    if d then -- Check the players Dimension
+        if getElementDimension(localPlayer) == d then
+            -- If the players Dimension is the current dimension
+            -- Then people on other dimensions cant see this explosion
+            createExplosion(x, y, z, 0, true, -1.0, false)
+        end
+    else
+        createExplosion(x, y, z, 0, true, -1.0, false)
+    end
+end
+addEvent("fakeBomb", true)
+addEventHandler("fakeBomb", root, fakeBomb)
diff --git a/web/src/data/explosion_types.ts b/web/src/data/explosion_types.ts
@@ -0,0 +1,15 @@
+export const explosionTypesById: Record<number, { name: string; info?: string }> = {
+    0: { name: "Grenade", info: "When a grenade or satchel projectile explodes." },
+    1: { name: "Molotov", info: "When a molotov projectile explodes" },
+    2: { name: "Rocket", info: "When a rocket projectile explodes. When a type 7 explosion occurs (with a victim i.e. vehicle source) and a 5% chance. If plane or heli (not RC vehicle) and below 250 hp and a 1.2% chance." },
+    3: { name: "Rocket Weak", info: "If a HS rocket projectile and the launcher is not local player." },
+    4: { name: "Car", info: "When a car or bike explodes." },
+    5: { name: "Car Quick", info: "When ID 564 or 441 blows up. (RC Tiger & Bandit)" },
+    6: { name: "Boat", info: "When a boat blows up." },
+    7: { name: "Aircraft", info: "When a plane or helicopter blows up." },
+    8: { name: "Mine", info: "Related to PICKUP_NAUTICAL_MINE_ARMED." },
+    9: { name: "Object", info: "Exploding object e.g. explosive barrel, tank stations." },
+    10: { name: "Tank Grenade", info: "Rhino shooting." },
+    11: { name: "Small", info: "Most likely only used by scripts." },
+    12: { name: "Tiny", info: "When ID 464, 465 or 501 (RC Baron, RC Raider, Goblin) blows up." },
+};
diff --git a/web/src/pages/reference/ID_Lists/Explosion_types.astro b/web/src/pages/reference/ID_Lists/Explosion_types.astro
@@ -0,0 +1,53 @@
+---
+import AutoStarlightPage from "@src/components/AutoStarlightPage.astro";
+import { getSeeAlsoLinksFromList } from '@src/utils/general';
+import SeeAlsoSection from '@src/components/SeeAlsoSection.astro';
+import { Code } from '@astrojs/starlight/components';
+import { explosionTypesById } from '@src/data/explosion_types';
+
+let luaTable = `local explosionTypes = {\n`;
+Object.entries(explosionTypesById).forEach(([id, { name, info }], index) => {
+    luaTable += `\t[${id}] = "${name}"`;
+    if (info) {
+        luaTable += `, -- ${info}`;
+    }
+    luaTable += `\n`;
+});
+luaTable += `}`;
+
+---
+<AutoStarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Explosion Types',
+    tableOfContents: false,
+}}>
+    <p>The following explosion types are used by <a href="/reference/createExplosion">createExplosion</a> function.
+    
+    <table class="damage-types-table">
+        <thead>
+            <tr>
+                <th>ID</th>
+                <th>Name</th>
+                <th>Description</th>
+            </tr>
+        </thead>
+        <tbody>
+            {Object.entries(explosionTypesById).map(([id, { name, info }]) => (
+                <tr>
+                    <td>{id}</td>
+                    <td>{name}</td>
+                    <td>{info || ''}</td>
+                </tr>
+            ))}
+        </tbody>
+    </table>
+    
+    <section data-pagefind-ignore>
+        <h4>Explosion types in a Lua table:</h4>
+        <Code lang="lua" code={luaTable}/>
+    </section>
+
+    <SeeAlsoSection seeAlsoLinks={getSeeAlsoLinksFromList([
+        'reference:ID_Lists',
+    ])} currentId='' />
+</AutoStarlightPage>
diff --git a/web/src/pages/reference/ID_Lists/index.astro b/web/src/pages/reference/ID_Lists/index.astro
@@ -18,6 +18,7 @@ import SeeAlsoSection from "@src/components/SeeAlsoSection.astro";
     <li>👕 <a href="/reference/ID_Lists/CJ_Clothes">CJ Clothes</a></li>
     <li>💥 <a href="/reference/ID_Lists/Damage_Types">Damage Types</a></li>
     <li>🪄 <a href="/reference/ID_Lists/Effects">Effects</a></li>
+    <li>💣 <a href="/reference/ID_Lists/Explosion_types">Explosion Types</a></li>
     <li>🚗 <a href="/reference/ID_Lists/Garages">Garages</a></li>
     <li>🏠 <a href="/reference/ID_Lists/Interiors">Interiors</a></li>
     <li>
