GetRandomFormFromRefS function - DbMiscFunctions script

Found in:

Dylbills PE

FormfunctionGetRandomFormFromRefS(ObjectReferenceRef, int[]TypeArrayFilter=NONE, FormObjKey=NONE, stringListKeyName="", boolTypeFilterHasType=true, boolakListHasForm=true)Global

Description

Documentation Comment

Get random form from Ref's inventory.
If TypeArrayFilter != none, filters for form types in TypeArrayFilter. If TypeFilterHasType == true (default) only allows for types in the TypeArrayFilter. If false, only allows for types NOT in the TypeArrayFilter.
If ListKeyName != none, filters for base forms in the StorageUtil Formlist defined by the ObjKey and ListKeyName. If akListHasForm == true (default) only allows for forms in the StorageUtil Formlist. If false, only allows for forms NOT in the StorageUtil Formlist.
Requires SKSE and PapyrusUtil

Parameters

ObjectReferenceRef
int[]TypeArrayFilter=NONE
FormObjKey=NONE
stringListKeyName=""
boolTypeFilterHasType=true
boolakListHasForm=true

Examples

Auto-Generated Example

ObjectReference myObjectReference__Ref
int[] myIntArray__TypeArrayFilter
Form myForm__ObjKey
string myString__ListKeyName
bool myBool__TypeFilterHasType
bool myBool__akListHasForm

Form returnedValue = DbMiscFunctions.GetRandomFormFromRefS(myObjectReference__Ref, myIntArray__TypeArrayFilter, myForm__ObjKey, myString__ListKeyName, myBool__TypeFilterHasType, myBool__akListHasForm)