GetNumRefs - Cell | Skyrim SE

Found in:

SKSE

intfunctionGetNumRefs(intformTypeFilter=0)Native

Description

Wiki Description

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

Documentation Comment

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC
Returns the number of refs in the cell

Caveats

CK Wiki - 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.
If the cell that references are called from is not loaded, non-persistent references will not be called.

Parameters

intformTypeFilter=0

CK Wiki Description

FormType filter to return the number of a specific form type see Form.GetType() for a list of FormTypes.

Examples

Function PickEveryFlowerInCell(Actor akFlowerPicker) Global
    Cell kCell = akFlowerPicker.GetParentCell()
    Int iIndex = kCell.GetNumRefs(39) ; kFlora = 39
    While iIndex
        iIndex -= 1
        kCell.GetNthRef(iIndex, 39).Activate(akFlowerPicker)
    EndWhile
EndFunctionFunction PickEveryFlowerInCell(Actor akFlowerPicker) Global
    Cell kCell = akFlowerPicker.GetParentCell()
    Int iIndex = kCell.GetNumRefs(39) ; kFlora = 39
    While iIndex
        iIndex -= 1
        kCell.GetNthRef(iIndex, 39).Activate(akFlowerPicker)
    EndWhile
EndFunction

Auto-Generated Example

int myInt__formTypeFilter

int returnedValue = myCell__toCallFunctionOn.GetNumRefs(myInt__formTypeFilter)

Additional References

View this function’s page on the Skyrim Creation Kit Wiki