Difference between revisions of "GetFirstRefInCell"
changing to Function template
imported>QQuix (Recent (!?!) OBSE function) |
imported>DragoonWraith (changing to Function template) |
||
| Line 1: | Line 1: | ||
{{Function | |||
| origin = OBSE | |||
| summary = Works the same as [[GetFirstRef]] but takes an additional parameter specifying the cell to scan. | |||
Works the same as [[GetFirstRef]] but takes an additional parameter specifying the cell to scan. | |||
Use [[GetNextRef]] to iterate through the rest of the references in the cell. | Use [[GetNextRef]] to iterate through the rest of the references in the cell. | ||
| returnVal = reference | |||
| returnType = ref | |||
| arguments = | |||
<pre>ref pDoor | {{FunctionArgument | ||
| name = cell | |||
| type = ref | |||
}}{{FunctionArgument | |||
| name = type | |||
| type = int | |||
| optional = y | |||
}}{{FunctionArgument | |||
| name = cellDepth | |||
| type = int | |||
| optional = y | |||
}}{{FunctionArgument | |||
| name = includeInactiveRefs | |||
| type = bool | |||
| optional = y | |||
}} | |||
| example = <pre>ref pDoor | |||
... | ... | ||
set pDoor to GetFirstRefInCell AbandonedMine 24 | set pDoor to GetFirstRefInCell AbandonedMine 24 | ||
| Line 18: | Line 31: | ||
loop</pre> | loop</pre> | ||
Scans the list of doors in the AbandonedMine cell. | Scans the list of doors in the AbandonedMine cell. | ||
| CategoryList = [[Category:Functions]] | |||
[[Category:Functions (OBSE)]] | |||
[[Category:Functions (OBSE v0013)]] | |||
[[Category:Record Variable Functions]] | |||
[[Category:Record Variable Functions (OBSE)]] | |||
}} | |||
==Notes== | ==Notes== | ||
*If the specified cell is not loaded in memory: | *If the specified cell is not loaded in memory: | ||
**Unloaded interior cells: this function will only return persistent references. | |||
**Unloaded exterior cells: this function will not return any reference. | |||
*Ckeck the [[GetFirstRef]] article for additional details | *Ckeck the [[GetFirstRef]] article for additional details | ||
==See Also== | ==See Also== | ||
| Line 35: | Line 50: | ||
*[[HasBeenPickedUp]] | *[[HasBeenPickedUp]] | ||
*[[GetObjectType]] | *[[GetObjectType]] | ||