scripting/include/cssdm.inc
author David Anderson <dvander@alliedmods.net>
Wed Jul 25 04:38:40 2007 +0000 (2007-07-25)
changeset 29 1f82ce29d6c8
parent 27 75b04b12ab71
child 43 6793d77652a4
permissions -rw-r--r--
sigh, another version bump >:o i need to use versionchanger
dvander@0
     1
/**
dvander@0
     2
 * vim: set ts=4 :
dvander@0
     3
 * ===============================================================
dvander@0
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@0
     5
 * ===============================================================
dvander@0
     6
 *
dvander@0
     7
 *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be used 
dvander@0
     8
 * or modified under the Terms and Conditions of its License Agreement, which is found 
dvander@0
     9
 * in LICENSE.txt.  The Terms and Conditions for making SourceMod extensions/plugins 
dvander@0
    10
 * may change at any time.  To view the latest information, see:
dvander@0
    11
 *   http://www.sourcemod.net/license.php
dvander@0
    12
 *
dvander@0
    13
 * Version: $Id$
dvander@0
    14
 */
dvander@0
    15
dvander@0
    16
#if defined _cssdm_included
dvander@0
    17
 #endinput
dvander@0
    18
#endif
dvander@0
    19
#define _cssdm_included
dvander@0
    20
dvander@29
    21
#define CSSDM_VERSION		"2.0.0.416"
dvander@0
    22
dvander@0
    23
#define CSSDM_MAX_WEAPONS		32
dvander@0
    24
dvander@0
    25
#define CSSDM_TEAM_T			2
dvander@0
    26
#define CSSDM_TEAM_CT			3
dvander@0
    27
dvander@0
    28
enum DmWeaponType
dvander@0
    29
{
dvander@0
    30
	DmWeapon_Invalid = -1,
dvander@0
    31
	DmWeapon_Primary = 0,
dvander@0
    32
	DmWeapon_Secondary = 1,
dvander@0
    33
	DmWeapon_Grenade = 3,
dvander@0
    34
	DmWeapon_C4 = 4,
dvander@0
    35
};
dvander@0
    36
dvander@0
    37
/**
dvander@0
    38
 * Called when CS:S DM is started/enabled.  If CS:S DM is enabled,
dvander@0
    39
 * this will get called at the start of every map.
dvander@0
    40
 */
dvander@0
    41
forward DM_OnStartup();
dvander@0
    42
dvander@0
    43
/**
dvander@0
    44
 * Called when CS:S DM is disabled.  If CS:S DM is enabled, this 
dvander@0
    45
 * will get called at the end of the map.
dvander@0
    46
 */
dvander@0
    47
forward DM_OnShutdown();
dvander@0
    48
dvander@0
    49
/**
dvander@0
    50
 * Called when a player spawns and CS:S DM is active.  This
dvander@0
    51
 * is a wrapper around the "player_spawn" event.
dvander@0
    52
 *
dvander@0
    53
 * @param client		Client index.
dvander@0
    54
 * @noreturn
dvander@0
    55
 */
dvander@0
    56
forward DM_OnClientSpawned(client);
dvander@0
    57
dvander@0
    58
/**
dvander@0
    59
 * Called when a player spawns and CS:S DM is active.  This 
dvander@0
    60
 * is called after all plugins are done processing 
dvander@0
    61
 * DM_OnClientSpawned().
dvander@0
    62
 *
dvander@0
    63
 * @param client		Client index.
dvander@0
    64
 * @noreturn
dvander@0
    65
 */
dvander@0
    66
forward DM_OnClientPostSpawned(client);
dvander@0
    67
dvander@0
    68
/**
dvander@0
    69
 * Called when a player dies.
dvander@0
    70
 * 
dvander@0
    71
 *
dvander@0
    72
 * @param client		Client index.
dvander@0
    73
 * @return				Plugin_Handled to block player from respawning.
dvander@0
    74
 */
dvander@0
    75
forward Action:DM_OnClientDeath(client);
dvander@0
    76
dvander@0
    77
/**
dvander@0
    78
 * Called when the cssdm_spawn_method cvar changes.
dvander@0
    79
 *
dvander@0
    80
 * @param method		Method name.
dvander@0
    81
 * @return				Plugin_Stop to handle this method.
dvander@0
    82
 */
dvander@0
    83
forward Action:DM_OnSetSpawnMethod(const String:method[]);
dvander@0
    84
dvander@0
    85
/**
dvander@0
    86
 * Returns whether CS:S DM is running or not.  This should be used to 
dvander@0
    87
 * check whether non-CS:S DM callbacks should be processed.
dvander@0
    88
 *
dvander@0
    89
 * @return				True if CS:S DM is running, false otherwise.
dvander@0
    90
 */
dvander@0
    91
native bool:DM_IsRunning();
dvander@0
    92
dvander@0
    93
/**
dvander@0
    94
 * Retrieves the CS:S DM spawning method.
dvander@0
    95
 *
dvander@0
    96
 * @param method		Method name buffer.
dvander@0
    97
 * @param maxlength		Maximum size of the method name buffer.
dvander@0
    98
 * @noreturn
dvander@0
    99
 */
dvander@0
   100
native DM_GetSpawnMethod(const String:method[], maxlength);
dvander@0
   101
dvander@0
   102
/**
dvander@0
   103
 * Provides lookup for a weapon by its short name.
dvander@0
   104
 *
dvander@0
   105
 * @param name			Weapon short name (such as "usp").
dvander@0
   106
 * @return				Weapon ID in CS:S DM, or -1 on failure.
dvander@0
   107
 */
dvander@0
   108
native DM_GetWeaponID(const String:name[]);
dvander@0
   109
dvander@0
   110
/**
dvander@0
   111
 * Gets the type of a weapon by index.
dvander@0
   112
 *
dvander@0
   113
 * @param id			Weapon ID.
dvander@0
   114
 * @return				Weapon type.
dvander@0
   115
 * @error				Invalid weapon index.
dvander@0
   116
 */
dvander@0
   117
native DmWeaponType:DM_GetWeaponType(index);
dvander@0
   118
dvander@0
   119
/**
dvander@0
   120
 * Retrieves the classname of a weapon. 
dvander@0
   121
 *
dvander@0
   122
 * @param id			Weapon ID.
dvander@0
   123
 * @param classname		Class name buffer.
dvander@0
   124
 * @param maxlength		Maximum length of the class name buffer.
dvander@0
   125
 * @noreturn
dvander@0
   126
 * @error				Invalid weapon index.
dvander@0
   127
 */
dvander@0
   128
native DM_GetWeaponClassname(id, String:classname[], maxlength);
dvander@0
   129
dvander@0
   130
/**
dvander@0
   131
 * Retrieves the display name of a weapon. 
dvander@0
   132
 *
dvander@0
   133
 * @param id			Weapon ID.
dvander@0
   134
 * @param name			Display name buffer.
dvander@0
   135
 * @param maxlength		Maximum length of the display name buffer.
dvander@0
   136
 * @noreturn
dvander@0
   137
 * @error				Invalid weapon index.
dvander@0
   138
 */
dvander@0
   139
native DM_GetWeaponName(id, String:name[], maxlength);
dvander@0
   140
dvander@0
   141
/**
dvander@0
   142
 * Retrieves the entity index of a weapon in a player's weapon slot.
dvander@0
   143
 *
dvander@0
   144
 * @param client		Client index.
dvander@0
   145
 * @param type			Weapon slot type.
dvander@0
   146
 * @return				Entity index, or -1 for none.
dvander@0
   147
 */
dvander@0
   148
native DM_GetClientWeapon(client, DmWeaponType:type);
dvander@0
   149
dvander@0
   150
/**
dvander@0
   151
 * Drops a client's weapon.  CS:S DM removes dropped weapons from the world.
dvander@0
   152
 *
dvander@0
   153
 * @param client		Client index.
dvander@0
   154
 * @param entity		Weapon entity index.
dvander@0
   155
 * @noreturn
dvander@0
   156
 * @error				Client index invalid or not in game; weapon entity invalid.
dvander@0
   157
 */
dvander@0
   158
native DM_DropWeapon(client, entity);
dvander@0
   159
dvander@0
   160
/**
dvander@0
   161
 * Strips all items from a bot, excluding their player suit.
dvander@0
   162
 *
dvander@0
   163
 * @param client		Client index.
dvander@0
   164
 * @noreturn
dvander@0
   165
 * @error				Invalid client index, client not in game, nor client not a bot.
dvander@0
   166
 */
dvander@0
   167
native DM_StripBotItems(client);
dvander@0
   168
dvander@1
   169
/**
dvander@1
   170
 * Returns the spawn waiting time.
dvander@1
   171
 *
dvander@1
   172
 * @return				Spawn wait time, in seconds.
dvander@1
   173
 */
dvander@1
   174
native Float:DM_GetSpawnWaitTime();
dvander@1
   175
dvander@1
   176
/**
dvander@1
   177
 * Respawns a player using CS:S's low level respawning function.  This can be 
dvander@1
   178
 * called even if the player is not dead.
dvander@1
   179
 *
dvander@1
   180
 * @param client		Client index.
dvander@1
   181
 * @param fullRespawn	If true, client will be forwarded through player_spawn 
dvander@1
   182
 *						callbacks.
dvander@1
   183
 * @noreturn
dvander@1
   184
 * @error				Invalid client index or client not in game.
dvander@1
   185
 */
dvander@1
   186
native DM_RespawnClient(client, bool:fullRespawn=true);
dvander@1
   187
dvander@1
   188
/**
dvander@1
   189
 * Returns whether or not a client is alive.
dvander@1
   190
 *
dvander@1
   191
 * @param client		Client index.
dvander@1
   192
 * @return				True if alive, false if dead.
dvander@1
   193
 * @error				Invalid client index or client not in game.
dvander@1
   194
 */
dvander@1
   195
native DM_IsClientAlive(client);
dvander@1
   196
dvander@1
   197
/**
dvander@1
   198
 * Gives ammo to a player.
dvander@1
   199
 *
dvander@1
   200
 * @param client		Client index.
dvander@1
   201
 * @param type			Ammo type (>=0).
dvander@1
   202
 * @param count			Ammo amount to give.
dvander@1
   203
 * @param noSound		If true, the ammo sound will be suppressed.
dvander@1
   204
 * @return				Actual ammo amount given.
dvander@1
   205
 * @error				Invalid client index or client not in game.
dvander@1
   206
 */
dvander@1
   207
native DM_GiveClientAmmo(client, type, count, bool:noSound=false);
dvander@0
   208
dvander@0
   209
/**
dvander@0
   210
 * Do not edit below this line!
dvander@0
   211
 */
dvander@0
   212
public Extension:__ext_cssdm = 
dvander@0
   213
{
dvander@0
   214
	name = "CS:S DM",
dvander@0
   215
	file = "cssdm.ext",
dvander@0
   216
#if defined AUTOLOAD_EXTENSIONS
dvander@0
   217
	autoload = 1,
dvander@0
   218
#else
dvander@0
   219
	autoload = 0,
dvander@0
   220
#endif
dvander@0
   221
#if defined REQUIRE_EXTENSIONS
dvander@0
   222
	required = 1,
dvander@0
   223
#else
dvander@0
   224
	required = 0,
dvander@0
   225
#endif
dvander@0
   226
};