AlliedModders Wiki

https://wiki.alliedmods.net/
Admin
The AlliedModders Wiki provides documentation for various projects and development, including...
Tokens:1,115,278
Snippets:14,199
Trust Score:8.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### CZCareer START Event Example

Source: https://wiki.alliedmods.net/CZCareer

Example usage for the START event, sent at the beginning of a Condition Zero singleplayer mission. The 'Unknown' parameter is always 300.

```text
Name:  | CZCareer   
---|---
Structure:  |  | string  | START   
---
short  | 300   
  
```

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

### Configure Config Example

Source: https://wiki.alliedmods.net/Configuring_AMX_Mod_X

Example entry for executing server configuration files.

```text
"PUBLIC Settings" "servercfgfile server.cfg;exec server.cfg" "a" "u"
```

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

### Get All Help Recursively

Source: https://wiki.alliedmods.net/Special%3AApiHelp/help

This example fetches help for all available modules and their submodules recursively. Use with caution as it can return a large amount of information.

```api
api.php?action=help&recursivesubmodules=1
```

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

### Create Static Library for Protobufs

Source: https://wiki.alliedmods.net/AMBuild_API

This example demonstrates how to create a static library from generated protobuf files using the StaticLibrary helper. It shows the necessary setup including detecting C++ compiler and protoc, defining proto files, and linking the library to a program.

```python
cxx = builder.DetectCxx()
protoc = builder.DetectProtoc()

proto_files = [
    'game.proto',
    'player.proto',
]
out = protoc.StaticLibrary('protos', builder, cxx, proto_files)

prog = builder.Program('myprogram')
prog.compiler.sourcedeps += out.headers
prog.compiler.linkflags += [out.lib.binary]
```

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

### Configure Command Example

Source: https://wiki.alliedmods.net/Configuring_AMX_Mod_X

Example entry for pausing the server via the command menu.

```text
"Pause" "amx_pause" "bd" "u"
```

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

### Configure Client Command Example

Source: https://wiki.alliedmods.net/Configuring_AMX_Mod_X

Example entry for slaying a player via the client command menu.

```text
"Slay player" "amx_slay #%userid%" "bd" "u"
```

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

### FakeMeta Plugin Initialization

Source: https://wiki.alliedmods.net/FakeMeta_General_Usage_%28AMX_Mod_X%29

Basic setup for a FakeMeta plugin, including registering the plugin and a forward for player pre-think events. Use this as a starting point for FakeMeta plugins.

```pawn
#include <amxmodx>
#include <fakemeta>

public plugin_init()
{
	register_plugin("FakeMeta Test","1.0","Hawk552");

	register_forward(FM_PlayerPreThink,"PreThink");
}

public PreThink(id)
{
	// here you would insert some code

	return FMRES_IGNORED;
}
```

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

### Configure Speech Example

Source: https://wiki.alliedmods.net/Configuring_AMX_Mod_X

Example entry for playing a sound via the speech menu.

```text
"Hello!" "spk 'vox/hello'" "cd" "u"
```

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

### Install AMBuild using pip

Source: https://wiki.alliedmods.net/AMBuild

Installs AMBuild from its GitHub repository using pip. Use sudo for a global installation.

```bash
git clone https://github.com/alliedmodders/ambuild
pip install ./ambuild

```

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

### TF2 Basic Voting Plugin Example

Source: https://wiki.alliedmods.net/TF2_Voting

This C++ SourceMod plugin demonstrates how to start a simple yes/no vote, handle client responses, and process the vote outcome. It requires TF2 and SourceMod to be installed.

```cpp
#include <sourcemod>
// TF2's internal map vote uses client index 99 for the server
#define TF2_SERVER_CLIENT_INDEX 99
#define TF2_TEAM_ALL -1

int g_iYesVotes;
int g_iNoVotes;

#define MAX_VOTES 4

public Plugin myinfo = 
{
    name = "Test Yes/No Vote",
    author = "Powerlord",
    description = "A test vote plugin for the AlliedMods wiki",
    version = "1.0",
    url = "http://wiki.alliedmods.net/TF2_Voting"
}

public void OnPluginStart()
{
    RegConsoleCmd("testvote", Callvote_Handler);
    RegConsoleCmd("vote", vote);
}

public Action Callvote_Handler(int client, int args)
{
    BfWrite bf = UserMessageToBfWrite(StartMessageAll("VoteStart", USERMSG_RELIABLE));
    bf.WriteByte(TF2_TEAM_ALL);
    bf.WriteByte(TF2_SERVER_CLIENT_INDEX);
    bf.WriteString("#TF_playerid_noteam");
    bf.WriteString("Is gaben fat?");
    bf.WriteBool(true);
    EndMessage();

    g_iYesVotes = 0;
    g_iNoVotes = 0;

    return Plugin_Handled;
}

void UpdateVotes()
{
    if (g_iYesVotes + g_iNoVotes >= MAX_VOTES)
    {
        PrintToServer("voting complete!");
        if (g_iYesVotes > g_iNoVotes)
        {
            BfWrite bf = UserMessageToBfWrite(StartMessageAll("VotePass"));
            bf.WriteByte(TF2_TEAM_ALL);
            bf.WriteString("#TF_playerid_noteam");
            bf.WriteString("Gaben is fat");
            EndMessage();
        }
        else
        {
            BfWrite bf = UserMessageToBfWrite(StartMessageAll("VoteFailed"));
            bf.WriteByte(TF2_TEAM_ALL);
            // Check list of failure reasons
            bf.WriteByte(3);
            EndMessage();
        }
    }
}

// If the TF2 vote system is running (sv_allow_votes 1), this needs to be a command listener
// because TF2 registers the vote command only when a vote is ongoing, and thus hooking it using RegConsoleCmd doesn't work.
public Action vote(int client, int args)
{
    char arg[8];
    GetCmdArg(1, arg, 8);

    PrintToServer("Got vote %s from %i", arg, client);

    int option = 0;
    if (strcmp(arg, "option1", true) == 0)
    {
        g_iYesVotes++;
    }
    else if (strcmp(arg, "option2", true) == 0)
    {
        g_iNoVotes++;
        option = 1;
    }

    Event event = CreateEvent("vote_cast");
    event.SetInt("entityid", client);
    event.SetInt("team", -1);
    event.SetInt("vote_option", option);
    event.Fire();

    UpdateVotes();

    return Plugin_Continue;
}

```

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

### Usage Example for FindFuncAddr

Source: https://wiki.alliedmods.net/SourceHook_Development

Example demonstrating how to use the FindFuncAddr utility function to get the address of a constructor thunk.

```cpp
// Usage:
FindFuncAddr(&Ctor_Thunk<type>::NormalConstructor)
// (if the type is a reference type, use it without & here)
```

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

### Install 32-bit Libraries on Ubuntu

Source: https://wiki.alliedmods.net/Compiling_SourceMod_Plugins

Before compiling on Linux, install the necessary 32-bit libraries if your distribution requires them. This example is for Ubuntu.

```bash
apt-get install libc6:i386 lib32stdc++6

```

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

### Full Admin Command Implementation Example

Source: https://wiki.alliedmods.net/Introduction_to_SourceMod_Plugins

A comprehensive example demonstrating how to register and implement a custom admin command, including argument parsing, player targeting, and action execution.

```sm
#include <sourcemod>
#include <sdktools>

public Plugin myinfo =
{
	name = "My First Plugin",
	author = "Me",
	description = "My first plugin ever",
	version = "1.0.0.0",
	url = "http://www.sourcemod.net/"
}

public void OnPluginStart()
{
	RegAdminCmd("sm_myslap", Command_MySlap, ADMFLAG_SLAY);
	LoadTranslations("common.phrases.txt"); // Required for FindTarget fail reply
}

public Action Command_MySlap(int client, int args)
{
	char arg1[32], arg2[32];

	/* By default, we set damage = 0 */
	int damage = 0;

	/* Get the first argument */
	GetCmdArg(1, arg1, sizeof(arg1));

	/* If there are 2 or more arguments, we set damage to
	 * what the user specified. If a damage isn't specified
	 * then it will stay zero. */
	if (args >= 2)
	{
		GetCmdArg(2, arg2, sizeof(arg2));
		damage = StringToInt(arg2);
	}

	/* Try and find a matching player */
	int target = FindTarget(client, arg1);
	if (target == -1)
	{
		/* FindTarget() automatically replies with the 
		 * failure reason and returns -1 so we know not 
		 * to continue
		 */
		return Plugin_Handled;
	}

	SlapPlayer(target, damage);
	ReplyToCommand(client, "[SM] You slapped %N for %d damage!", target, damage);

	return Plugin_Handled;
}
```

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

### HLTV Round Start Messages

Source: https://wiki.alliedmods.net/Half-Life_1_Game_Events

Example of sending HLTV messages to reset player health and FOV at the start of a round.

```cpp
// reset all players health for HLTV
MESSAGE_BEGIN( MSG_SPEC, gmsgHLTV );
WRITE_BYTE( 0 );   // 0 = all players
WRITE_BYTE( 100 | 128 );
MESSAGE_END();  

// reset all players FOV for HLTV
MESSAGE_BEGIN( MSG_SPEC, gmsgHLTV );
WRITE_BYTE( 0 );   // all players
WRITE_BYTE( 0 );
MESSAGE_END();
```

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

### CZCareer GOGOGO Event Example

Source: https://wiki.alliedmods.net/CZCareer

Example usage for the GOGOGO event, sent at the start of a new Condition Zero singleplayer round. This event has no extra arguments.

```text
Name:  | CZCareer   
---|---
Structure:  |  | string  | GOGOGO   
---
  
```

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

### Simple Admin Configuration Examples

Source: https://wiki.alliedmods.net/Adding_Admins_%28SourceMod%29

Examples demonstrating the syntax for `admins_simple.ini`, including Steam ID, IP address, and name-based authentication with optional immunity levels and passwords.

```ini
"STEAM_0:1:16"		"bce"			//generic, kick, unban for this steam ID. no immunity
```

```ini
"!127.0.0.1"		"5:z"			//all permissions for this IP, immunity level = 5
```

```ini
"BAILOPAN"		"abc"	"Gab3n"		//name BAILOPAN, password "Gab3n": gets reservation, generic, kick
```

```ini
"Gaben"			"@Admins"			//name Gaben, group Admins
```

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

### Outputting "Hello world!" on Plugin Start

Source: https://wiki.alliedmods.net/My_First_Script

This snippet shows how to use the `PrintToServer` function within the `OnPluginStart` callback to display a message in the server console when the plugin begins.

```sp
public void OnPluginStart()
{
	PrintToServer("Hello world!");
}
```

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

### Get InOpen Trace Result

Source: https://wiki.alliedmods.net/FakeMeta_Functions_Detailed_Descriptions

Retrieves the TR_InOpen value, indicating if the trace started in an open area of the map. This helps differentiate between starting in the world versus inside an entity.

```amxmod
new inopen = get_tr2(trace, TR_InOpen)
```

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

### Example Metamod output

Source: https://wiki.alliedmods.net/Installing_SourceMod

Expected output when SourceMod is successfully installed and recognized by Metamod.

```text
] meta list
Listing 1 plugin:
    [01] SourceMod (1.1.0.2489) by AlliedModders LLC
```

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

### Implement AutoExecConfig example

Source: https://wiki.alliedmods.net/AMX_Mod_X_1.9_API_Changes

Demonstrates registering cvars and using AutoExecConfig to generate a configuration file.

```pawn
#include <amxmodx>
 
public plugin_init()
{
    register_plugin("Hat", "User", "1.0");
 
    create_cvar("mysqlk_database", "", .description = "MySQL database");
    create_cvar("mysqlk_host", "localhost", .description = "MySQL host, use this to configure various^nthings for your server.");
 
    AutoExecConfig();
}
```

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

### UTIL_Tracer Example Call

Source: https://wiki.alliedmods.net/Useful_Signatures

Example of how to call UTIL_Tracer using SignatureScanCall_NoIndex. Parameters include start and end vectors, entity index, attachment, velocity, whiz flag, and custom tracer name.

```smscript
new Float:start[3];
new Float:end[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, start, PARAM_VECTOR, end, PARAM_INT, client, PARAM_INT, -1, PARAM_FLOAT, 10.0, PARAM_INT, 1, PARAM_CONST_CHAR_PTR, "OLLY");
```

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

### Connect to Database using Default Configuration

Source: https://wiki.alliedmods.net/Ru%3ASQL_%28SourceMod_Scripting%29

This example demonstrates how to connect to a database using a predefined named configuration (e.g., 'default') and handles potential connection errors. The database handle must be closed after use.

```smj
new String:error[255]
new Handle:db = SQL_DefConnect(error, sizeof(error))

if (db == INVALID_HANDLE)
{
	PrintToServer("Could not connect: %s", error)
} else {
	CloseHandle(db)
}

```

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

### Database Configuration Example

Source: https://wiki.alliedmods.net/SQL_%28SourceMod_Scripting%29

Example of a named database configuration in databases.cfg. Ensure 'default' is present if using SQL.

```cfg
    "default"
    {
        "host"              "localhost"
        "database"          "sourcemod"
        "user"              "root"
        "pass"              ""
        //"timeout"         "0"
        //"port"            "0"
    }
```

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

### Get Nth Filled Index

Source: https://wiki.alliedmods.net/Array_Module

Returns the nth filled index in an array, starting from a specified index.

```APIDOC
## `array_get_nth(arrayid, n, start = 0, disable_check = 0)`

### Description
Returns the nth filled index, starting at `_start_`.

### Parameters
* `arrayid` - The ID of the array.
* `n` - The desired index number.
* `start` (optional, default 0) - The starting index for the search.
* `disable_check` (optional, default 0) - Flag to disable checks.

### Returns
The nth filled index.
```

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

### Set up Visual Studio Command Prompt

Source: https://wiki.alliedmods.net/Compiling_SourceMod

Opens a command prompt with the Visual Studio build tools available in the PATH. Substitute the version number if necessary.

```batch
"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"
```

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

### Get Parameter Information

Source: https://wiki.alliedmods.net/Special%3AApiHelp/paraminfo

This example demonstrates how to retrieve parameter information for specific API modules, including those with submodules.

```APIDOC
## GET api.php

### Description
Obtain information about API modules and their parameters.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `paraminfo`.
- **modules** (string) - Optional - List of module names (e.g., `parse`, `phpfm`, `query+allpages`, `query+siteinfo`). Can specify submodules with `+`, all submodules with `+*`, or all submodules recursively with `+**`. Separate values with `|` or alternative. Maximum number of values is 50 (500 for bots).
- **helpformat** (string) - Optional - Format of help strings. One of the following values: `html`, `wikitext`, `raw`, `none`. Default: `none`.

### Request Example
```
api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo
```

### Request Example (Submodules)
```
api.php?action=paraminfo&modules=query%2B*
```

### Response
#### Success Response (200)
- **paraminfo** (object) - Contains information about the requested modules and their parameters.
  - **modules** (array) - List of module objects.
    - **name** (string) - The name of the module.
    - **parameters** (array) - List of parameters for the module.
      - **name** (string) - The name of the parameter.
      - **type** (string) - The data type of the parameter.
      - **required** (boolean) - Whether the parameter is required.
      - **description** (string) - Description of the parameter.
      - **values** (array) - List of possible values for the parameter (if applicable).

#### Response Example
```json
{
  "batchcomplete": "",
  "query": {
    "paraminfo": {
      "modules": [
        {
          "name": "parse",
          "parameters": [
            {
              "name": "text",
              "type": "string",
              "required": false,
              "description": "Text to parse."
            }
          ]
        }
      ]
    }
  }
}
```
```

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

### Fetch Revisions for Pages with Prefix

Source: https://wiki.alliedmods.net/Special%3AApiHelp/query

This example shows how to fetch revisions for all pages whose titles start with a specific prefix.

```APIDOC
## GET api.php?action=query

### Description
Fetches revisions of pages beginning with a specified prefix.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be "query".
- **generator** (string) - Optional - Specifies a generator to use (e.g., "allpages").
- **gapprefix** (string) - Optional - The prefix to filter page titles when using the "allpages" generator.
- **prop** (string) - Optional - Specifies the properties to retrieve for each page (e.g., "revisions").
- **continue** (string) - Optional - Used for continuation of paginated results.
```

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

### Initialize Plugin and Register Menu

Source: https://wiki.alliedmods.net/Using_New_Menu_System

Register the plugin, cache max players, create the menu, register a client command to start the vote, and build the menu.

```c
public plugin_init()
{
	// Register Our Plugin
	register_plugin("Vote Menu","1.0","Freecode");

        // Cache maxplayers so we don't have to loop 32 times
        g_maxplayers = get_maxplayers()

	// Register our Change Level vote menu
	g_Menu = menu_create("Change Level?","menu_handle");

	register_clcmd("amx_startvote","startvote",ADMIN_CFG,"Gaben");

	// Now we need to build our menu
	build_menu();
}
```

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

### Get Last Empty Index

Source: https://wiki.alliedmods.net/Array_Module_%28AMX_Mod_X%29

Retrieves the last empty index in an array, starting from a specified index. Verify the `success` parameter.

```c
#define _lastempty "lastempty"
```

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

### Get First Empty Index

Source: https://wiki.alliedmods.net/Array_Module_%28AMX_Mod_X%29

Finds the first empty index in an array, starting from a given index. The `success` parameter should be verified.

```c
#define _firstempty "firstempty"
```

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

### Get First Empty Index

Source: https://wiki.alliedmods.net/Array_Module

Retrieves the first empty index in an array, starting from a given index. The `success` parameter should be checked.

```c
#*_firstempty(arrayid, index, &success = 0);
```

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

### Example Build Output

Source: https://wiki.alliedmods.net/AMBuild_Tutorial

Illustrates the output messages from AMBuild during the packaging process, showing file copy operations.

```text
[5952] cp "/home/dvander/projects/ambuild/ambuild2/README.txt" "./dist/README.txt"
Spawned worker (pid: 5953)
[5952] c++ -H -c /home/dvander/projects/ambuild/ambuild2/helpers.cpp -o helpers.o
[5954] c++ -H -c /home/dvander/projects/ambuild/ambuild2/main.cpp -o main.o
[5954] c++ main.o helpers.o -o hello
[5954] cp "hello/hello" "./dist/hello"
```

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

### Implement OnPluginStart Callback

Source: https://wiki.alliedmods.net/Introduction_to_SourceMod_Plugins

This is a basic implementation of the OnPluginStart forward. It must be public, have the same name, and the same arguments as the forward declaration.

```SourcePawn
public void OnPluginStart()
{
}
```

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

### Search for approved plugins by author

Source: https://wiki.alliedmods.net/User%3ATheY4Kman/Plug-in_Search_API

Use GET parameters to filter search results. This example searches for approved plugins by a specific author.

```http
http://users.alliedmods.net/~they4kman/plugin_search.php?approved=yes&author=theY4Kman
```

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

### Get StartSolid Trace Result

Source: https://wiki.alliedmods.net/FakeMeta_Functions_Detailed_Descriptions

Retrieves the TR_StartSolid value, indicating if the trace started inside an object. This is useful for determining the initial state of the trace.

```amxmod
new startsolid = get_tr2(trace, TR_StartSolid)
```

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

### Example Admins.cfg Configuration

Source: https://wiki.alliedmods.net/Adding_Admins_%28SourceMod%29

Provides concrete examples of how to configure multiple administrators in the admins.cfg file, showcasing different options like flags, immunity, and group.

```kv
Admins
{
	"BAILOPAN"
	{
		"auth"		"steam"
		"identity"	"STEAM_0:1:2345"
		"flags"		"abcdef"
		"immunity"	"5"
		"group"		"Awesome Admins"
	}

	"Blue Crab"
	{
		"auth"		"steam"
		"identity"	"STEAM_0:1:666666"
		"flags"		"z"
		"immunity"	"99"
	}
}
```

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

### Get Last Filled Index

Source: https://wiki.alliedmods.net/Array_Module_%28AMX_Mod_X%29

Retrieves the last filled index in an array or keytable, starting from a specified index. Ensure to check the `success` parameter.

```c
#define _last "last"
```

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

### Get Nth Filled Index

Source: https://wiki.alliedmods.net/Array_Module

Retrieves the nth filled index in an array, starting from a specified index. The `disable_check` parameter can be used to bypass checks.

```c
array_get_nth(arrayid, n, start = 0, disable_check = 0);
```

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

### Declare and Initialize Variables in SourcePawn

Source: https://wiki.alliedmods.net/Introduction_to_SourcePawn_1.7

Demonstrates the syntax for declaring variables with specific types and assigning initial values.

```SourcePawn
int money = 5400;
float percent = 67.3;
char key = 'A';
bool enabled = false;
```

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

### Registering a Console Command

Source: https://wiki.alliedmods.net/Button_constants

This example shows how to register a console command. Note that commands starting with '+' cannot be hooked by the HL engine if they are made by the HL engine.

```csharp
register_concmd("+explode","explode");
```

```csharp
register_concmd("+attack","hook_attack");
```

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

### Example Plugin Packaging Structure

Source: https://wiki.alliedmods.net/Packaging_Plugins_%28SourceMod%29

This example shows the correct directory structure for files to be included in a plugin's supporting zip archive. The paths should reflect where these files will be placed on the server after extraction.

```plaintext
cfg/sourcemod/myconfig.cfg
addons/sourcemod/configs/admin_myadmin.cfg
addons/sourcemod/gamedata/obscuregame.gamedata.txt
addons/sourcemod/translations/myplugin.phrases.txt
models/player/someplayer.vdf
maps/somemap.bsp
```

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

### Engine Plugin Initialization

Source: https://wiki.alliedmods.net/FakeMeta_General_Usage_%28AMX_Mod_X%29

Basic setup for an Engine module plugin, including registering the plugin. This serves as a comparison to the FakeMeta setup.

```pawn
#include <amxmodx>
#include <engine>

public plugin_init()
{
	register_plugin("Engine Test","1.0","Hawk552");
}

public client_PreThink(id)
{
	// here you would insert some code

	return;
}
```

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

### Get Nth Filled Index in Array

Source: https://wiki.alliedmods.net/Array_Module_%28AMX_Mod_X%29

Returns the nth filled index within an array, starting from a specified position. The `disable_check` parameter can be used to bypass checks.

```c
#define array_get_nth "array_get_nth"
```

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

### Get First Filled Index

Source: https://wiki.alliedmods.net/Array_Module_%28AMX_Mod_X%29

Retrieves the first filled index in an array or keytable, starting from a specified index. The `success` parameter should be checked to ensure the operation was successful.

```c
#define _first "first"
```

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

### Create Cvar Usage Example

Source: https://wiki.alliedmods.net/AMX_Mod_X_1.9_API_Changes

Demonstrates various ways to use create_cvar to register cvars with descriptions and boundaries.

```Pawn
#include <amxmodx>

public plugin_init()
{
    create_cvar("amx_something1", "1", FCVAR_NONE, "My description here", true, 1.0, true, 42.0);
    create_cvar("amx_something2", "2", .description = "My description here", .has_min = true, min_val = 1.0, .has_max = true, .max_val = 42.0);
    create_cvar("amx_something3", "3", .has_min = true, min_val = 1.0);
    create_cvar("amx_something4", "4", .has_max = true, max_val = 42.0);
}
```
Tokens:
Raw