open.mp

https://open.mp/docs
Admin
open.mp is an open-source multiplayer modification platform, providing documentation for SA-MP and...
Tokens:1,146,021
Snippets:10,116
Trust Score:9.1
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### OnGameModeInit example: print gamemode started

Source: https://open.mp/docs/scripting/callbacks/OnGameModeInit

Example implementation of the OnGameModeInit callback that prints 'Gamemode started!' and returns 1. This callback is triggered when the gamemode starts.

```pawn
public OnGameModeInit()  

{  

    print("Gamemode started!");  

    return 1;  

}  

```

--------------------------------

### StartRecordingPlayerData command example

Source: https://open.mp/docs/scripting/functions/StartRecordingPlayerData

Example command handler that starts recording a player's movements based on their current state (on foot or driving). It calls StartRecordingPlayerData with the appropriate recording type and file name "MyFile", then sends a confirmation message.

```pawn
if (!strcmp("/recordme", cmdtext))  

{  

    if (GetPlayerState(playerid) == PLAYER_STATE_ONFOOT)  

    {  

        StartRecordingPlayerData(playerid, PLAYER_RECORDING_TYPE_ONFOOT, "MyFile");  

    }  

    else if (GetPlayerState(playerid) == PLAYER_STATE_DRIVER)  

    {  

        StartRecordingPlayerData(playerid, PLAYER_RECORDING_TYPE_DRIVER, "MyFile");  

    }  

    SendClientMessage(playerid, 0xFFFFFFFF, "All your movements are now being recorded!");  

    return 1;  

}  
```

--------------------------------

### Start NPC playback with extended options

Source: https://open.mp/docs/scripting/functions/NPC_StartPlaybackEx

Handles the /startplaybackex command to start NPC playback with extended options. Requires a pre-loaded recording ID and a valid NPC; uses NPC_GetPos to get the NPC's position as the start offset. Sends success or failure messages based on the return value of NPC_StartPlaybackEx.

```pawn
public OnPlayerCommandText(playerid, cmdtext[])

{

    if (!strcmp(cmdtext, "/startplaybackex ", true, 17))

    {

        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 recordId = strval(cmdtext[17]);



        new Float:x, Float:y, Float:z;

        NPC_GetPos(npcid, x, y, z);



        new bool:success = NPC_StartPlaybackEx(npcid, recordId, true, x, y, z, 0.0, 0.0, 0.0);



        if (success)

            SendClientMessage(playerid, 0x00FF00FF, "NPC %d started playback with record ID: %d", npcid, recordId);

        else

            SendClientMessage(playerid, 0xFF0000FF, "Failed to start playback for NPC %d with record ID %d", npcid, recordId);



        return 1;

    }

    return 0;

}
```

--------------------------------

### Pawn example: Get memory handle with DB_GetMemHandle

Source: https://open.mp/docs/scripting/functions/DB_GetMemHandle

Shows how to open a database with DB_Open, print the memory handle using DB_GetMemHandle, and close the connection with DB_Close. The example is written in Pawn for SA-MP/Open.MP. It includes error handling for a failed connection and cleanup in OnGameModeExit.

```pawn
static DB:gDBConnectionHandle;  

// ...  

public OnGameModeInit()  
{  
    // ...  

    // Create a connection to a database  
    gDBConnectionHandle = DB_Open("example.db");  

    // If connection to the database exists  
    if (gDBConnectionHandle)  
    {  
        // Successfully created a connection to the database  
        print("Successfully created a connection to database \"example.db\".");  
        printf("Database connection memory handle: 0x%x", DB_GetMemHandle(gDBConnectionHandle));  
    }  
    else  
    {  
        // Failed to create a connection to the database  
        print("Failed to open a connection to database \"example.db\".");  
    }  

    // ...  

    return 1;  
}  

public OnGameModeExit()  
{  
    // Close the connection to the database if connection is open  
    if (DB_Close(gDBConnectionHandle))  
    {  
        // Extra cleanup  
        gDBConnectionHandle = DB:0;  
    }  

    // ...  

    return 1;  
}  
```

--------------------------------

### Example: Creating and handling a selectable player-textdraw

Source: https://open.mp/docs/scripting/callbacks/OnPlayerClickPlayerTextDraw

This example creates a player-textdraw, makes it selectable, and handles the click event. It uses OnPlayerConnect to create the textdraw, OnPlayerKeyStateChange to start selection mode, and OnPlayerClickPlayerTextDraw to respond to clicks. Note that pressing ESC cancels selection and triggers OnPlayerClickTextDraw instead.

```pawn
new PlayerText:gPlayerTextDraw[MAX_PLAYERS];  

  

public OnPlayerConnect(playerid)  

{  

    // Create the textdraw  

    gPlayerTextDraw[playerid] = CreatePlayerTextDraw(playerid, 10.000000, 141.000000, "MyTextDraw");  

    PlayerTextDrawTextSize(playerid, gPlayerTextDraw[playerid], 60.000000, 20.000000);  

    PlayerTextDrawAlignment(playerid, gPlayerTextDraw[playerid], TEXT_DRAW_ALIGN_LEFT);  

    PlayerTextDrawBackgroundColor(playerid, gPlayerTextDraw[playerid], 0x000000FF);  

    PlayerTextDrawFont(playerid, gPlayerTextDraw[playerid], TEXT_DRAW_FONT_1);  

    PlayerTextDrawLetterSize(playerid, gPlayerTextDraw[playerid], 0.250000, 1.000000);  

    PlayerTextDrawColor(playerid, gPlayerTextDraw[playerid], -1);  

    PlayerTextDrawSetProportional(playerid, gPlayerTextDraw[playerid], true);  

    PlayerTextDrawSetShadow(playerid, gPlayerTextDraw[playerid], 1);  

  

    // Make it selectable  

    PlayerTextDrawSetSelectable(playerid, gPlayerTextDraw[playerid], true);  

  

    // Show it to the player  

    PlayerTextDrawShow(playerid, gPlayerTextDraw[playerid]);  

    return 1;  

}  

  

public OnPlayerKeyStateChange(playerid, KEY:newkeys, KEY:oldkeys)  

{  

    if (newkeys == KEY_SUBMISSION)  

    {  

        SelectTextDraw(playerid, 0xFF4040AA);  

    }  

    return 1;  

}  

  

public OnPlayerClickPlayerTextDraw(playerid, PlayerText:playertextid)  

{  

    if (playertextid == gPlayerTextDraw[playerid])  

    {  

        SendClientMessage(playerid, 0xFFFFFFAA, "You clicked on a player-textdraw.");  

        CancelSelectTextDraw(playerid);  

        return 1;  

    }  

    return 0;  

}
```

--------------------------------

### StartRecordingPlayback example in OnNPCEnterVehicle

Source: https://open.mp/docs/scripting/functions/StartRecordingPlayback

Called when the NPC enters a vehicle. Starts playback of the recording file 'at400_lv_to_sf_x1' with the driver playback type. The recording file must be saved in the npcmodes/recordings folder.

```pawn
public OnNPCEnterVehicle(vehicleid, seatid)  

{  

    StartRecordingPlayback(PLAYER_RECORDING_TYPE_DRIVER, "at400_lv_to_sf_x1");  

}  

```

--------------------------------

### BeginObjectEditing example with /oedit command

Source: https://open.mp/docs/scripting/functions/BeginObjectEditing

Creates an object in OnGameModeInit and starts editing it when the player types /oedit. The command sends a confirmation message after calling BeginObjectEditing. Requires omp v1.1.0.2612 or later.

```pawn
new objectid;  

  

public OnGameModeInit()  

{  

    objectid = CreateObject(1337, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);  

    return 1;  

}  

  

public OnPlayerCommandText(playerid, cmdtext[])  

{  

    if (!strcmp(cmdtext, "/oedit", true))  

    {  

        BeginObjectEditing(playerid, objectid);  

        SendClientMessage(playerid, 0xFFFFFFFF, "SERVER: You can now edit the object!");  

        return 1;  

    }  

    return 0;  

}  
```

--------------------------------

### BeginPlayerObjectEditing example with /edit command

Source: https://open.mp/docs/scripting/functions/BeginPlayerObjectEditing

Creates a player object on spawn and starts editing it when the player types /edit. Requires omp v1.1.0.2612 or later; the function returns false if the player or object is invalid.

```pawn
new gPlayerObject[MAX_PLAYERS];

public OnPlayerSpawn(playerid)
{
    gPlayerObject[playerid] = CreatePlayerObject(playerid, 1337, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
}

public OnPlayerCommandText(playerid, cmdtext[])
{
    if (!strcmp(cmdtext, "/edit", true))
    {
        BeginPlayerObjectEditing(playerid, gPlayerObject[playerid]);
        SendClientMessage(playerid, 0xFFFFFFFF, "SERVER: You now edit your object!");
        return 1;
    }
    return 0;
}
```

--------------------------------

### Database connection setup in mode.pwn

Source: https://open.mp/docs/scripting/functions/DB_GetFieldStringByName

Shows how to open a database connection, call the Examples_ListNames function, and close the connection on game mode exit. It includes error handling for failed connection and cleanup of the connection handle.

```pawn
// mode.pwn

// ...

#include <examples>

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
    // ...

    // Create a connection to a database
    gDBConnectionHandle = DB_Open("example.db");

    // If connection to the database exists
    if (gDBConnectionHandle)
    {
        // Successfully created a connection to the database
        print("Successfully created a connection to database \"example.db\".");
        Examples_ListNames(gDBConnectionHandle);
    }
    else
    {
        // Failed to create a connection to the database
        print("Failed to open a connection to database \"example.db\".");
    }

    // ...

    return 1;
}

public OnGameModeExit()
{
    // Close the connection to the database if connection is open
    if (DB_Close(gDBConnectionHandle))
    {
        // Extra cleanup
        gDBConnectionHandle = DB:0;
    }

    // ...

    return 1;
}
```

--------------------------------

### Get function ID with funcidx

Source: https://open.mp/docs/scripting/functions/funcidx

Example usage of funcidx in a public OnFilterScriptInit callback. It prints the ID of the function 'OnFilterScriptInit' using printf. The function returns the ID starting at 0, or -1 if the function does not exist.

```pawn
public OnFilterScriptInit()  

{  

    printf("ID of OnFilterScriptInit: %d", funcidx("OnFilterScriptInit"));  

    return 1;  

}  

```

--------------------------------

### Open database and call Examples_ListNames in mode.pwn

Source: https://open.mp/docs/scripting/functions/db_get_field_assoc

Shows a complete gamemode setup that opens an SQLite database with db_open, calls Examples_ListNames if the connection is valid, and closes the connection in OnGameModeExit. Includes error handling for failed connection and cleanup of the database handle.

```pawn
// mode.pwn

  

// ...

  

#include <examples>

  

static DB:gDBConnectionHandle;  

  

// ...

  

public OnGameModeInit()  

{  

    // ...

  

    // Create a connection to a database  

    gDBConnectionHandle = db_open("example.db");  

  

    // If connection to the database exists  

    if (gDBConnectionHandle)  

    {  

        // Successfully created a connection to the database  

        print("Successfully created a connection to database \"example.db\".");  

        Examples_ListNames(gDBConnectionHandle);  

    }  

    else  

    {  

        // Failed to create a connection to the database  

        print("Failed to open a connection to database \"example.db\".");  

    }  

  

    // ...

  

    return 1;  

}  

  

public OnGameModeExit()  

{  

    // Close the connection to the database if connection is open  

    if (db_close(gDBConnectionHandle))  

    {  

        // Extra cleanup  

        gDBConnectionHandle = DB:0;  

    }  

  

    // ...

  

    return 1;  

}  
```

--------------------------------

### Example: Using Examples_CalculateSum in a game mode

Source: https://open.mp/docs/scripting/functions/DB_GetFieldIntByName

This example shows how to use the Examples_CalculateSum function within a game mode. It opens a database connection, calls the function, prints the result, and handles cleanup on game mode exit. It also demonstrates error handling for a failed connection.

```pawn
// mode.pwn

// ...

#include <examples>

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
    // ...

    // Create a connection to a database
    gDBConnectionHandle = DB_Open("example.db");

    // If connection to the database exists
    if (gDBConnectionHandle)
    {
        // Successfully created a connection to the database
        print("Successfully created a connection to database \"example.db\".");
        printf("Calculated sum: %d", Examples_CalculateSum(gDBConnectionHandle));
    }
    else
    {
        // Failed to create a connection to the database
        print("Failed to open a connection to database \"example.db\".");
    }

    // ...

    return 1;
}

public OnGameModeExit()
{
    // Close the connection to the database if connection is open
    if (DB_Close(gDBConnectionHandle))
    {
        // Extra cleanup
        gDBConnectionHandle = DB:0;
    }

    // ...

    return 1;
}
```

--------------------------------

### HTTP GET request example with callback

Source: https://open.mp/docs/scripting/functions/HTTP

Example of sending an HTTP GET request using the HTTP function and handling the response in a callback. The callback checks the response code and sends a client message with the data or an error message.

```pawn
forward MyHttpResponse(index, response_code, data[]);  

  

public OnPlayerCommandText(playerid, cmdtext[])  

{  

    if (!strcmp("/hello", cmdtext, true))  

    {  

        HTTP(playerid, HTTP_GET, "assets.open.mp/hello.txt", "", "MyHttpResponse");  

        return 1;  

    }  

    return 0;  

}  

  

public MyHttpResponse(index, response_code, data[])  

{  

    // In this callback "index" would normally be called "playerid" ( if you didn't get it already )  

    new buffer[128];  

  

    if (response_code == 200) // Did the request succeed?  

    {  

        // Yes!  

        format(buffer, sizeof(buffer), "The URL replied: %s", data);  

        SendClientMessage(index, 0xFFFFFFFF, buffer);  

    }  

    else  

    {  

        // No!  

        format(buffer, sizeof(buffer), "The request failed! The response code was: %d", response_code);  

        SendClientMessage(index, 0xFF0000FF, buffer);  

    }  

}  
```

--------------------------------

### GetPlayerSpectateID example

Source: https://open.mp/docs/scripting/functions/GetPlayerSpectateID

Example usage of GetPlayerSpectateID to get the spectated vehicle or player ID based on the spectate type. The example first calls GetPlayerSpectateType to determine the type, then calls GetPlayerSpectateID accordingly.

```pawn
new spectateType = GetPlayerSpectateType(playerid);  

if (spectateType == 1)  
{  
    new spectateVehicleId = GetPlayerSpectateID(playerid);  
}  
else if (spectateType == 2)  
{  
    new spectatePlayerId = GetPlayerSpectateID(playerid);  
}  

```

--------------------------------

### ShowMenuForPlayer example with menu creation and command

Source: https://open.mp/docs/scripting/functions/ShowMenuForPlayer

Example showing how to create a menu in OnGameModeInit and display it to a player via the /menu command. Note: passing an invalid menu ID crashes both server and player (fixed in open.mp).

```pawn
new Menu:exampleMenu;  

  

public OnGameModeInit()  

{  

    exampleMenu = CreateMenu("Example Menu", 2, 200.0, 100.0, 150.0, 150.0);  

    return 1;  

}  

  

public OnPlayerCommandText(playerid, cmdtext[])  

{  

    if (strcmp(cmdtext, "/menu", true) == 0)  

    {  

        ShowMenuForPlayer(exampleMenu, playerid);  

        return 1;  

    }  

    return 0;  

}  
```

--------------------------------

### Open database and call Examples_ListNames in OnGameModeInit

Source: https://open.mp/docs/scripting/functions/db_num_rows

Shows a complete game mode that opens an SQLite database with `db_open`, calls `Examples_ListNames` from the included `examples.inc`, and closes the connection with `db_close` on exit. The `#include <examples>` directive makes the function available.

```pawn
// mode.pwn

// ...

#include <examples>

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
    // ...

    // Create a connection to a database
    gDBConnectionHandle = db_open("example.db");

    // If connection to the database exists
    if (gDBConnectionHandle)
    {
        // Successfully created a connection to the database
        print("Successfully created a connection to database \"example.db\".");
        Examples_ListNames(gDBConnectionHandle);
    }
    else
    {
        // Failed to create a connection to the database
        print("Failed to open a connection to database \"example.db\".");
    }

    // ...

    return 1;
}

public OnGameModeExit()
{
    // Close the connection to the database if connection is open
    if (db_close(gDBConnectionHandle))
    {
        // Extra cleanup
        gDBConnectionHandle = DB:0;
    }

    // ...

    return 1;
}
```

--------------------------------

### Example: Get NPC weapon shoot time in OnPlayerCommandText

Source: https://open.mp/docs/scripting/functions/NPC_GetWeaponShootTime

Use this example to retrieve and display the shoot time of an NPC's current weapon when a player types /checkweaponshoottime. It validates the NPC ID, gets the weapon, and sends a formatted message with the shoot time in milliseconds.

```pawn
public OnPlayerCommandText(playerid, cmdtext[])  

{  

    if (!strcmp(cmdtext, "/checkweaponshoottime", 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 weapon = NPC_GetWeapon(npcid);  

        new shoottime = NPC_GetWeaponShootTime(npcid, WEAPON:weapon);  

  

        SendClientMessage(playerid, 0x00FF00FF, "NPC %d weapon %d shoot time: %d ms", npcid, weapon, shoottime);  

        return 1;  

    }  

    return 0;  

}  
```

--------------------------------

### OnGameModeInit and OnGameModeExit using db_open and Examples_CalculateSum

Source: https://open.mp/docs/scripting/functions/db_get_field_float

Shows how to open a database connection in OnGameModeInit, call Examples_CalculateSum, and close the connection in OnGameModeExit. It includes error handling for failed connection and prints the calculated sum. The connection handle is stored in a global variable.

```pawn
// mode.pwn  

  

// ...  

  

#include <examples>  

  

static DB:gDBConnectionHandle;  

  

// ...  

  

public OnGameModeInit()  

{  

    // ...  

  

    // Create a connection to a database  

    gDBConnectionHandle = db_open("example.db");  

  

    // If connection to the database exists  

    if (gDBConnectionHandle)  

    {  

        // Successfully created a connection to the database  

        print("Successfully created a connection to database \"example.db\".");  

        printf("Calculated sum: %f", Examples_CalculateSum(gDBConnectionHandle));  

    }  

    else  

    {  

        // Failed to create a connection to the database  

        print("Failed to open a connection to database \"example.db\".");  

    }  

  

    // ...  

  

    return 1;  

}  

  

public OnGameModeExit()  

{  

    // Close the connection to the database if connection is open  

    if (db_close(gDBConnectionHandle))  

    {  

        // Extra cleanup  

        gDBConnectionHandle = DB:0;  

    }  

  

    // ...  

  

    return 1;  

}  

```

--------------------------------

### Start race recording tick

Source: https://open.mp/docs/tutorials/cooldowns

Records the current tick count when the player starts the race. For example, if the server has been running for 1 minute, the value will be 60,000 milliseconds.

```pawn
StartPlayerRace(playerid)  
{  
    Stopwatch[playerid] = GetTickCount();  
}  
```

--------------------------------

### GetObjectMovingTargetRot example

Source: https://open.mp/docs/scripting/functions/GetObjectMovingTargetRot

Creates an object, starts moving it, then retrieves the target rotation coordinates using GetObjectMovingTargetRot. The example shows the expected values for rotationX, rotationY, and rotationZ after the call.

```pawn
new objectid = CreateObject(968, 1023.79541, -943.75879, 42.31450,   0.00000, 0.00000, 10.00000);  

MoveObject(objectid, 1023.79541, -943.75879, 42.31450,  0.8,   0.00000, -90.00000, 10.00000);  

  

new  

    Float:rotationX,  

    Float:rotationY,  

    Float:rotationZ;  

  

GetObjectMovingTargetRot(objectid, rotationX, rotationY, rotationZ);  

// rotationX = 0.00000  

// rotationY = -90.00000  

// rotationZ = 10.00000  
```

--------------------------------

### Game mode example using DB_Open and Examples_CalculateSum

Source: https://open.mp/docs/scripting/functions/DB_GetFieldCount

Shows a Pawn game mode snippet that includes the examples.inc file, opens a database connection with DB_Open, calls Examples_CalculateSum, and closes the connection with DB_Close. This demonstrates how to integrate the DB_GetFieldCount example into a game mode.

```Pawn
// mode.pwn

// ...

#include <examples>

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
    // ...

    // Create a connection to a database
    gDBConnectionHandle = DB_Open("example.db");

    // If connection to the database exists
    if (gDBConnectionHandle)
    {
        // Successfully created a connection to the database
        print("Successfully created a connection to database \"example.db\".");
        printf("Calculated sum: %f", Examples_CalculateSum(gDBConnectionHandle));
    }
    else
    {
        // Failed to create a connection to the database
        print("Failed to open a connection to database \"example.db\".");
    }

    // ...

    return 1;
}

public OnGameModeExit()
{
    // Close the connection to the database if connection is open
    if (DB_Close(gDBConnectionHandle))
    {
        // Extra cleanup
        gDBConnectionHandle = DB:0;
    }

    // ...

    return 1;
}
```

--------------------------------

### GetVehicleRespawnDelay usage in OnGameModeInit

Source: https://open.mp/docs/scripting/functions/GetVehicleRespawnDelay

Example showing how to get the respawn delay of a vehicle after creating it. The function returns the delay value, which is 60 in this example. Requires open.mp v1.1.0.2612 or later.

```pawn
public OnGameModeInit()  

{  

    new vehicleid = CreateVehicle(560, 2096.1917, -1328.5150, 25.1059, 0.0000, 1, 8, 60);  

  

    new respawnDelay = GetVehicleRespawnDelay(vehicleid);  

    // respawnDelay = 60  

    return 1;  

}  

```

--------------------------------

### Example: Getting player-textdraw colour

Source: https://open.mp/docs/scripting/functions/PlayerTextDrawGetColour

This example creates a player-textdraw, sets its colour to red, shows it, and then retrieves the colour using PlayerTextDrawGetColour. The retrieved colour is stored in a variable and commented as 0xFF0000FF.

```pawn
new PlayerText:pTextdraw[MAX_PLAYERS];  

public OnPlayerConnect(playerid)  
{  
    pTextdraw[playerid] = CreatePlayerTextDraw(playerid, 320.0, 240.0, "Example Text");  
    PlayerTextDrawColour(playerid, pTextdraw[playerid], 0xFF0000FF);  
    PlayerTextDrawShow(playerid, pTextdraw[playerid]);  

    new colour = PlayerTextDrawGetColour(playerid, pTextdraw[playerid]);  
    // colour = 0xFF0000FF  
    return 1;  
}
```

--------------------------------

### ShowPickupForPlayer example

Source: https://open.mp/docs/scripting/functions/ShowPickupForPlayer

Creates a pickup in OnGameModeInit and shows it to a player when they spawn. Requires open.mp v1.1.0.2612 or later.

```pawn
new g_Pickup;  

  
public OnGameModeInit()  
{  
    g_Pickup = CreatePickup(1239, 1, 1686.6160, 1455.4277, 10.7705, -1);  
    return 1;  
}  

  
public OnPlayerSpawn(playerid)  
{  
    ShowPickupForPlayer(playerid, g_Pickup);  
    return 1;  
}  

```

--------------------------------

### Example: Get NPC fighting style on command

Source: https://open.mp/docs/scripting/functions/NPC_GetFightingStyle

Example command handler that checks if the player is debugging a valid NPC and then retrieves and displays its fighting style. Requires omp v1.5.8.3079 or later.

```pawn
public OnPlayerCommandText(playerid, cmdtext[])  

{  

    if (!strcmp(cmdtext, "/checkfightingstyle", 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 style = NPC_GetFightingStyle(npcid);  

  

        SendClientMessage(playerid, 0x00FF00FF, "NPC %d fighting style: %d", npcid, style);  

        return 1;  

    }  

    return 0;  

}  
```

--------------------------------

### DestroyVehicle example in OnPlayerCommandText

Source: https://open.mp/docs/scripting/functions/DestroyVehicle

Example command '/destroyveh' that destroys the vehicle the player is currently in. Uses IsPlayerInAnyVehicle to check if the player is in a vehicle, then gets the vehicle ID with GetPlayerVehicleID and calls DestroyVehicle. Returns 1 to indicate the command was handled.

```pawn
public OnPlayerCommandText(playerid, cmdtext[])  
{  
     if (strcmp(cmdtext, "/destroyveh", true) == 0)  
     {  
          if (IsPlayerInAnyVehicle(playerid))  
          {  
               new vehicleid = GetPlayerVehicleID(playerid);  
               DestroyVehicle(vehicleid);  
          }  
          return 1;  
     }  
     return 0;  
}  

```

--------------------------------

### CreateActor Example

Source: https://open.mp/docs/scripting/functions/CreateActor

Demonstrates creating an actor at a specific coordinate during game mode initialization and destroying it upon exit.

```pawn
new gActorCJ;  

  

public OnGameModeInit()  

{  

    // Create an actor (CJ) at Blueberry Acres (Center of SA map)  

    gActorCJ = CreateActor(0, 0.0, 0.0, 3.0, 0.0);  

}  

  

public OnGameModeExit()  

{  

    // Destroy our lovely actor (CJ)  

    DestroyActor(gActorCJ);  

}  
```

--------------------------------

### CreateMenu example in OnGameModeInit

Source: https://open.mp/docs/scripting/functions/CreateMenu

Creates a menu with title "Example Menu", 2 columns, position (200.0, 100.0), and column widths 150.0 and 150.0. Returns the menu ID or -1 on failure. Must be shown with ShowMenuForPlayer.

```pawn
new Menu:exampleMenu;  

  

public OnGameModeInit()  

{  

    exampleMenu = CreateMenu("Example Menu", 2, 200.0, 100.0, 150.0, 150.0);  

    return 1;  

}  

```

--------------------------------

### Double list example with start, end, value, next, last arrays

Source: https://open.mp/docs/tutorials/AdvancedStructures

Shows a double list where each value has a next pointer and a last pointer, with start and end indices. The last pointer should point back to the previous value in the sequence.

```plaintext
start = 1  

end = 5  

value: 3, 1,  64, 2, 4, 786, 2, 9, 3  

next:  8, 3,  5,  6, 7, -1,  0, 2, 4  

last:  6, -1, 7,  1, 8, 2,   3, 4, 0  

```

--------------------------------

### OnPlayerFinishedDownloading example

Source: https://open.mp/docs/scripting/callbacks/OnPlayerFinishedDownloading

Example implementation of the OnPlayerFinishedDownloading callback that sends a message to the player when downloads finish.

```pawn
public OnPlayerFinishedDownloading(playerid, virtualworld)  

{  

    SendClientMessage(playerid, 0xFFFFFFFF, "Downloads finished.");  

    return 1;  

}  
```

--------------------------------

### ftell(File:handle)

Source: https://open.mp/docs/scripting/functions/ftell

Gets the current position in the file, relative to the start of the file. The file handle must be obtained from fopen.

```APIDOC
## ftell(File:handle)

### Description
Get the current position in the file.

### Parameters
- **File:handle** - The handle of the file (returned by fopen).

### Returns
The current position, relative to the start of the file.

### Example
```pawn
// Open "file.txt" in "read only" mode
new File:handle = fopen("file.txt", io_read);

// Check, if the file is opened
if (handle)
{
    // Success
    printf("Current position: %d", ftell(handle));

    // Close the file
    fclose(handle);
}
else
{
    // Error
    print("The file \"file.txt\" does not exists, or can't be opened.");
}
```

### Related Functions
- fopen: Open a file.
- fclose: Close a file.
- ftemp: Create a temporary file stream.
- fremove: Remove a file.
- fwrite: Write to a file.
- fputchar: Put a character in a file.
- fgetchar: Get a character from a file.
- fblockwrite: Write blocks of data into a file.
- fblockread: Read blocks of data from a file.
- fseek: Jump to a specific character in a file.
- flength: Get the file length.
- fexist: Check, if a file exists.
- fmatch: Check, if patterns with a file name matches.
- fflush: Flush a file to disk (ensure all writes are complete).
- fstat: Return the size and the timestamp of a file.
- frename: Rename a file.
- fcopy: Copy a file.
- filecrc: Return the 32-bit CRC value of a file.
- fattrib: Set the file attributes.
- fcreatedir: Create a directory.
```

--------------------------------

### OnPlayerPickUpPickup example with CreatePickup

Source: https://open.mp/docs/scripting/callbacks/OnPlayerPickUpPickup

Example showing how to create pickups in OnGameModeInit and handle them in OnPlayerPickUpPickup. The callback checks the pickup ID and gives money or health accordingly.

```pawn
new pickup_Cash;  

new pickup_Health;  

  

public OnGameModeInit()  

{  

    pickup_Cash = CreatePickup(1274, 2, 2009.8658, 1220.0293, 10.8206, -1);  

    pickup_Health = CreatePickup(1240, 2, 2009.8474, 1218.0459, 10.8175, -1);  

    return 1;  

}  

  

public OnPlayerPickUpPickup(playerid, pickupid)  

{  

    if (pickupid == pickup_Cash)  

    {  

        GivePlayerMoney(playerid, 1000);  

    }  

    else if (pickupid == pickup_Health)  

    {  

        SetPlayerHealth(playerid, 100.0);  

    }  

    return 1;  

}
```

--------------------------------

### GetVehicleTrailer and DetachTrailerFromVehicle example

Source: https://open.mp/docs/scripting/functions/GetVehicleTrailer

Gets the trailer ID attached to a vehicle and detaches it. Returns 0 if no trailer is attached. Does not work for trains.

```pawn
new  
	trailerId = GetVehicleTrailer(vehicleid);  

DetachTrailerFromVehicle(trailerId);  

```

--------------------------------

### Hello world in pawn (minimal syntax)

Source: https://open.mp/docs/scripting/language/reference/A-tutorial-introduction

The classic 'Hello world' program in pawn, using the minimal syntax where the function body is a single instruction and parentheses around the function argument are optional. The \n escape sequence inserts a newline. The print function must be provided by the host application.

```pawn
main()  

    printf "Hello world\n"  

```

--------------------------------

### OnPlayerGiveDamage example: broadcast damage message

Source: https://open.mp/docs/scripting/callbacks/OnPlayerGiveDamage

Example callback that retrieves attacker and victim names, gets the weapon name, formats a message with the damage amount and body part, and sends it to all players. Returns 1 to prevent the callback from being called in other filterscripts.

```pawn
public OnPlayerGiveDamage(playerid, damagedid, Float:amount, WEAPON:weaponid, bodypart)  

{  

    new string[128], victim[MAX_PLAYER_NAME], attacker[MAX_PLAYER_NAME];  

    new weaponname[24];  

    GetPlayerName(playerid, attacker, sizeof (attacker));  

    GetPlayerName(damagedid, victim, sizeof (victim));  

  

    GetWeaponName(weaponid, weaponname, sizeof (weaponname));  

    format(string, sizeof(string), "%s has made %.0f damage to %s, weapon: %s, bodypart: %d", attacker, amount, victim, weaponname, bodypart);  

    SendClientMessageToAll(0xFFFFFFFF, string);  

    return 1;  

}  
```

--------------------------------

### OnNPCPlaybackStart callback example

Source: https://open.mp/docs/scripting/callbacks/OnNPCPlaybackStart

Example implementation of the OnNPCPlaybackStart callback. It prints a server log message and notifies connected players who are tracking the NPC. The callback is called after NPC_StartPlayback succeeds, and the recordid corresponds to the loaded record file.

```pawn
public OnNPCPlaybackStart(npcid, recordid)  

{  

    printf("[NPC] NPC %d started playback (record: %d)", npcid, recordid);  

  

    // Notify players tracking this NPC  

    for (new playerid = 0; playerid < MAX_PLAYERS; playerid++)  

    {  

        if (!IsPlayerConnected(playerid))  

            continue;  

  

        if (PlayerNPC[playerid] == npcid)  

        {  

            SendClientMessage(playerid, 0x00FF00FF, "NPC %d started playback (record ID: %d)", npcid, recordid);  

        }  

    }  

    return 1;  

}
```

--------------------------------

### OnScriptLoadPlayer example implementation

Source: https://open.mp/docs/scripting/callbacks/OnScriptLoadPlayer

Example callback that prints a message for each player when a script is loaded, indicating whether it is an entry script or a side script. The callback does not handle returns.

```pawn
public OnScriptLoadPlayer(playerid, bool:isEntryScript)  

{  

    printf("Script loaded for player ID %d (isEntryScript: %s)", playerid, isEntryScript ? "Yes" : "No");  

}  

```

--------------------------------

### Example: Get textdraw font

Source: https://open.mp/docs/scripting/functions/TextDrawGetFont

Creates a textdraw, sets its font to TEXT_DRAW_FONT_2, then retrieves the font with TextDrawGetFont and prints it. The output is 'Font: 2'.

```pawn
new Text:gMyTextdraw;  

  

public OnGameModeInit()  

{  

    gMyTextdraw = TextDrawCreate(320.0, 425.0, "This is an example textdraw");  

    TextDrawFont(gMyTextdraw, TEXT_DRAW_FONT_2);  

  

    new TEXT_DRAW_FONT:font = TextDrawGetFont(gMyTextdraw);  

    printf("Font: %d", font); // Font: 2  

    return 1;  

}  
```

--------------------------------

### NPC_MoveToPlayer command example

Source: https://open.mp/docs/scripting/functions/NPC_MoveToPlayer

Example command handler that starts an NPC following the player who issued the command. It validates the NPC ID and checks that the NPC is valid before calling NPC_MoveToPlayer with default movement type and speed. Sends a success message with the NPC ID.

```pawn
public OnPlayerCommandText(playerid, cmdtext[])  

{  

    if (!strcmp(cmdtext, "/npcmovetoplayer", 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.");  

  

        NPC_MoveToPlayer(npcid, playerid, NPC_MOVE_TYPE_JOG, NPC_MOVE_SPEED_AUTO, 0.2, 500, false);  

  

        SendClientMessage(playerid, 0x00FF00FF, "NPC %d now following you", npcid);  

        return 1;  

    }  

    return 0;  

}  
```

--------------------------------

### Single-line main() with print and return

Source: https://open.mp/docs/scripting/resources/start

Equivalent to the basic script but with statements on one line. Shows that separate lines are not required, only clearer.

```pawn
main() { print("Hello World!"); return 1; }  


```

--------------------------------

### Iterate query results with db_next_row in examples.inc and mode.pwn

Source: https://open.mp/docs/scripting/functions/db_next_row

The examples.inc file defines Examples_ListNames, which queries the "examples" table and iterates through each row using db_next_row in a do-while loop, retrieving the "name" field with db_get_field_assoc and freeing the result set with db_free_result. The mode.pwn file includes examples.inc, opens a database connection with db_open in OnGameModeInit, calls Examples_ListNames, and closes the connection in OnGameModeExit with db_close. Both files are required to demonstrate the full workflow of using db_next_row.

```pawn
// examples.inc

// ...

Examples_ListNames(DB:dbConnectionHandle)
{
    // Database result set
    new DBResult:db_result_set = db_query("SELECT `name` FROM `examples`");

    // If database result set is valid
    if (db_result_set)
    {
        // Allocate some memory to store results
        new result[256];

        // Do operations
        do
        {
            // Add value from "example" field to the return value variable
            db_get_field_assoc(db_result_set, "name", result, sizeof result);
        }

        // While next row could be fetched
        while (db_next_row(db_result_set));

        // Free result set
        db_free_result(db_result_set);
    }
}

```

```pawn
// mode.pwn

// ...

#include <examples>

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
    // ...

    // Create a connection to a database
    gDBConnectionHandle = db_open("example.db");

    // If connection to the database exists
    if (gDBConnectionHandle)
    {
        // Successfully created a connection to the database
        print("Successfully created a connection to database \"example.db\".");
        Examples_ListNames(gDBConnectionHandle);
    }
    else
    {
        // Failed to create a connection to the database
        print("Failed to open a connection to database \"example.db\".");
    }

    // ...

    return 1;
}

public OnGameModeExit()
{
    // Close the connection to the database if connection is open
    if (db_close(gDBConnectionHandle))
    {
        // Extra cleanup
        gDBConnectionHandle = DB:0;
    }

    // ...

    return 1;
}

```

--------------------------------

### InterpolateCameraLookAt example in OnPlayerCommandText

Source: https://open.mp/docs/scripting/functions/InterpolateCameraLookAt

Example command '/rotateme' that uses TogglePlayerSpectating and InterpolateCameraLookAt to rotate the camera view from (50.0, 50.0, 10.0) to (-50.0, 50.0, 10.0) over 10000 milliseconds with CAMERA_MOVE. The camera starts looking at the first coordinate and after 10 seconds looks at the second.

```pawn
public OnPlayerCommandText(playerid, cmdtext[])

{

    if (!strcmp(cmdtext, "/rotateme", true))

    {

        TogglePlayerSpectating(playerid, true);

        InterpolateCameraLookAt(playerid, 50.0, 50.0, 10.0, -50.0, 50.0, 10.0, 10000, CAMERA_MOVE);

        //                                 x1    y1    z1     x2    y2    z2

        // The camera starts off looking at (x1, y1, z1). It will then rotate and after

        // 10000 milliseconds (10 seconds) it will be looking at (x2, y2, z2).

        return 1;

    }

    return 0;

}
```
Tokens:
Raw