Difference between revisions of "GetFirstRefInCell"

Jump to navigation Jump to search
236 bytes added ,  13:42, 3 December 2011
changing to Function template
imported>QQuix
(Recent (!?!) OBSE function)
 
imported>DragoonWraith
(changing to Function template)
{{Function
A command for [[:Category:Oblivion Script Extender|Oblivion Script Extender]]
| origin = OBSE
 
| summary = Works the same as [[GetFirstRef]] but takes an additional parameter specifying the cell to scan. ▼
'''Syntax:'''
(reference:ref) GetFirstRefInCell cell:ref ''type:int'' ''cellDepth:int'' ''includeInactiveRefs:int''
 
▲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.
| returnVal = reference
 
| returnType = ref
 
| arguments =
'''Example'''
{{FunctionArgument
<pre>ref pDoor▼
| 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
loop</pre>
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==
*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
 
 
 
==See Also==
*[[HasBeenPickedUp]]
*[[GetObjectType]]
 
▲[[Category:Functions]]
▲[[Category:Functions (OBSE)]]
▲[[Category:Functions (OBSE v0013)]]
▲[[Category: Record Variable Functions]]
▲[[Category: Record Variable Functions (OBSE)]]

Navigation menu