Skip to main content

NPC_GetSurfingPlayerObject

warning

This function was added in omp v1.5.8.3079 and will not work in earlier versions!

Description​

Gets the player object an NPC is surfing on.

NameDescription
npcidThe ID of the NPC

Returns​

Returns the player object ID, or INVALID_OBJECT_ID if not surfing on a player object.

Examples​

public OnPlayerCommandText(playerid, cmdtext[])
{
    if (!strcmp(cmdtext, "/checksurfingplayerobject", 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.");

        new objectid = NPC_GetSurfingPlayerObject(npcid);

        if (objectid == INVALID_OBJECT_ID)
            SendClientMessage(playerid, 0xFFFF00FF, "NPC %d is not surfing on any player object.", npcid);
        else
            SendClientMessage(playerid, 0x00FF00FF, "NPC %d is surfing on player object: %d", npcid, objectid);
        return 1;
    }
    return 0;
}

Notes​

  • Returns INVALID_OBJECT_ID if the NPC is not surfing on any player object
  • This function only checks for player-specific objects, not global objects

No specific callbacks are triggered by this function.