ID Lists: add Damage Types and Garages

Author: Fernando-A-Rocha

web/src/pages/reference/ID_Lists/Bone_IDs.astro

@@ -0,0 +1,117 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+
+import { getSeeAlsoLinksFromList } from '@src/utils/general';
+import SeeAlsoSection from '@src/components/SeeAlsoSection.astro';
+
+import { Code } from '@astrojs/starlight/components';
+
+import { Image } from 'astro:assets';
+import { getAssetImagePath } from '@src/utils/general';
+
+const boneMap: { [id: number]: string } = {
+  0: "BONE_ROOT",
+  1: "BONE_PELVIS1",
+  2: "BONE_PELVIS",
+  3: "BONE_SPINE1",
+  4: "BONE_UPPERTORSO",
+  5: "BONE_NECK",
+  6: "BONE_HEAD2",
+  7: "BONE_HEAD1",
+  8: "BONE_HEAD",
+  21: "BONE_RIGHTUPPERTORSO",
+  22: "BONE_RIGHTSHOULDER",
+  23: "BONE_RIGHTELBOW",
+  24: "BONE_RIGHTWRIST",
+  25: "BONE_RIGHTHAND",
+  26: "BONE_RIGHTTHUMB",
+  31: "BONE_LEFTUPPERTORSO",
+  32: "BONE_LEFTSHOULDER",
+  33: "BONE_LEFTELBOW",
+  34: "BONE_LEFTWRIST",
+  35: "BONE_LEFTHAND",
+  36: "BONE_LEFTTHUMB",
+  41: "BONE_LEFTHIP",
+  42: "BONE_LEFTKNEE",
+  43: "BONE_LEFTANKLE",
+  44: "BONE_LEFTFOOT",
+  51: "BONE_RIGHTHIP",
+  52: "BONE_RIGHTKNEE",
+  53: "BONE_RIGHTANKLE",
+  54: "BONE_RIGHTFOOT",
+  201: "BONE_BELLY",
+  301: "BONE_RIGHTBREAST",
+  302: "BONE_LEFTBREAST",
+};
+
+let luaTable = `local boneIDs = {\n`;
+Object.entries(boneMap).forEach(([id], index) => {
+    luaTable += `${id}`;
+    if ((index + 1) % 8 === 0) {
+        luaTable += `\n`;
+    } else {
+        luaTable += `, `;
+    }
+});
+luaTable += `}`;
+
+let luaTableNames = `local boneNames = {\n`;
+Object.entries(boneMap).forEach(([id, name]) => {
+    luaTableNames += `[${id}] = "${name}",\n`;
+});
+luaTableNames += `}`;
+
+
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Bone IDs',
+    tableOfContents: false,
+}}>
+    <p>List of all ped <strong>Bone IDs</strong> that can be used with functions such as <a href="/reference/getElementBonePosition">getElementBonePosition</a>.</p>
+
+    <div class="bonesbox">
+        <ul>
+            {Object.entries(boneMap).map(([id, name]) => (
+                <li>
+                    <strong>{id}</strong> - <code>{name}</code>
+                </li>
+            ))}
+        </ul>
+
+        <Image class="bonesimage" src={getAssetImagePath("Bones/bone_ids.webp")} alt="Labeled Bone IDs" width="150"/>
+    </div>
+
+    <h4>Lua tables of these Bone IDs:</h4>
+
+    <Code lang="lua" code={luaTable}/>
+    <Code lang="lua" code={luaTableNames}/>
+
+    <SeeAlsoSection seeAlsoLinks={getSeeAlsoLinksFromList([
+        'reference:ID_Lists',
+    ])} currentId='' />
+</StarlightPage>
+
+<style>
+    .bonesbox {
+        margin-top: 2rem;
+        display: flex;
+        align-items: flex-start;
+        flex-direction: row;
+        gap: 2rem;
+    }
+    .bonesimage {
+        max-width: 100%;
+        height: auto;
+        object-fit: contain;
+    }
+
+    .bonesbox ul {
+        list-style-type: none;
+        padding: 0;
+    }
+
+    .bonesbox li {
+        margin-bottom: 0.5rem;
+    }
+</style>

web/src/pages/reference/ID_Lists/Bones.astro

@@ -0,0 +1,70 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+
+import { getSeeAlsoLinksFromList } from '@src/utils/general';
+import SeeAlsoSection from '@src/components/SeeAlsoSection.astro';
+
+import { Code } from '@astrojs/starlight/components';
+
+const damageTypesById: Record<number, { type: string; info?: string }> = {
+  19: { type: "Rocket", info: "Actual damage type when damaged from a rocket launcher" },
+  37: { type: "Burnt", info: "This is used by a damage by fire, even when the fire is created by a rocket explosion or a molotov" },
+  49: { type: "Rammed" },
+  50: { type: "Ranover", info: "This is also called when damaged because of helicopter blades" },
+  51: { type: "Explosion", info: "This may sometimes also be used at an indirect damage through an exploding rocket" },
+  52: { type: "Driveby", info: "This is NOT used for a driveby kill with e.g. the 'realdriveby' resource" },
+  53: { type: "Drowned" },
+  54: { type: "Fall" },
+  55: { type: "Unknown", info: "No known information about this damage type" },
+  56: { type: "Melee", info: "Seems to be never called (?); for an actual melee damage, the fist weapon ID (0) is used" },
+  57: { type: "Weapon", info: "Seems to be never called (?)" },
+  59: { type: "Tank Grenade" },
+  63: { type: "Blown", info: "Actual damage type when dying in a vehicle explosion" }
+};
+
+
+let luaTable = `local damageTypes = {\n`;
+Object.entries(damageTypesById).forEach(([id, { type, info }], index) => {
+    luaTable += `\t[${id}] = "${type}"`;
+    if (info) {
+        luaTable += `, -- ${info}`;
+    }
+    luaTable += `\n`;
+});
+luaTable += `}`;
+
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Damage Types',
+    tableOfContents: false,
+}}>
+    <p>The following damage types are used by events like <a href="/reference/onPlayerDamage">onPlayerDamage</a> or <a href="/reference/onPlayerWasted">onPlayerWasted</a> for the weapon argument to describe the reason, why a ped has been damaged or died.</p>
+    
+    <p>When a player was shot by a weapon, the respective weapon ID is the damage type ID. The weapon IDs can be found <a href="/reference/ID_Lists/Weapons">here</a>.</p>
+    <table>
+        <thead>
+            <tr>
+                <th>ID</th>
+                <th>Damage Type</th>
+                <th>Additional Info</th>
+            </tr>
+        </thead>
+        <tbody>
+            {Object.entries(damageTypesById).map(([id, { type, info }]) => (
+                <tr>
+                    <td>{id}</td>
+                    <td>{type}</td>
+                    <td>{info || ''}</td>
+                </tr>
+            ))}
+        </tbody>
+    </table>
+    <h4>Damage types in a Lua table: :</h4>
+
+    <Code lang="lua" code={luaTable}/>
+
+    <SeeAlsoSection seeAlsoLinks={getSeeAlsoLinksFromList([
+        'reference:ID_Lists',
+    ])} currentId='' />
+</StarlightPage>