plugins/include/tf2.inc
author Nicholas Hastings <skamonkey@gmail.com>
Wed Mar 31 08:51:25 2010 -0400 (2010-03-31)
changeset 2943 1bbdb33fee53
parent 2942 2048322c8b74
child 2976 9eb1584be50d
permissions -rw-r--r--
Added TF2_StunPlayer native and TF2_GetPlayerConditionFlags stock to TF2 ext. (bug 4331, r=pred)
pred@1964
     1
/**
pred@1964
     2
 * vim: set ts=4 :
pred@1964
     3
 * =============================================================================
pred@1964
     4
 * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
pred@1964
     5
 * =============================================================================
pred@1964
     6
 *
pred@1964
     7
 * This file is part of the SourceMod/SourcePawn SDK.
pred@1964
     8
 *
pred@1964
     9
 * This program is free software; you can redistribute it and/or modify it under
pred@1964
    10
 * the terms of the GNU General Public License, version 3.0, as published by the
pred@1964
    11
 * Free Software Foundation.
pred@1964
    12
 * 
pred@1964
    13
 * This program is distributed in the hope that it will be useful, but WITHOUT
pred@1964
    14
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
pred@1964
    15
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
pred@1964
    16
 * details.
pred@1964
    17
 *
pred@1964
    18
 * You should have received a copy of the GNU General Public License along with
pred@1964
    19
 * this program.  If not, see <http://www.gnu.org/licenses/>.
pred@1964
    20
 *
pred@1964
    21
 * As a special exception, AlliedModders LLC gives you permission to link the
pred@1964
    22
 * code of this program (as well as its derivative works) to "Half-Life 2," the
pred@1964
    23
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
pred@1964
    24
 * by the Valve Corporation.  You must obey the GNU General Public License in
pred@1964
    25
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
pred@1964
    26
 * this exception to all derivative works.  AlliedModders LLC defines further
pred@1964
    27
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
pred@1964
    28
 * or <http://www.sourcemod.net/license.php>.
pred@1964
    29
 *
ds@1987
    30
 * Version: $Id$
pred@1964
    31
 */
pred@1964
    32
pred@1963
    33
#if defined _tf2_included
pred@1963
    34
 #endinput
pred@1963
    35
#endif
pred@1963
    36
#define _tf2_included
pred@1963
    37
skamonkey@2943
    38
#define TF_STUNFLAG_SLOWDOWN        (1 << 0)	// activates slowdown modifier
skamonkey@2943
    39
#define TF_STUNFLAG_BONKSTUCK       (1 << 1)	// bonk sound, stuck
skamonkey@2943
    40
#define TF_STUNFLAG_LIMITMOVEMENT   (1 << 2)	// disable forward/backward movement
skamonkey@2943
    41
#define TF_STUNFLAG_CHEERSOUND      (1 << 3)	// cheering sound
skamonkey@2943
    42
#define TF_STUNFLAG_NOSOUNDOREFFECT (1 << 5)	// no sound or particle
skamonkey@2943
    43
#define TF_STUNFLAG_THIRDPERSON     (1 << 6)	// panic animation
skamonkey@2943
    44
#define TF_STUNFLAG_GHOSTEFFECT     (1 << 7)	// ghost particles
skamonkey@2943
    45
skamonkey@2943
    46
#define TF_STUNFLAGS_LOSERSTATE     TF_STUNFLAG_SLOWDOWN|TF_STUNFLAG_NOSOUNDOREFFECT|TF_STUNFLAG_THIRDPERSON
skamonkey@2943
    47
#define TF_STUNFLAGS_GHOSTSCARE     TF_STUNFLAG_GHOSTEFFECT|TF_STUNFLAG_THIRDPERSON
skamonkey@2943
    48
#define TF_STUNFLAGS_SMALLBONK      TF_STUNFLAG_THIRDPERSON|TF_STUNFLAG_SLOWDOWN
skamonkey@2943
    49
#define TF_STUNFLAGS_NORMALBONK     TF_STUNFLAG_BONKSTUCK
skamonkey@2943
    50
#define TF_STUNFLAGS_BIGBONK        TF_STUNFLAG_CHEERSOUND|TF_STUNFLAG_BONKSTUCK
skamonkey@2943
    51
pred@1963
    52
enum TFClassType
pred@1963
    53
{
pred@1963
    54
	TFClass_Unknown = 0,
pred@1963
    55
	TFClass_Scout,
pred@1963
    56
	TFClass_Sniper,
pred@1963
    57
	TFClass_Soldier,
pred@1963
    58
	TFClass_DemoMan,
pred@1963
    59
	TFClass_Medic,
pred@1963
    60
	TFClass_Heavy,
pred@1963
    61
	TFClass_Pyro,
pred@1963
    62
	TFClass_Spy,
pred@1963
    63
	TFClass_Engineer
pred@2018
    64
};
pred@1963
    65
pred@1963
    66
enum TFTeam
pred@1963
    67
{
pred@1963
    68
	TFTeam_Unassigned = 0,
pred@1963
    69
	TFTeam_Spectator = 1,
pred@1963
    70
	TFTeam_Red = 2,
pred@1963
    71
	TFTeam_Blue = 3	
pred@2018
    72
};
pred@1963
    73
skamonkey@2939
    74
enum TFCond
skamonkey@2939
    75
{
skamonkey@2939
    76
	TFCond_Slowed = 0,
skamonkey@2939
    77
	TFCond_Zoomed,
skamonkey@2939
    78
	TFCond_Disguising,
skamonkey@2939
    79
	TFCond_Disguised,
skamonkey@2939
    80
	TFCond_Cloaked,
skamonkey@2939
    81
	TFCond_Ubercharged,
skamonkey@2939
    82
	TFCond_TeleportedGlow,
skamonkey@2939
    83
	TFCond_Taunting,
skamonkey@2939
    84
	TFCond_UberchargeFading,
skamonkey@2939
    85
	TFCond_Unknown1,
skamonkey@2939
    86
	TFCond_Teleporting,
skamonkey@2939
    87
	TFCond_Kritzkrieged,
skamonkey@2939
    88
	TFCond_Unknown2,
skamonkey@2939
    89
	TFCond_DeadRingered,
skamonkey@2939
    90
	TFCond_Bonked,
skamonkey@2939
    91
	TFCond_Dazed,
skamonkey@2939
    92
	TFCond_Buffed,
skamonkey@2939
    93
	TFCond_Charging,
skamonkey@2939
    94
	TFCond_DemoBuff,
skamonkey@2939
    95
	TFCond_Healing,
skamonkey@2939
    96
	TFCond_OnFire,
skamonkey@2939
    97
	TFCond_Overhealed,
skamonkey@2939
    98
	TFCond_Jarated
skamonkey@2942
    99
};
skamonkey@2939
   100
fyrenmoo@2673
   101
/**
fyrenmoo@2673
   102
 * Sets a client on fire for 10 seconds.
fyrenmoo@2673
   103
 *
fyrenmoo@2673
   104
 * @param client		Player's index.
fyrenmoo@2673
   105
 * @noreturn
fyrenmoo@2673
   106
 * @error				Invalid client index, client not in game, or no mod support.
fyrenmoo@2673
   107
 */
fyrenmoo@2673
   108
native TF2_IgnitePlayer(client, target);
pred@1963
   109
pred@1963
   110
/**
pred@1963
   111
 * Respawns a client
pred@1963
   112
 *
pred@1963
   113
 * @param client		Player's index.
pred@1963
   114
 * @noreturn
pred@1963
   115
 * @error				Invalid client index, client not in game, or no mod support.
pred@1963
   116
 */
pred@1963
   117
native TF2_RespawnPlayer(client);
pred@1963
   118
pred@1963
   119
/**
skamonkey@2939
   120
 * Regenerates a client's health and ammunition
skamonkey@2939
   121
 *
skamonkey@2939
   122
 * @param client		Player's index.
skamonkey@2939
   123
 * @noreturn
skamonkey@2939
   124
 * @error				Invalid client index, client not in game, or no mod support.
skamonkey@2939
   125
 */
skamonkey@2939
   126
native TF2_RegeneratePlayer(client);
skamonkey@2939
   127
skamonkey@2939
   128
/**
skamonkey@2939
   129
 * Adds a condition to a player
skamonkey@2939
   130
 *
skamonkey@2939
   131
 * @param client		Player's index.
skamonkey@2939
   132
 * @param condition		Integer identifier of condition to apply.
skamonkey@2939
   133
 * @param duration		Duration of condition (does not apply to all conditions).
skamonkey@2939
   134
 * @noreturn
skamonkey@2939
   135
 * @error				Invalid client index, client not in game, or no mod support.
skamonkey@2939
   136
 */
skamonkey@2939
   137
native TF2_AddCondition(client, TFCond:condition, Float:duration);
skamonkey@2939
   138
skamonkey@2939
   139
/**
skamonkey@2939
   140
 * Removes a condition from a player
skamonkey@2939
   141
 *
skamonkey@2939
   142
 * @param client		Player's index.
skamonkey@2939
   143
 * @param condition		Integer identifier of condition to remove.
skamonkey@2939
   144
 * @noreturn
skamonkey@2939
   145
 * @error				Invalid client index, client not in game, or no mod support.
skamonkey@2939
   146
 */
skamonkey@2939
   147
native TF2_RemoveCondition(client, TFCond:condition);
skamonkey@2939
   148
skamonkey@2939
   149
/**
skamonkey@2939
   150
 * Enables/disables PowerPlay mode on a player.
skamonkey@2939
   151
 *
skamonkey@2939
   152
 * @param client		Player's index.
skamonkey@2939
   153
 * @param enabled		Whether to enable or disable PowerPlay on player.
skamonkey@2939
   154
 * @noreturn
skamonkey@2939
   155
 * @error				Invalid client index, client not in game, or no mod support.
skamonkey@2939
   156
 */
skamonkey@2939
   157
native TF2_SetPlayerPowerPlay(client, bool:enabled);
skamonkey@2939
   158
skamonkey@2939
   159
/**
pred@1963
   160
 * Disguises a client to the given model and team. Only has an effect on spies.
pred@1963
   161
 *
pred@1963
   162
 * Note: This only starts the disguise process and a delay occurs before the spy is fully disguised
pred@1963
   163
 *
pred@1963
   164
 * @param client		Player's index.
pred@1963
   165
 * @param team			Team to disguise the player as (only TFTeam_Red and TFTeam_Blue have an effect)
pred@1963
   166
 * @param class			TFClassType class to disguise the player as
pred@1963
   167
 * @noreturn
pred@1963
   168
 * @error				Invalid client index, client not in game, or no mod support.
pred@1963
   169
 */
pred@1963
   170
native TF2_DisguisePlayer(client, TFTeam:team, TFClassType:class);
pred@1963
   171
pred@1963
   172
/**
pred@1963
   173
 * Removes the current disguise from a client. Only has an effect on spies.
pred@1963
   174
 *
pred@1963
   175
 * @param client		Player's index.
pred@1963
   176
 * @noreturn
pred@1963
   177
 * @error				Invalid client index, client not in game, or no mod support.
pred@1963
   178
 */
pred@1963
   179
native TF2_RemovePlayerDisguise(client);
pred@1963
   180
pred@1963
   181
/**
skamonkey@2943
   182
 * Stuns a client
skamonkey@2943
   183
 *
skamonkey@2943
   184
 * @param client		Player's index.
skamonkey@2943
   185
 * @param float			Duration of stun.
skamonkey@2943
   186
 * @param float			Slowdown percent (as decimal, 0.00-1.00)
skamonkey@2943
   187
 *						(ignored if TF_STUNFLAG_SLOWDOWN is not set.
skamonkey@2943
   188
 * @param int			Stun flags.
skamonkey@2943
   189
 * @param attacker		Attacker's index (0 is allowed for world).
skamonkey@2943
   190
 * @noreturn
skamonkey@2943
   191
 */
skamonkey@2943
   192
native TF2_StunPlayer(client, Float:duration, Float:slowdown=0.0, stunflags, attacker=0);
skamonkey@2943
   193
skamonkey@2943
   194
/**
pred@1963
   195
 * Retrieves the entity index of the CPlayerResource entity
pred@1963
   196
 *
pred@1963
   197
 * @return				The current resource entity index.
pred@1963
   198
 */
pred@1963
   199
native TF2_GetResourceEntity();
pred@1963
   200
pred@1963
   201
/**
pred@1963
   202
 * Finds the TFClassType for a given class name.
pred@1963
   203
 *
pred@1963
   204
 * @param classname		A classname string such as "sniper" or "demoman"
pred@1963
   205
 * @return				A TFClassType constant.
pred@1963
   206
 */
pred@1963
   207
native TFClassType:TF2_GetClass(const String:classname[]);
pred@1963
   208
pred@1963
   209
/**
pred@1979
   210
 * Called on weapon fire to decide if the current shot should be critical.
pred@1979
   211
 * Return Plugin_Continue to let the original calculation or return a higher
pred@1979
   212
 * action to override the decision with the value of 'result'
pred@1979
   213
 *
pred@1979
   214
 * @note Since critical shots are also calculated client side any changes made with
pred@1979
   215
 *		 this will not show for the shooter. Projectile weapons such as the rocketlauncher
pred@1979
   216
 *		 and demoman weapons will show a critical bullet but no critical sound effect.
pred@1979
   217
 *		 Bullet hits should appear as expected.
pred@1979
   218
 *
pred@1979
   219
 * @param client		Client Index.
pred@1979
   220
 * @param weapon		Weapon entity Index.
pred@1979
   221
 * @param weaponname	Classname of the weapon.
pred@1979
   222
 * @param result		Buffer param for the result of the decision.
pred@1979
   223
 */
pred@1981
   224
forward Action:TF2_CalcIsAttackCritical(client, weapon, String:weaponname[], &bool:result);
pred@1979
   225
pred@1979
   226
/**
pred@1963
   227
 * Do not edit below this line!
pred@1963
   228
 */
pred@1963
   229
public Extension:__ext_tf2 = 
pred@1963
   230
{
pred@1963
   231
	name = "TF2 Tools",
pred@1963
   232
	file = "game.tf2.ext",
pred@1963
   233
	autoload = 1,
pred@1963
   234
#if defined REQUIRE_EXTENSIONS
pred@1963
   235
	required = 1,
pred@1963
   236
#else
pred@1963
   237
	required = 0,
pred@1963
   238
#endif
pred@1963
   239
};