GetM2DAString

From Dragon Age Toolset Wiki
Revision as of 02:40, 29 July 2009 by Sunjammer (Talk | contribs) (Generated by Sunjammer's Dragon Age Script Paser)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was able to extract and/or match all the information required, however it has flagged this page as containing one or more joins. A join occurs when the parser encounters a single line entry (such as parameter descriptions or remarks) which has been split over multiple lines. The parser joins these lines together to prevent the information being omitted, however any original formatting will have been lost.

This page must be reviewed by a knowledgeable scripter as it will probably require updating. If the join occurred in a parameter description it will probably be necessary to move the additional information to the Description section below. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with joins}} tag once the page has been corrected.

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.