GetNthRef - Cell
Revision as of 04:09, 10 May 2012 by imported>PurpleLunchbox (Created page with "Category:Scripting Category:Papyrus Category:SKSE '''SKSE Member of:''' Cell Script Returns the ObjectReference at the Nth index in the Cell based on the Form...")
SKSE Member of: Cell Script
Returns the ObjectReference at the Nth index in the Cell based on the FormType filter. (This function requires SKSE)
Syntax
ObjectReference Function GetNthRef(int n, int formTypeFilter = 0)
Parameters
- n: The index at which the ObjectReference is located in the Cell with respect to the FormType filter.
- formTypeFilter: Filters the list of which ObjectReferences are able to be retrieved, see GetType - Form for a list of FormTypes.
Return Value
Returns the ObjectReferences in the Cell at the Nth index based on the FormType filter.
Notes
- Using a filter type of zero results in returning all object references in the cell.
- If using a filter type make sure to use the same filter when determining the maximum amount.
Examples
int numFlora = Cell.GetNumRefs(39) ; kFlora = 39
int index = 0
While index < numFlora
ObjectReference objRef = Cell.GetNthRef(index, 39)
Debug.Trace("Flora Found in cell: " + objRef)
index += 1
EndWhile