lang · SourceMod Scripting API Reference

/**
 * vim: set ts=4 :
 * =============================================================================
 * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
 * =============================================================================
 *
 * This file is part of the SourceMod/SourcePawn SDK.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, version 3.0, as published by the
 * Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * As a special exception, AlliedModders LLC gives you permission to link the
 * code of this program (as well as its derivative works) to "Half-Life 2," the
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
 * by the Valve Corporation.  You must obey the GNU General Public License in
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
 * this exception to all derivative works.  AlliedModders LLC defines further
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
 * or <http://www.sourcemod.net/license.php>.
 *
 * Version: $Id$
 */

#if defined _lang_included
 #endinput
#endif
#define _lang_included

#define LANG_SERVER 0      /**< Translate using the server's language */

/**
 * Loads a translation file for the plugin calling this native.
 * If no extension is specified, .txt is assumed.
 *
 * @param file          Translation file.
 */
native void LoadTranslations(const char[] file);

/**
 * Sets the global language target.  This is useful for creating functions
 * that will be compatible with the %t format specifier.  Note that invalid
 * indexes can be specified but the error will occur during translation,
 * not during this function call.
 *
 * @param client        Client index or LANG_SERVER.
 */
native void SetGlobalTransTarget(int client);

/**
 * Retrieves the language number of a client.
 *
 * @param client        Client index.
 * @return              Language number client is using.
 * @error               Invalid client index or client not connected.
 */
native int GetClientLanguage(int client);

/**
 * Retrieves the server's language.
 *
 * @return              Language number server is using.
 */
native int GetServerLanguage();

/**
 * Returns the number of languages known in languages.cfg.
 *
 * @return              Language count.
 */
native int GetLanguageCount();

/**
 * Retrieves info about a given language number.
 *
 * @param language      Language number.
 * @param code          Language code buffer (2-3 characters usually).
 * @param codeLen       Maximum length of the language code buffer.
 * @param name          Language name buffer.
 * @param nameLen       Maximum length of the language name buffer.
 * @error               Invalid language number.
 */
native void GetLanguageInfo(int language, char[] code="", int codeLen=0, char[] name="", int nameLen=0);

/**
 * Sets the language number of a client.
 *
 * @param client        Client index.
 * @param language      Language number.
 * @error               Invalid client index or client not connected.
 */
native void SetClientLanguage(int client, int language);

/**
 * Retrieves the language number a client had when they connected.
 *
 * @param client        Client index.
 * @return              Language number client originally had.
 * @error               Invalid client index or client not connected.
 */
native int GetClientOriginalLanguage(int client);

/**
 * Retrieves the language number from a language code.
 *
 * @param code          Language code (2-3 characters usually).
 * @return              Language number. -1 if not found.
 */
native int GetLanguageByCode(const char[] code);

/**
 * Retrieves the language number from a language name.
 *
 * @param name          Language name (case insensitive).
 * @return              Language number. -1 if not found.
 */
native int GetLanguageByName(const char[] name);

/**
 * Determines if the specified phrase exists within the plugin's
 * translation cache.
 *
 * @param phrase        Phrase to look for.
 * @return              True if phrase exists.
 */
native bool TranslationPhraseExists(const char[] phrase);

/**
 * Determines if there is a translation for the specified language.
 *
 * @param phrase        Phrase to check.
 * @param language      Language number.
 * @return              True if translation exists.
 */
native bool IsTranslatedForLanguage(const char[] phrase, int language);
lang.inc
