plugins/include/sdktools_functions.inc
author Phong Dang <teame06@gmail.com>
Wed Aug 01 04:17:36 2007 +0000 (2007-08-01)
changeset 1235 88bb46f9731e
parent 1219 6f440a361fa7
child 1239 eed86aca8fae
permissions -rw-r--r--
Implemented requested amb603. Added voice natives.
dvander@954
     1
/**
dvander@954
     2
 * vim: set ts=4 :
dvander@954
     3
 * ===============================================================
dvander@954
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@954
     5
 * ===============================================================
dvander@954
     6
 *
dvander@954
     7
 *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be used 
dvander@954
     8
 * or modified under the Terms and Conditions of its License Agreement, which is found 
dvander@954
     9
 * in LICENSE.txt.  The Terms and Conditions for making SourceMod extensions/plugins 
dvander@954
    10
 * may change at any time.  To view the latest information, see:
dvander@954
    11
 *   http://www.sourcemod.net/license.php
dvander@954
    12
 *
dvander@954
    13
 * Version: $Id$
dvander@954
    14
 */
dvander@954
    15
dvander@954
    16
#if defined _sdktools_functions_included
dvander@954
    17
  #endinput
dvander@954
    18
#endif
dvander@954
    19
#define _sdktools_functions_included
dvander@954
    20
dvander@954
    21
/**
dvander@954
    22
 * Removes a player's item.
dvander@954
    23
 *
dvander@954
    24
 * @param client		Client index.
dvander@954
    25
 * @param item			CBaseCombatWeapon entity index.
dvander@954
    26
 * @return				True on success, false otherwise.
dvander@954
    27
 * @error				Invalid client or entity, lack of mod support, or client not in 
dvander@954
    28
 *						game.
dvander@954
    29
 */
dvander@954
    30
native bool:RemovePlayerItem(client, item);
dvander@954
    31
dvander@954
    32
/**
dvander@954
    33
 * Gives a named item to a player.
dvander@954
    34
 *
dvander@954
    35
 * @param client		Client index.
dvander@954
    36
 * @param item			Item classname (such as weapon_ak47).
dvander@954
    37
 * @param iSubType		Unknown.
dvander@954
    38
 * @return				Entity index on success, or -1 on failure.
dvander@954
    39
 * @error				Invalid client or client not in game, or lack of mod support.
dvander@954
    40
 */
dvander@954
    41
native GivePlayerItem(client, const String:item[], iSubType=0);
dvander@954
    42
dvander@954
    43
/**
dvander@954
    44
 * Returns the weapon in a player's slot.  
dvander@954
    45
 *
dvander@954
    46
 * @param client		Client index.
dvander@954
    47
 * @param slot			Slot index (mod specific).
dvander@954
    48
 * @return				Entity index on success, -1 if no weapon existed.
dvander@955
    49
 * @error				Invalid client or client not in game, or lack of mod support.
dvander@955
    50
 */
dvander@955
    51
native GetPlayerWeaponSlot(client, slot);
dvander@955
    52
dvander@955
    53
/**
dvander@980
    54
 * Ignites an entity on fire.
dvander@955
    55
 *
dvander@980
    56
 * @param entity		Entity index.
dvander@955
    57
 * @param time			Number of seconds to set on fire.
dvander@955
    58
 * @param npc			True to only affect NPCs.
dvander@955
    59
 * @param size			Unknown.
dvander@955
    60
 * @param level			Unknown.
dvander@955
    61
 * @noreturn
dvander@980
    62
 * @error				Invalid entity or client not in game, or lack of mod support.
dvander@954
    63
 */
dvander@980
    64
native IgniteEntity(entity, Float:time, bool:npc=false, Float:size=0.0, bool:level=false);
dvander@955
    65
dvander@955
    66
/**
dvander@955
    67
 * Extinguishes a player that is on fire.
dvander@955
    68
 *
dvander@980
    69
 * @param entity		Entity index.
dvander@955
    70
 * @noreturn
dvander@980
    71
 * @error				Invalid entity or client not in game, or lack of mod support.
dvander@955
    72
 */
dvander@980
    73
native ExtinguishEntity(client);
dvander@955
    74
dvander@955
    75
/**
dvander@980
    76
 * Teleports an entity.
dvander@955
    77
 *
dvander@980
    78
 * @param entity		Client index.
dvander@955
    79
 * @param origin		New origin, or NULL_VECTOR for no change.
dvander@955
    80
 * @param angles		New angles, or NULL_VECTOR for no change.
dvander@955
    81
 * @param velocity		New velocity, or NULL_VECTOR for no change.
dvander@955
    82
 * @noreturn
dvander@980
    83
 * @error				Invalid entity or client not in game, or lack of mod support.
dvander@980
    84
 */
dvander@980
    85
native TeleportEntity(entity, const Float:origin[3], const Float:angles[3], const Float:velocity[3]);
dvander@980
    86
dvander@980
    87
/**
dvander@1151
    88
 * Forces a player to commit suicide.
dvander@1151
    89
 *
dvander@1151
    90
 * @param client		Client index.
dvander@1151
    91
 * @noreturn
dvander@1169
    92
 * @error				Invalid client or client not in game, or lack of mod support.
dvander@1151
    93
 */
dvander@1151
    94
native ForcePlayerSuicide(client);
dvander@1151
    95
dvander@1151
    96
/**
dvander@1169
    97
 * Slaps a player in a random direction.
dvander@1169
    98
 *
dvander@1169
    99
 * @param client		Client index.
dvander@1169
   100
 * @param health		Health to subtract.
dvander@1169
   101
 * @param sound			False to disable the sound effects.
dvander@1169
   102
 * @noreturn
dvander@1169
   103
 * @error				Invalid client or client not in game, or lack of mod support.
dvander@1169
   104
 */
dvander@1169
   105
native SlapPlayer(client, health=5, bool:sound=true);
dvander@1169
   106
dvander@1169
   107
/**
faluco@1219
   108
 * Returns the client's eye angles.
faluco@1219
   109
 *
faluco@1219
   110
 * @param client		Player's index.
faluco@1219
   111
 * @param ang			Destination vector to store the client's eye angles.
faluco@1219
   112
 * @noreturn
faluco@1219
   113
 * @error				Invalid client index, client not in game, or no mod support.
faluco@1219
   114
 */
faluco@1219
   115
native GetClientEyeAngles(client, Float:ang[3]);
faluco@1219
   116
faluco@1219
   117
/**
dvander@980
   118
 * @deprecated
dvander@955
   119
 */
dvander@980
   120
stock IgnitePlayer(client, Float:time, bool:npc=false, Float:size=0.0, bool:level=false)
dvander@980
   121
{
dvander@980
   122
	return IgniteEntity(client, time, npc, size, level);
dvander@980
   123
}
dvander@980
   124
dvander@980
   125
/**
dvander@980
   126
 * @deprecated
dvander@980
   127
 */
dvander@980
   128
stock ExtinguishClient(client)
dvander@980
   129
{
dvander@980
   130
	return ExtinguishEntity(client);
dvander@980
   131
}
dvander@980
   132
dvander@980
   133
/**
dvander@980
   134
 * @deprecated
dvander@980
   135
 */
dvander@980
   136
stock TeleportPlayer(client, const Float:origin[3], const Float:angles[3], const Float:velocity[3])
dvander@980
   137
{
dvander@980
   138
	return TeleportEntity(client, origin, angles, velocity);
dvander@980
   139
}