Difference between revisions of "GetM2DAString"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (checked)
m (Correcting group)
 
(2 intermediate revisions by 2 users not shown)
Line 28: Line 28:
 
Returns a 2DA string based on the specified Row and Column values.
 
Returns a 2DA string based on the specified Row and Column values.
  
<!-- == Remarks == -->
+
== Remarks ==
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 +
Note that nRow is the value in the ID field of the row you wish to access.
  
 
<!-- == Examples == -->
 
<!-- == Examples == -->
Line 37: Line 38:
 
<!-- This section contains links to articles, functions or constant groups. -->
 
<!-- This section contains links to articles, functions or constant groups. -->
  
[[Category: Action & system functions]]
+
[[Category:Data functions]]

Latest revision as of 23:43, 4 March 2014

Returns a value from a 2DA in string format.

string GetM2DAString(
int n2DA,
string sColumn,
int nRow,
string s2DA = ""
);
Parameters:
n2DA
The 2DA to access
sColumn
The name of the column to access
nRow
The 0 based index of the row to access
s2DA
(optional) if n2da is -1 and this is a valid resource, it will retrieve the 2da based on the name instead of the index. Note that this should be avoided when possible.
Returns:

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

Source:

script.ldf

Description

Returns a 2DA string based on the specified Row and Column values.

Remarks

Note that nRow is the value in the ID field of the row you wish to access.