Difference between revisions of "GetTlkTableString"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
(looks fine, remove tag. Also clarify what "gender" means here)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=GetTlkTableString
 
|name=GetTlkTableString
Line 6: Line 5:
 
|param1name=nStrRef
 
|param1name=nStrRef
 
|param1desc=The string reference to get from the tlk table
 
|param1desc=The string reference to get from the tlk table
 +
|param1default=
 
|param2type=int
 
|param2type=int
 
|param2name=nGender
 
|param2name=nGender
 
|param2desc=The gender variation of the string
 
|param2desc=The gender variation of the string
 +
|param2default=GENDER_MALE
 
|returntype=string
 
|returntype=string
 
|returndesc=Returns the string specified by the string reference. Returns an empty string on error.
 
|returndesc=Returns the string specified by the string reference. Returns an empty string on error.
Line 17: Line 18:
 
== Description ==
 
== Description ==
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
Returns a string from the tlk table based on the specified
+
Returns a string from the tlk table based on the specified strref (String reference) and gender. It should be noted that there may be multiple genders in the tlk table depending on how the specific tlk table is generated.
strref (String reference) and gender. It should be noted
+
 
that there may be multiple genders in the tlk table depending
+
"Gender" in this case refers to grammatical gender. For most of the lines of dialogue in the game plot flags are used to choose between different lines referring to the player, so this does not actually come up much.
on how the specific tlk table is generated.
+
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->

Latest revision as of 23:13, 11 February 2010

Returns a string from the tlk table.

string GetTlkTableString(
int nStrRef,
int nGender = GENDER_MALE
);
Parameters:
nStrRef
The string reference to get from the tlk table
nGender
The gender variation of the string
Returns:

Returns the string specified by the string reference. Returns an empty string on error.

Source:

script.ldf

Description

Returns a string from the tlk table based on the specified strref (String reference) and gender. It should be noted that there may be multiple genders in the tlk table depending on how the specific tlk table is generated.

"Gender" in this case refers to grammatical gender. For most of the lines of dialogue in the game plot flags are used to choose between different lines referring to the player, so this does not actually come up much.