StorageUtil

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.

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.

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.

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.

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.

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 by

given keys will be initialized to given amount if it does not exist

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

Get size of a list on form or globally.

ObjKey: form to check on. Set none to check global list.
KeyName: name of list.

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.

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.

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.

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.

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

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.

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.

Convenience version of FormListFilterByTypes() for when only getting a single type.

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.

Performs all of the above prefix counts in one go.

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.

Performs all of the above prefix counts in one go.

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.

Performs all of the above prefix clears in one go.

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.

Performs all of the above prefix clears in one go.