Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Static Public Member Functions | List of all members
Lingoona.Grammar Class Reference

Static Public Member Functions

static void clearVariable (string name)
 Deletes a named variable. More...
 
static void clearVariables ()
 Deletes all named variables. More...
 
static string generateName (string noun, List< string > components)
 Composes a new name from a given noun and an individual amount of additional suffixes. More...
 
static string getLanguage ()
 Retrieve the Grammar Library's current language code. More...
 
static void setLanguage (string language)
 Set the Grammar Library's language to be used. More...
 
static void setVariable (string name, string value)
 Sets a named variable. More...
 
static string useGrammar (string template, List< string > parameters)
 Parses a string using the Grammar Library and returns the finalized text. More...
 
static string useGrammar (string template)
 Parses a string using the Grammar Library and returns the finalized text. More...
 

Member Function Documentation

static void Lingoona.Grammar.clearVariable ( string  name)
inlinestatic

Deletes a named variable.

Parameters
nameThe name of the variable. Must consist of alphanumerical characters only and start with a letter.
static void Lingoona.Grammar.clearVariables ( )
inlinestatic

Deletes all named variables.

static string Lingoona.Grammar.generateName ( string  noun,
List< string >  components 
)
inlinestatic

Composes a new name from a given noun and an individual amount of additional suffixes.

Parameters
nounThe tagged noun to be used, e.g. "sword^n".
componentsThe actual suffixes, each individual one might be tagged to describe the actual use, e.g. "strong^a".
Returns
The finalized, generated name, including gender tags.
static string Lingoona.Grammar.getLanguage ( )
inlinestatic

Retrieve the Grammar Library's current language code.

Returns
A 2 character language code, e.g. "en", "de", or "fr".
static void Lingoona.Grammar.setLanguage ( string  language)
inlinestatic

Set the Grammar Library's language to be used.

Parameters
languageA 2 character language code, e.g. "en", "de", or "fr".

The available languages depend on your license agreement. Invalid values will fall back to English ("en").

static void Lingoona.Grammar.setVariable ( string  name,
string  value 
)
inlinestatic

Sets a named variable.

Parameters
nameThe name of the variable. Must consist of alphanumerical characters only and start with a letter.
valueThe value of the variable.
static string Lingoona.Grammar.useGrammar ( string  template,
List< string >  parameters 
)
inlinestatic

Parses a string using the Grammar Library and returns the finalized text.

Parameters
templateThe template string to be parsed, e.g. "Greetings, <<1>>!".
parametersThe actual parameters, each individual one might be tagged based on their gender, e.g. "dog^n".
Returns
The finalized, generated string.
static string Lingoona.Grammar.useGrammar ( string  template)
inlinestatic

Parses a string using the Grammar Library and returns the finalized text.

Parameters
templateThe template string to be parsed, e.g. "Greetings, <<1>>!".
Returns
The finalized, generated string.

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