plugins/include/sdktools_functions.inc
changeset 1611 1bd18b7530eb
parent 1504 312c2e8934b1
child 1612 6a4c932c1cf6
     1.1 --- a/plugins/include/sdktools_functions.inc	Fri Oct 19 06:51:44 2007 +0000
     1.2 +++ b/plugins/include/sdktools_functions.inc	Fri Oct 19 08:51:05 2007 +0000
     1.3 @@ -137,16 +137,16 @@
     1.4   *
     1.5   * @param client		Player's index.
     1.6   * @param ang			Destination vector to store the client's eye angles.
     1.7 - * @noreturn
     1.8 + * @return				True on success, false on failure.
     1.9   * @error				Invalid client index, client not in game, or no mod support.
    1.10   */
    1.11 -native GetClientEyeAngles(client, Float:ang[3]);
    1.12 +native bool:GetClientEyeAngles(client, Float:ang[3]);
    1.13  
    1.14  /**
    1.15   * Returns if the client is alive or dead.
    1.16   *
    1.17   * @param client		Player's index.
    1.18 - * @return			True if the client is alive, false otherwise.
    1.19 + * @return				True if the client is alive, false otherwise.
    1.20   * @error				Invalid client index, client not in game, or no mod support.
    1.21   */
    1.22  native bool:IsPlayerAlive(client);
    1.23 @@ -156,10 +156,10 @@
    1.24   * If ForceEdictIndex is not -1, then it will use the edict by that index. If the index is 
    1.25   *  invalid or there is already an edict using that index, it will error out.
    1.26   *
    1.27 - * @param classname		Entity classname.
    1.28 + * @param classname			Entity classname.
    1.29   * @param ForceEdictIndex	Edict index used by the created entity.
    1.30 - * @return			Entity index on success, or -1 on failure.
    1.31 - * @error			Invalid edict index, or no mod support.
    1.32 + * @return					Entity index on success, or -1 on failure.
    1.33 + * @error					Invalid edict index, or no mod support.
    1.34   */
    1.35  native CreateEntityByName(const String:classname[], ForceEdictIndex=-1);
    1.36  
    1.37 @@ -167,8 +167,8 @@
    1.38   * Spawns an entity into the game.
    1.39   *
    1.40   * @param entity		Entity index of the created entity.
    1.41 - * @return			True on success, false otherwise.
    1.42 - * @error			Invalid entity index, or no mod support.
    1.43 + * @return				True on success, false otherwise.
    1.44 + * @error				Invalid entity index, or no mod support.
    1.45   */
    1.46  native bool:DispatchSpawn(entity);
    1.47  
    1.48 @@ -178,8 +178,8 @@
    1.49   * @param entity		Destination entity index.
    1.50   * @param keyName		Name of the key.
    1.51   * @param value			String value.
    1.52 - * @return			True on success, false otherwise.
    1.53 - * @error			Invalid entity index, or no mod support.
    1.54 + * @return				True on success, false otherwise.
    1.55 + * @error				Invalid entity index, or no mod support.
    1.56   */
    1.57  native bool:DispatchKeyValue(entity, const String:keyName[], const String:value[]);
    1.58  
    1.59 @@ -189,8 +189,8 @@
    1.60   * @param entity		Destination entity index.
    1.61   * @param keyName		Name of the key.
    1.62   * @param value			Floating point value.
    1.63 - * @return			True on success, false otherwise.
    1.64 - * @error			Invalid entity index, or no mod support.
    1.65 + * @return				True on success, false otherwise.
    1.66 + * @error				Invalid entity index, or no mod support.
    1.67   */
    1.68  native bool:DispatchKeyValueFloat(entity, const String:keyName[], Float:value);
    1.69  
    1.70 @@ -200,12 +200,24 @@
    1.71   * @param entity		Destination entity index.
    1.72   * @param keyName		Name of the key.
    1.73   * @param vec			Vector value.
    1.74 - * @return			True on success, false otherwise.
    1.75 - * @error			Invalid entity index, or no mod support.
    1.76 + * @return				True on success, false otherwise.
    1.77 + * @error				Invalid entity index, or no mod support.
    1.78   */
    1.79  native bool:DispatchKeyValueVector(entity, const String:keyName[], const Float:vector[3]);
    1.80  
    1.81  /**
    1.82 + * Returns the entity a client is aiming at.
    1.83 + *
    1.84 + * @param client		Client performing the aiming.
    1.85 + * @param only_clients	True to exclude all entities but clients.
    1.86 + * @return				Entity index being aimed at.
    1.87 + *						-1 if no entity is being aimed at.
    1.88 + * 						-2 if the function is not supported.
    1.89 + * @error				Invalid client index.
    1.90 + */
    1.91 +native GetClientAimTarget(client, bool:only_clients=true);
    1.92 +
    1.93 +/**
    1.94   * @deprecated
    1.95   */
    1.96  #pragma deprecated Use IgniteEntity() instead