NPC_GetPosMovingTo.md

Author: itsneufox

frontend/docs/scripting/functions/NPC_GetPosMovingTo.md

@@ -0,0 +1,71 @@
+---
+title: NPC_GetPosMovingTo
+sidebar_label: NPC_GetPosMovingTo
+description: Gets the position that the NPC is currently moving toward.
+tags: ["npc", "position", "movement"]
+---
+
+<VersionWarn version='omp v1.1.0.changemelater' />
+
+## Description
+
+Gets the position that the NPC is currently moving toward.
+
+| Name     | Description                                                        |
+| -------- | ------------------------------------------------------------------ |
+| npcid    | The ID of the NPC                                                  |
+| &Float:x | Variable to store the X coordinate of the target position, passed by reference |
+| &Float:y | Variable to store the Y coordinate of the target position, passed by reference |
+| &Float:z | Variable to store the Z coordinate of the target position, passed by reference |
+
+## Returns
+
+Returns `true` on success, `false` on failure.
+
+## Examples
+
+```c
+public OnPlayerCommandText(playerid, cmdtext[])
+{
+    if (!strcmp(cmdtext, "/checkposmovingto", true))
+    {
+        new npcid = PlayerNPC[playerid];
+        if (npcid == INVALID_NPC_ID)
+            return SendClientMessage(playerid, 0xFF0000FF, "You are not debugging a NPC.");
+
+        if (!NPC_IsValid(npcid))
+            return SendClientMessage(playerid, 0xFF0000FF, "Invalid NPC.");
+
+        if (!NPC_IsMoving(npcid))
+            return SendClientMessage(playerid, 0xFF0000FF, "NPC %d is not moving", npcid);
+
+        new Float:x, Float:y, Float:z;
+        NPC_GetPosMovingTo(npcid, x, y, z);
+
+        SendClientMessage(playerid, 0x00FF00FF, "NPC %d target position: %.2f, %.2f, %.2f", npcid, x, y, z);
+        return 1;
+    }
+    return 0;
+}
+```
+
+## Notes
+
+:::warning
+
+- All coordinate parameters are passed by reference and will be modified.
+- This function returns the target position the NPC is moving toward, not the current position.
+- Use [NPC_IsMoving](NPC_IsMoving) to check if the NPC is currently moving before calling this function.
+
+:::
+
+## Related Functions
+
+- [NPC_Move](NPC_Move): Makes an NPC move to a specific position.
+- [NPC_IsMoving](NPC_IsMoving): Check if NPC is moving.
+- [NPC_GetPos](NPC_GetPos): Get NPC's current position.
+- [NPC_StopMove](NPC_StopMove): Stop NPC movement.
+
+## Related Callbacks
+
+- [OnNPCFinishMove](../callbacks/OnNPCFinishMove): Called when NPC finishes movement.