plugins/include/sdktools_sound.inc
changeset 1733 61f9b414c2d1
parent 1330 ab94316bb52b
child 1735 d6966e3316e9
     1.1 --- a/plugins/include/sdktools_sound.inc	Wed Nov 28 16:00:18 2007 +0000
     1.2 +++ b/plugins/include/sdktools_sound.inc	Fri Nov 30 15:50:32 2007 +0000
     1.3 @@ -124,7 +124,7 @@
     1.4  /**
     1.5   * Prefetches a sound.
     1.6   *
     1.7 - * @param name		Sound file name.
     1.8 + * @param name		Sound file name relative to the "sounds" folder.
     1.9   * @noreturn
    1.10   */
    1.11  native PrefetchSound(const String:nane[]);
    1.12 @@ -132,7 +132,7 @@
    1.13  /**
    1.14   * Gets a sound's duration (does not work for mp3s).
    1.15   *
    1.16 - * @param name		Sound file name.
    1.17 + * @param name		Sound file name relative to the "sounds" folder.
    1.18   * @return			Duration in seconds.
    1.19   */
    1.20  native Float:GetSoundDuration(const String:name[]);
    1.21 @@ -140,9 +140,9 @@
    1.22  /**
    1.23   * Emits an ambient sound.
    1.24   *
    1.25 - * @param entity	Entity index to associate sound with.
    1.26 + * @param name		Sound file name relative to the "sounds" folder.
    1.27   * @param pos		Origin of sound.
    1.28 - * @param name		Sound file name.
    1.29 + * @param entity	Entity index to associate sound with.
    1.30   * @param level		Sound level (from 0 to 255).
    1.31   * @param flags		Sound flags.
    1.32   * @param vol		Volume (from 0.0 to 1.0).
    1.33 @@ -177,7 +177,7 @@
    1.34   *
    1.35   * @param entity	Entity index.
    1.36   * @param channel	Channel number.
    1.37 - * @param name		Sound name.
    1.38 + * @param name		Sound file name relative to the "sounds" folder.
    1.39   * @noreturn
    1.40   */
    1.41  native StopSound(entity, channel, const String:name[]);
    1.42 @@ -187,9 +187,9 @@
    1.43   *
    1.44   * @param clients		Array of client indexes.
    1.45   * @param numClients	Number of clients in the array.
    1.46 + * @param sample		Sound file name relative to the "sounds" folder.
    1.47   * @param entity		Entity to emit from.
    1.48   * @param channel		Channel to emit with.
    1.49 - * @param sample		Sound name.
    1.50   * @param level			Sound level.
    1.51   * @param flags			Sound flags.
    1.52   * @param volume		Sound volume.
    1.53 @@ -224,9 +224,9 @@
    1.54   *
    1.55   * @param clients		Array of client indexes.
    1.56   * @param numClients	Number of clients in the array.
    1.57 + * @param sentence		Sentence index (from PrecacheSenteFile).
    1.58   * @param entity		Entity to emit from.
    1.59   * @param channel		Channel to emit with.
    1.60 - * @param sentence		Sentence index (from PrecacheSenteFile).
    1.61   * @param level			Sound level.
    1.62   * @param flags			Sound flags.
    1.63   * @param volume		Sound volume.
    1.64 @@ -261,9 +261,9 @@
    1.65   * Wrapper to emit sound to one client.
    1.66   *
    1.67   * @param client		Client index.
    1.68 + * @param sample		Sound file name relative to the "sounds" folder.
    1.69   * @param entity		Entity to emit from.
    1.70   * @param channel		Channel to emit with.
    1.71 - * @param sample		Sound name.
    1.72   * @param level			Sound level.
    1.73   * @param flags			Sound flags.
    1.74   * @param volume		Sound volume.
    1.75 @@ -302,9 +302,9 @@
    1.76  /**
    1.77   * Wrapper to emit sound to all clients.
    1.78   *
    1.79 + * @param sample		Sound file name relative to the "sounds" folder.
    1.80   * @param entity		Entity to emit from.
    1.81   * @param channel		Channel to emit with.
    1.82 - * @param sample		Sound name.
    1.83   * @param level			Sound level.
    1.84   * @param flags			Sound flags.
    1.85   * @param volume		Sound volume.