Difference between revisions of "GetM2DAInt"
BryanDerksen (Talk | contribs) (add parameter 4 default) |
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
||
| Line 1: | Line 1: | ||
| + | {{Generated with joins}} | ||
{{dafunction | {{dafunction | ||
|name=GetM2DAInt | |name=GetM2DAInt | ||
| Line 5: | Line 6: | ||
|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=int | |returntype=int | ||
|returndesc=Returns the int specified by the parameters. Returns 0. | |returndesc=Returns the int specified by the parameters. Returns 0. | ||
Revision as of 23:14, 31 July 2009
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 2DA value in integer 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 int specified by the parameters. Returns 0.
- Source:
- script.ldf
Description
Returns a 2DA integer based on the specified Row and Column values.
