plugins/include/sdktools_voice.inc
author Scott Ehlert <ds@alliedmods.net>
Thu Apr 24 10:25:44 2008 +0000 (2008-04-24)
changeset 2023 1bd756a9f8db
parent 1952 b7aa2b626807
child 2289 44045ead61cd
permissions -rw-r--r--
Added any tag to ADT array functions to fix potential tag mismatches
ds@1952
     1
/**
ds@1952
     2
 * vim: set ts=4 :
ds@1952
     3
 * =============================================================================
ds@1952
     4
 * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
ds@1952
     5
 * =============================================================================
ds@1952
     6
 *
ds@1952
     7
 * This file is part of the SourceMod/SourcePawn SDK.
ds@1952
     8
 *
ds@1952
     9
 * This program is free software; you can redistribute it and/or modify it under
ds@1952
    10
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1952
    11
 * Free Software Foundation.
ds@1952
    12
 * 
ds@1952
    13
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1952
    14
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1952
    15
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1952
    16
 * details.
ds@1952
    17
 *
ds@1952
    18
 * You should have received a copy of the GNU General Public License along with
ds@1952
    19
 * this program.  If not, see <http://www.gnu.org/licenses/>.
ds@1952
    20
 *
ds@1952
    21
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1952
    22
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1952
    23
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1952
    24
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1952
    25
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1952
    26
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1952
    27
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1952
    28
 * or <http://www.sourcemod.net/license.php>.
ds@1952
    29
 *
ds@1952
    30
 * Version: $Id$
ds@1952
    31
 */
ds@1952
    32
ds@1952
    33
#if defined _sdktools_voice_included
ds@1952
    34
  #endinput
ds@1952
    35
#endif
ds@1952
    36
#define _sdktools_voice_included
ds@1952
    37
ds@1952
    38
/**
ds@1952
    39
 * @section voice flags.
ds@1952
    40
 */
ds@1952
    41
#define VOICE_NORMAL		0	/**< Allow the client to listen and speak normally. */
ds@1952
    42
#define VOICE_MUTED		1	/**< Mutes the client from speaking to everyone. */
ds@1952
    43
#define VOICE_SPEAKALL		2	/**< Allow the client to speak to everyone. */
ds@1952
    44
#define VOICE_LISTENALL		4	/**< Allow the client to listen to everyone. */
ds@1952
    45
#define VOICE_TEAM		8	/**< Allow the client to always speak to team, even when dead. */
ds@1952
    46
#define VOICE_LISTENTEAM	16	/**< Allow the client to always hear teammates, including dead ones. */
ds@1952
    47
 
ds@1952
    48
/**
ds@1952
    49
 * @endsection
ds@1952
    50
 */
ds@1952
    51
ds@1952
    52
/**
ds@1952
    53
 * Set the client listening flags.
ds@1952
    54
 *
ds@1952
    55
 * @param client		The client index
ds@1952
    56
 * @param flags		The voice flags
ds@1952
    57
 * @noreturn
ds@1952
    58
 */
ds@1952
    59
native SetClientListeningFlags(client, flags);
ds@1952
    60
ds@1952
    61
/**
ds@1952
    62
 * Retrieve the client current listening flags.
ds@1952
    63
 *
ds@1952
    64
 * @param client		The client index
ds@1952
    65
 * @return			The current voice flags
ds@1952
    66
 */
ds@1952
    67
native GetClientListeningFlags(client);
ds@1952
    68
ds@1952
    69
/**
ds@1952
    70
 * Set the receiver ability to listen to the sender.
ds@1952
    71
 *
ds@1952
    72
 * @param iReceiver		The listener index.
ds@1952
    73
 * @param iSender		The sender index.
ds@1952
    74
 * @return			True if successful otherwise false.
ds@1952
    75
 */
ds@1952
    76
native bool:SetClientListening(iReceiver, iSender, bool:bListen);
ds@1952
    77
ds@1952
    78
/**
ds@1952
    79
 * Retrieves if the receiver can listen to the sender.
ds@1952
    80
 *
ds@1952
    81
 * @param iReceiver		The listener index.
ds@1952
    82
 * @param iSender		The sender index.
ds@1952
    83
 * @return			True if successful otherwise false.
ds@1952
    84
 */
ds@1952
    85
native bool:GetClientListening(iReceiver, iSender);