ITranslator.h File Reference

Defines interfaces related to translation files. More...

#include <IShareSys.h>

Go to the source code of this file.

Classes
struct	SourceMod::Translation
	Contains information about a translation phrase. More...
class	SourceMod::IPhraseFile
	Represents a phrase file from SourceMod's "translations" folder. More...
class	SourceMod::IPhraseCollection
class	SourceMod::ITranslator
	Provides functions for translation. More...

Macros
#define	SMINTERFACE_TRANSLATOR_NAME   "ITranslator"
#define	SMINTERFACE_TRANSLATOR_VERSION   4
#define	MAX_TRANSLATE_PARAMS   32
#define	CORELANG_ENGLISH   0
#define	SOURCEMOD_LANGUAGE_ENGLISH   0
	SourceMod hardcodes the English language (default) to ID 0. This cannot be changed and languages.cfg should never have it as anything other than the first index.
#define	SOURCEMOD_SERVER_LANGUAGE   0
	For T formats, specifies that the language should be that of the server and not a specific client.

Enumerations
enum	TransError {   SourceMod::Trans_Okay = 0, SourceMod::Trans_BadLanguage = 1, SourceMod::Trans_BadPhrase = 2, SourceMod::Trans_BadPhraseLanguage = 3,   SourceMod::Trans_BadPhraseFile = 4 }
	Translation error codes.

Detailed Description

Defines interfaces related to translation files.

Macro Definition Documentation

#define SMINTERFACE_TRANSLATOR_NAME   "ITranslator"

vim: set ts=4 :

SourceMod

Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.

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$