The StorageUtil script is a part of Skyrim SE’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like PapyrusUtil SE - Modders Scripting Utility Functions (PapyrusUtil).
For this script, the Papyrus index knows about:
- 282 functions
Inheritance Tree
No indexed scripts extend this script.
Properties
No properties found.
Events
No events found.
Functions
- Found in:
- PapyrusUtil
Set int/float/string/Form value globally or on any form by name and return
the value passed, or as uninitialized variable if invalid keys given.ObjKey: form to save on. Set none to save globally.
KeyName: name of value.
value: value to set to the given keys. If zero, empty, or none are given, the key will be unset.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Remove a previously set int/float/string/Form value on an form or globally and
return if successful. This will return false if value didn't exist.ObjKey: form to remove from. Set none to remove global value.
KeyName: name of value.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Check if int/float/string/Form value has been set on form or globally.
ObjKey: form to check on. Set none to check global value.
KeyName: name of value.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Get previously saved int/float/string/Form value on form or globally.
ObjKey: form to get from. Set none to get global value.
KeyName: name of value.
[optional] missing: if value has not been set, return this value instead.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Plucks a previously saved int/float/string/Form value on form or globally.
Returning the value stored, then removing it from storage.ObjKey: form to pluck from. Set none to get global value.
KeyName: name of value.
[optional] missing: if value has not been set, return this value instead.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Get previously saved int/float/string/Form value on form or globally.
ObjKey: form to get from. Set none to get global value.
KeyName: name of value.
amount: +/- the amount to adjust the current value bygiven keys will be initialized to given amount if it does not exist
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Add an int/float/string/Form to a list on form or globally and return
the value's new index. Index can be -1 if we were unable to add
the value.ObjKey: form to add to. Set none to add global value.
KeyName: name of value.
value: value to add.
[optional] allowDuplicate: allow adding value to list if this value already exists in the list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
intfunctionStringListAdd(FormObjKey, stringKeyName, stringvalue, boolallowDuplicate=true)NativeGlobal- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Get a value from list by index on form or globally.
This will return 0 as value if there was a problem.ObjKey: form to get value on. Set none to get global list value.
KeyName: name of list.
index: index of value in the list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Set a value in list by index on form or globally.
This will return the previous value or 0 if there was a problem.ObjKey: form to set value on. Set none to set global list value.
KeyName: name of list.
index: index of value in the list.
value: value to set to.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Plucks a value from list by index on form or globally.
The index is removed from the list's storage after returning it's value.ObjKey: form to pluck value from. Set none to get global list value.
KeyName: name of list.
index: index of value in the list.
[optional] missing: if index has not been set, return this value instead.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Gets the value of the very first element in a list, and subsequently removes the index afterward.
ObjKey: form to shift value from. Set none to get global list value.
KeyName: name of list to shift it's first value from.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Gets the value of the very last element in a list, and subsequently removes the index afterward.
ObjKey: form to pop value from. Set none to get global list value.
KeyName: name of list to pop off it's last value.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Adjust the existing value of a list by the given amount.
ObjKey: form to set value on. Set none to set global list value.
KeyName: name of list.
index: index of value in the list.
amount: +/- the amount to adjust the lists current index value by.returns 0 if index does not exists
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Insert an int/float/string/Form to a list on form or globally and return
if successful.ObjKey: form to add to. Set none to add global value.
KeyName: name of value.
index: position in list to put the value. 0 is first entry in list.
value: value to add.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Remove a previously added int/float/string/Form value from a list on form
or globally and return how many instances of this value were removed.ObjKey: form to remove from. Set none to remove global value.
KeyName: name of value.
value: value to remove.
[optional] allowInstances: remove all instances of this value in a list.- Found in:
- PapyrusUtil
intfunctionFloatListRemove(FormObjKey, stringKeyName, floatvalue, boolallInstances=false)NativeGlobal- Found in:
- PapyrusUtil
intfunctionStringListRemove(FormObjKey, stringKeyName, stringvalue, boolallInstances=false)NativeGlobal- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Clear a list of values (unset) on an form or globally and
return the previous size of list.ObjKey: form to clear on. Set none to clear global list.
KeyName: name of list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Remove a value from list by index on form or globally and
return if we were successful in doing so.ObjKey: form to remove from. Set none to remove global value.
KeyName: name of list.
index: index of value in the list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Get size of a list on form or globally.
ObjKey: form to check on. Set none to check global list.
KeyName: name of list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Get the number of occurrences of a specific value within a list.
ObjKey: form to check on. Set none to check global list.
KeyName: name of list.
value: value to look for.
[optional] exclude: if true, function will return number of elements NOT equal to value.- Found in:
- PapyrusUtil
intfunctionFloatListCountValue(FormObjKey, stringKeyName, floatvalue, boolexclude=false)NativeGlobal- Found in:
- PapyrusUtil
intfunctionStringListCountValue(FormObjKey, stringKeyName, stringvalue, boolexclude=false)NativeGlobal- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Find a value in list on form or globally and return its
index or -1 if value was not found.ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.
value: value to search.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Find if a value in list on form or globally exists, true if it exists,
false if it doesn't.ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.
value: value to search.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Sort an int/float/string/Form list by values in ascending order.
ObjKey: form to sort on. Set none for global value.
KeyName: name of value.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Fills the given input array with the values of the list on form or globally,
will fill the array until either the array or list runs out of valid indexesObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.
slice[]: an initialized array set to the slice size you want, i.e. int[] slice = new int[10]
[optional] startIndex: the starting list index you want to start filling your slice array with- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Sizes the given list to a set number of elements. If the list exists already it will be truncated
when given fewer elements, or resized to the appropriate length with the filler argument being used as
the default valuesReturns the number of elements truncated (signed) or added (unsigned) onto the list.
ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.
toLength: The size you want to change the list to. Max length when using this function is 500.
[optional] filler: When adding empty elements to the list this will be used as the default value- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Creates a copy of array on the given storage list at the given object+key,
overwriting any list that might already exists.Returns true on success.
ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.
copy[]: The papyrus array with the content you wish to copy over into StorageUtil
[optional] filler: When adding empty elements to the list this will be used as the default value- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Outputs the values currently stored by the given object+key.
Returns a new array containing the values.
ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Outputs a randomly selected value from the given list's elements using mt19937.
Returns the random elements value. If list is empty or doesn't exist, returns default null value.
ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Form[]functionFormListFilterByTypes(FormObjKey, stringKeyName, int[]FormTypeIDs, boolReturnMatching=true)NativeGlobalReturns array of forms from list that have (or optionally don't have) the specified form types.
For valid list of form types, see FormType.psc or Form.GetType()ObjKey: form to find value on. Set none to find global list value.
KeyName: name of list.
FormTypeIDs[]: The int papyrus array with all the form types you wish to filter for
[optional] ReturnMatching: By default, TRUE, the output Form[] array will contain forms from list that match the form types
If set to FALSE, inverts the resulting array with forms that have a type that DO NOT match.- Found in:
- PapyrusUtil
Form[]functionFormListFilterByType(FormObjKey, stringKeyName, intFormTypeID, boolReturnMatching=true)GlobalConvenience version of FormListFilterByTypes() for when only getting a single type.
- Found in:
- PapyrusUtil
Counts each type of of any KeyName that starts with a given string prefix on all objects.
PrefixKey: The string a KeyName must start with to be counted. Cannot be empty.
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Performs all of the above prefix counts in one go.
- Found in:
- PapyrusUtil
Counts each type of of any KeyName that starts with a given string prefix on all objects.
ObjKey: form to perform the prefix count on.
PrefixKey: The string a KeyName must start with to be counted. Cannot be empty.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Performs all of the above prefix counts in one go.
- Found in:
- PapyrusUtil
Clears each type of of any KeyName that starts with a given string prefix on all objects.
Returns the number of values/lists that were unset.PrefixKey: The string a KeyName must start with to be cleared. Cannot be empty.
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Performs all of the above prefix clears in one go.
- Found in:
- PapyrusUtil
Clears each type of of any KeyName that starts with a given string prefix on specific objects.
Returns the number of values/lists that were unset.ObjKey: form to perform the prefix clear on.
PrefixKey: The string a KeyName must start with to be cleared. Cannot be empty.- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Performs all of the above prefix clears in one go.
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
Currently no longer implemented, unknown if/when they will return.
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
- Found in:
- PapyrusUtil
boolfunctionImportFile(stringfileName, stringrestrictKey="", intrestrictType=-1, FormrestrictForm=NONE, boolrestrictGlobal=false, boolkeyContains=false)Global- Found in:
- PapyrusUtil
boolfunctionExportFile(stringfileName, stringrestrictKey="", intrestrictType=-1, FormrestrictForm=NONE, boolrestrictGlobal=false, boolkeyContains=false, boolappend=true)Global
