SourceMod SDK  1.7
SourceMod::IPhraseFile Class Referenceabstract

Represents a phrase file from SourceMod's "translations" folder. More...

#include <public/ITranslator.h>

Public Member Functions

virtual TransError GetTranslation (const char *szPhrase, unsigned int lang_id, Translation *pTrans)=0
 Attempts to find a translation phrase in a phrase file. More...
 
virtual const char * GetFilename ()=0
 Returns the file name of this translation file. More...
 

Detailed Description

Represents a phrase file from SourceMod's "translations" folder.

Member Function Documentation

virtual const char* SourceMod::IPhraseFile::GetFilename ( )
pure virtual

Returns the file name of this translation file.

Returns
File name.
virtual TransError SourceMod::IPhraseFile::GetTranslation ( const char *  szPhrase,
unsigned int  lang_id,
Translation pTrans 
)
pure virtual

Attempts to find a translation phrase in a phrase file.

Parameters
szPhraseString containing the phrase name.
lang_idLanguage ID.
pTransBuffer to store translation info.
Returns
Translation error code indicating success (pTrans is filled) or failure (pTrans contents is undefined).

The documentation for this class was generated from the following file: