Difference between revisions of "GetM2DAString"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
(add parameter 4 default)
Line 1: Line 1:
{{Generated with joins}}
 
 
{{dafunction
 
{{dafunction
 
|name=GetM2DAString
 
|name=GetM2DAString
Line 15: Line 14:
 
|param4name=s2DA
 
|param4name=s2DA
 
|param4desc=(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.   
 
|param4desc=(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.   
 +
|param4default = ""
 
|returntype=string
 
|returntype=string
 
|returndesc=Returns the string specified by the parameters. Returns an empty string on error.
 
|returndesc=Returns the string specified by the parameters. Returns an empty string on error.

Revision as of 22:43, 30 July 2009

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.