Difference between revisions of "GetNumRefs - Cell"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
(Created page with "Category:Scripting Category:Papyrus Category:SKSE '''SKSE Member of:''' Cell Script Returns the number of ObjectReferences in the Cell based on the FormType f...")
 
imported>PurpleLunchbox
m
Line 35: Line 35:
*[[Cell Script]]
*[[Cell Script]]
*[[GetNthRef - Cell]]
*[[GetNthRef - Cell]]
*[[Form - GetType]]
*[[GetType - Form]]

Revision as of 04:04, 10 May 2012

SKSE Member of: Cell Script

Returns the number of ObjectReferences in the Cell based on the FormType filter. (This function requires SKSE)

Syntax

int Function GetNumRefs(int formTypeFilter = 0) native

Parameters

  • formTypeFilter: FormType filter to return the number of a specific form type see Form - GetType for a list of FormTypes

Return Value

Returns the number of ObjectReferences in the Cell 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 retrieving the references.

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

See Also