plugins/include/lang.inc
author David Anderson <dvander@alliedmods.net>
Wed Jul 16 03:46:10 2008 +0000 (2008-07-16)
changeset 2211 be9f9063b727
parent 1952 b7aa2b626807
child 2289 44045ead61cd
permissions -rw-r--r--
Fixed a bug where natives with no owner could be bound (crashing).
Fixed a bug where FakeNative entries were leaked.
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 _lang_included
ds@1952
    34
 #endinput
ds@1952
    35
#endif
ds@1952
    36
#define _lang_included
ds@1952
    37
ds@1952
    38
#define LANG_SERVER		0		/**< Translate using the server's language */
ds@1952
    39
ds@1952
    40
/**
ds@1952
    41
 * Loads a translation file for the plugin calling this native.
ds@1952
    42
 * If no extension is specified, .txt is assumed.
ds@1952
    43
 *
ds@1952
    44
 * @param path		Translation file.
ds@1952
    45
 * @noreturn
ds@1952
    46
 */
ds@1952
    47
native LoadTranslations(const String:file[]);
ds@1952
    48
ds@1952
    49
/**
ds@1952
    50
 * Sets the global language target.  This is useful for creating functions
ds@1952
    51
 * that will be compatible with the %t format specifier.  Note that invalid
ds@1952
    52
 * indexes can be specified but the error will occur during translation,
ds@1952
    53
 * not during this function call.
ds@1952
    54
 *
ds@1952
    55
 * @param client	Client index or LANG_SERVER.
ds@1952
    56
 * @noreturn
ds@1952
    57
 */
ds@1952
    58
native SetGlobalTransTarget(client);
ds@1952
    59
ds@1952
    60
/**
ds@1952
    61
 * Retrieves the language number of a client.
ds@1952
    62
 * Currently this simply returns the server language index.
ds@1952
    63
 *
ds@1952
    64
 * @param client	Client index.
ds@1952
    65
 * @return			Language number client is using.
ds@1952
    66
 * @error			Invalid client index or client not in game.
ds@1952
    67
 */
ds@1952
    68
native GetClientLanguage(client);
ds@1952
    69
ds@1952
    70
/**
ds@1952
    71
 * Retrieves the server's language.
ds@1952
    72
 *
ds@1952
    73
 * @return			Language number server is using.
ds@1952
    74
 */
ds@1952
    75
native GetServerLanguage();
ds@1952
    76
ds@1952
    77
/**
ds@1952
    78
 * Returns the number of languages known in languages.cfg.
ds@1952
    79
 *
ds@1952
    80
 * @return			Language count.
ds@1952
    81
 */
ds@1952
    82
native GetLanguageCount();
ds@1952
    83
ds@1952
    84
/**
ds@1952
    85
 * Retrieves info about a given language number.
ds@1952
    86
 *
ds@1952
    87
 * @param language	Language number.
ds@1952
    88
 * @param code		Language code buffer (2-3 characters usually).
ds@1952
    89
 * @param codeLen	Maximum length of the language code buffer.
ds@1952
    90
 * @param name		Language name buffer.
ds@1952
    91
 * @param nameLen	Maximum length of the language name buffer.
ds@1952
    92
 * @noreturn
ds@1952
    93
 * @error			Invalid language number.
ds@1952
    94
 */
ds@1952
    95
native GetLanguageInfo(language, String:code[]="", codeLen=0, String:name[]="", nameLen=0);
ds@1952
    96