NPC Component Documentation

frontend/docs/scripting/callbacks/OnClientMessage.md

@@ -5,6 +5,12 @@ description: This callback gets called whenever the NPC sees a ClientMessage.
 tags: []
 ---
 
+:::warning
+
+This callback is deprecated.
+
+:::
+
 ## Description
 
 This callback gets called whenever the NPC sees a ClientMessage. This will be everytime a [SendClientMessageToAll](../functions/SendClientMessageToAll) function is used and everytime a [SendClientMessage](../functions/SendClientMessage) function is sent towards the NPC. This callback won't be called when someone says something. For a version of this with player text, see [NPC:OnPlayerText](OnPlayerText).

frontend/docs/scripting/callbacks/OnNPCChangeNode.md

@@ -0,0 +1,65 @@
+---
+title: OnNPCChangeNode
+sidebar_label: OnNPCChangeNode
+description: This callback is called when an NPC attempts to change from one navigation node to another during node-based movement.
+tags: ["npc", "node", "navigation"]
+---
+
+<VersionWarn version='omp v1.1.0.changemelater' />
+
+## Description
+
+This callback is called when an NPC attempts to change from one navigation node to another during node-based movement. This allows you to control whether the node change should be allowed or denied.
+
+| Name      | Description                                     |
+| --------- | ----------------------------------------------- |
+| npcid     | The ID of the NPC attempting to change nodes    |
+| newnodeid | The ID of the new node the NPC wants to move to |
+| oldnodeid | The ID of the current node the NPC is on        |
+
+## Returns
+
+Return `true` to allow the node change, or `false` to deny it.
+
+## Examples
+
+```c
+public OnNPCChangeNode(npcid, newnodeid, oldnodeid)
+{
+    printf("NPC %d is changing from node %d to node %d", npcid, oldnodeid, newnodeid);
+
+    // Check if the new node is open
+    if (!NPC_IsNodeOpen(newnodeid))
+    {
+        return false; // Deny change to closed node
+    }
+
+    // Prevent NPCs from going to node 5
+    if (newnodeid == 5)
+    {
+        return false; // Block access to node 5
+    }
+
+    return true; // Allow the change
+}
+```
+
+## Notes
+
+- This callback is only called when NPCs are using node-based navigation via `NPC_PlayNode`
+- Returning `false` will prevent the NPC from changing nodes and may cause it to stop navigation
+- Node files must be loaded using `NPC_OpenNode` before NPCs can navigate between them
+
+## Related Functions
+
+The following functions might be useful, as they're related to this callback in one way or another.
+
+- [NPC_PlayNode](../functions/NPC_PlayNode): Start NPC node-based navigation
+- [NPC_OpenNode](../functions/NPC_OpenNode): Open a navigation node file
+- [NPC_CloseNode](../functions/NPC_CloseNode): Close a navigation node file
+- [NPC_StopPlayingNode](../functions/NPC_StopPlayingNode): Stop NPC node navigation
+
+## Related Callbacks
+
+- [OnNPCFinishNode](OnNPCFinishNode): Called when NPC finishes navigating a complete node
+- [OnNPCFinishNodePoint](OnNPCFinishNodePoint): Called when NPC reaches a specific point in a node

frontend/docs/scripting/callbacks/OnNPCCreate.md

@@ -0,0 +1,49 @@
+---
+title: OnNPCCreate
+sidebar_label: OnNPCCreate
+description: This callback is called when an NPC is successfully created.
+tags: ["npc"]
+---
+
+<VersionWarn version='omp v1.1.0.changemelater' />
+
+## Description
+
+This callback is called when an NPC is successfully created and added to the server.
+
+| Name  | Description                        |
+| ----- | ---------------------------------- |
+| npcid | The ID of the NPC that was created |
+
+## Examples
+
+```c
+public OnNPCCreate(npcid)
+{
+    printf("NPC %d has been created", npcid);
+
+    // Set initial properties
+    NPC_SetSkin(npcid, 23);
+    NPC_SetPos(npcid, 1958.33, 1343.12, 15.36);
+
+    return true;
+}
+```
+
+## Notes
+
+- This callback is called immediately after the NPC is created but before it's spawned
+- The NPC will need to be spawned using `NPC_Spawn` to become visible in the game world
+
+## Related Functions
+
+The following functions might be useful, as they're related to this callback in one way or another.
+
+- [NPC_Create](../functions/NPC_Create): Create a new NPC
+- [NPC_Destroy](../functions/NPC_Destroy): Destroy an existing NPC
+- [NPC_Spawn](../functions/NPC_Spawn): Spawn the NPC in the game world
+
+## Related Callbacks
+
+- [OnNPCDestroy](OnNPCDestroy): Called when an NPC is destroyed
+- [OnNPCSpawn](OnNPCSpawn): Called when an NPC is spawned

frontend/docs/scripting/callbacks/OnNPCDeath.md

@@ -0,0 +1,66 @@
+---
+title: OnNPCDeath
+sidebar_label: OnNPCDeath
+description: This callback is called when an NPC dies.
+tags: ["npc"]
+---
+
+<VersionWarn version='omp v1.1.0.changemelater' />
+
+## Description
+
+This callback is called when an NPC dies.
+
+| Name     | Description                                                                 |
+| -------- | --------------------------------------------------------------------------- |
+| npcid    | The ID of the NPC that died                                                 |
+| killerid | The ID of the player/NPC that killed the NPC (or INVALID_PLAYER_ID if none) |
+| reason   | The reason for death (weapon ID or death cause)                             |
+
+## Examples
+
+```c
+public OnNPCDeath(npcid, killerid, reason)
+{
+    if (killerid != INVALID_PLAYER_ID)
+    {
+        printf("NPC %d was killed by %d with reason %d", npcid, killerid, reason);
+    }
+    else
+    {
+        printf("NPC %d died", npcid);
+    }
+
+    // Respawn after 5 seconds
+    SetTimerEx("RespawnNPC", 5000, false, "i", npcid);
+
+    return true;
+}
+
+forward RespawnNPC(npcid);
+public RespawnNPC(npcid)
+{
+    NPC_Respawn(npcid);
+}
+```
+
+## Notes
+
+- The `killerid` parameter will be `INVALID_PLAYER_ID` if the NPC death was not player inflicted
+- The `reason` parameter contains the weapon ID that caused the death (255 for unknown/other causes)
+
+## Related Functions
+
+The following functions might be useful, as they're related to this callback in one way or another.
+
+- [NPC_Kill](../functions/NPC_Kill): Kill an NPC
+- [NPC_Respawn](../functions/NPC_Respawn): Respawn a dead NPC
+- [NPC_GetHealth](../functions/NPC_GetHealth): Get NPC's health
+- [NPC_SetHealth](../functions/NPC_SetHealth): Set NPC's health
+
+## Related Callbacks
+
+- [OnNPCSpawn](OnNPCSpawn): Called when an NPC spawns
+- [OnNPCRespawn](OnNPCRespawn): Called when an NPC respawns
+- [OnNPCTakeDamage](OnNPCTakeDamage): Called when an NPC takes damage
+- [OnPlayerDeath](OnPlayerDeath): Called when a player dies

frontend/docs/scripting/callbacks/OnNPCDestroy.md

@@ -0,0 +1,51 @@
+---
+title: OnNPCDestroy
+sidebar_label: OnNPCDestroy
+description: This callback is called when an NPC is destroyed.
+tags: ["npc"]
+---
+
+<VersionWarn version='omp v1.1.0.changemelater' />
+
+## Description
+
+This callback is called when an NPC is destroyed and removed from the server.
+
+| Name  | Description                          |
+| ----- | ------------------------------------ |
+| npcid | The ID of the NPC that was destroyed |
+
+## Examples
+
+```c
+public OnNPCDestroy(npcid)
+{
+    printf("NPC %d has been destroyed", npcid);
+
+    // Clean up timers
+    if (g_NPCTimer[npcid] != -1)
+    {
+        KillTimer(g_NPCTimer[npcid]);
+        g_NPCTimer[npcid] = -1;
+    }
+
+    return true;
+}
+```
+
+## Notes
+
+- This callback is called immediately before the NPC is removed from the server
+- The NPC will be disconnected and its player slot freed after this callback
+
+## Related Functions
+
+The following functions might be useful, as they're related to this callback in one way or another.
+
+- [NPC_Create](../functions/NPC_Create): Create a new NPC
+- [NPC_Destroy](../functions/NPC_Destroy): Destroy an existing NPC
+- [NPC_IsValid](../functions/NPC_IsValid): Check if NPC ID is valid
+
+## Related Callbacks
+
+- [OnNPCCreate](OnNPCCreate): Called when an NPC is created