Background for Skyrim SE

The PapyrusUtilEx Script

    The PapyrusUtilEx 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 Dylbills Papyrus Functions (Dylbills PE).

    For this script, the Papyrus index knows about:

    • 10 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    No properties found.

      Events

        No events found.

      Functions

      • stringfunctionGetFormHandle(FormakForm)NativeGlobal
      • stringfunctionGetAliasHandle(AliasakAlias)NativeGlobal
      • stringfunctionGetActiveEffectHandle(ActiveMagicEffectakActiveEffect)NativeGlobal
      • boolfunctionResizeArray(stringakHandle, stringsScriptName, stringsArrayPropertyName, intsize, intfillIndex=-1)NativeGlobal

        Resize a papyrus array.
        if the array is sized to larger than before, the rest of the array is filled with the element at the fillIndex in the array.
        A value of -1 (default) for the fillIndex means the last element in the array.
        If the array is sized smaller the elements past the new size are removed from the array.

      • intfunctionRemoveFromArray(stringakHandle, stringsScriptName, stringsArrayPropertyName, intindex=-1, boolremoveAll=false)NativeGlobal

        Remove the element at the index from the array.
        If the removeAll parameter is true, removes all elements from the array that match the element at the index
        A value of -1 for the index (default) means the last element in the array.
        Returns the amount of elements removed, if it returns 0 it means the index wasn't valid (>= array.length)

      • boolfunctionSliceArray(stringakHandle, stringsScriptName, stringsArrayPropertyName, intstartIndex, intendIndex=-1, boolkeep=true)NativeGlobal

        Remove a portion of the array.
        If keep is true (default) it keeps the portion between the startIndex and endIndex and removes the rest. If keep is false, it removes the portion between the startIndex and endIndex.
        A value of -1 for the endIndex (default) means the last element in the array.

      • boolfunctionSliceArrayOnto(stringakHandle_A, stringsScriptName_A, stringsArrayPropertyName_A, stringakHandle_B, stringsScriptName_B, stringsArrayPropertyName_B, intstartIndex, intendIndex=-1, boolreplace=false, boolkeep=true)NativeGlobal

        Take a portion of the _A array and remove it, merging it with or replacing the _B array depending on the replace parameter.
        If keep is true (default) it keeps the portion between the startIndex and endIndex and removes the rest. If keep is false, it removes the portion between the startIndex and endIndex.
        Array _A and array _B must be the same type. Remember both arrays must be already initialized.

      • boolfunctionMergeArrays(stringakHandle_A, stringsScriptName_A, stringsArrayPropertyName_A, stringakHandle_B, stringsScriptName_B, stringsArrayPropertyName_B)NativeGlobal

        Merge the _A array to the end of the _B array, increasing _B array's size. The _A array is unaltered.
        Array _A and array _B must be the same type. Remember both arrays must be already initialized.

      • boolfunctionCopyArray(stringakHandle_A, stringsScriptName_A, stringsArrayPropertyName_A, stringakHandle_B, stringsScriptName_B, stringsArrayPropertyName_B)NativeGlobal

        Replace the _B array with a copy of the _A array. The _A array is unaltered.
        Array _A and array _B must be the same type. Remember both arrays must be already initialized.

      • intfunctionCountInArray(stringakHandle, stringsScriptName, stringsArrayPropertyName, intindex=-1)NativeGlobal

        Returns the number of instances of the element at the index that the array contains.
        A value of -1 for the index (default) means the last element in the array.

      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.