Public Member Functions

SourceMod::IPhraseFile Class Reference

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

#include <public/ITranslator.h>

List of all members.

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.
virtual const char * GetFilename ()=0
 Returns the file name of this translation file.

Detailed Description

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

Definition at line 92 of file ITranslator.h.


Member Function Documentation

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:
szPhrase String containing the phrase name.
lang_id Language ID.
pTrans Buffer to store translation info.
Returns:
Translation error code indicating success (pTrans is filled) or failure (pTrans contents is undefined).
virtual const char* SourceMod::IPhraseFile::GetFilename (  )  [pure virtual]

Returns the file name of this translation file.

Returns:
File name.

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