Difference between revisions of "GetM2DAString"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (add parameter 4 default) |
m (Correcting group) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 5: | Line 5: | ||
|param1name=n2DA | |param1name=n2DA | ||
|param1desc=The 2DA to access | |param1desc=The 2DA to access | ||
| + | |param1default= | ||
|param2type=string | |param2type=string | ||
|param2name=sColumn | |param2name=sColumn | ||
|param2desc=The name of the column to access | |param2desc=The name of the column to access | ||
| + | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nRow | |param3name=nRow | ||
|param3desc=The 0 based index of the row to access | |param3desc=The 0 based index of the row to access | ||
| + | |param3default= | ||
|param4type=string | |param4type=string | ||
|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 = "" | + | |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. | ||
| Line 25: | 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 == | |
<!-- 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 34: | Line 38: | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | [[Category: | + | [[Category:Data functions]] |
Latest revision as of 23:43, 4 March 2014
Returns a value from a 2DA in string format.
- 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.
