Background for Skyrim SE

The JArray Script

    The JArray 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 JContainers (JContainers).

    For this script, the Papyrus index knows about:

    • 57 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    No properties found.

      Events

        No events found.

      Functions

      • intfunctionobject()NativeGlobal

        creates new container object. returns container's identifier (unique integer number).

      • intfunctionobjectWithSize(intsize)NativeGlobal

        Creates a new array of given size, filled with empty (None) items

      • intfunctionobjectWithInts(int[]values)NativeGlobal

        Creates a new array that contains given values
        objectWithBooleans converts booleans into integers

      • intfunctionobjectWithStrings(string[]values)NativeGlobal
      • intfunctionobjectWithFloats(float[]values)NativeGlobal
      • intfunctionobjectWithBooleans(bool[]values)NativeGlobal
      • intfunctionobjectWithForms(Form[]values)NativeGlobal
      • intfunctionsubArray(intobject, intstartIndex, intendIndex)NativeGlobal

        Creates a new array containing all the values from the source array in range [startIndex, endIndex)

      • voidfunctionaddFromArray(intobject, intsource, intinsertAtIndex=-1)NativeGlobal

        Inserts the values from the source array into this array. If insertAtIndex is -1 (default behaviour) it appends to the end.
        negative index accesses items from the end of container counting backwards.

      • voidfunctionaddFromFormList(intobject, FormListsource, intinsertAtIndex=-1)NativeGlobal
      • intfunctiongetInt(intobject, intindex, intdefault=0)NativeGlobal

        Returns the item at the index of the array.
        negative index accesses items from the end of container counting backwards.

      • floatfunctiongetFlt(intobject, intindex, floatdefault=0.0)NativeGlobal
      • stringfunctiongetStr(intobject, intindex, stringdefault="")NativeGlobal
      • intfunctiongetObj(intobject, intindex, intdefault=0)NativeGlobal
      • FormfunctiongetForm(intobject, intindex, Formdefault=NONE)NativeGlobal
      • int[]functionasIntArray(intobject)NativeGlobal

        Copy all items to new native Papyrus array of dynamic size.
        Items not matching the requested type will have default
        values as the ones from the getInt/Flt/Str/Form functions.

      • float[]functionasFloatArray(intobject)NativeGlobal
      • string[]functionasStringArray(intobject)NativeGlobal
      • Form[]functionasFormArray(intobject)NativeGlobal
      • intfunctionfindInt(intobject, intvalue, intsearchStartIndex=0)NativeGlobal

        Returns the index of the first found value/container that equals to given the value/container (default behaviour if searchStartIndex is 0).
        If nothing was found it returns -1.
        @searchStartIndex - index of the array where to start search
        negative index accesses items from the end of container counting backwards.

      • intfunctionfindFlt(intobject, floatvalue, intsearchStartIndex=0)NativeGlobal
      • intfunctionfindStr(intobject, stringvalue, intsearchStartIndex=0)NativeGlobal
      • intfunctionfindObj(intobject, intcontainer, intsearchStartIndex=0)NativeGlobal
      • intfunctionfindForm(intobject, Formvalue, intsearchStartIndex=0)NativeGlobal
      • intfunctioncountInteger(intobject, intvalue)NativeGlobal

        Returns the number of times given value was found in a JArray.

      • intfunctioncountFloat(intobject, floatvalue)NativeGlobal
      • intfunctioncountString(intobject, stringvalue)NativeGlobal
      • intfunctioncountObject(intobject, intcontainer)NativeGlobal
      • intfunctioncountForm(intobject, Formvalue)NativeGlobal
      • voidfunctionsetInt(intobject, intindex, intvalue)NativeGlobal

        Replaces existing value at the @index of the array with the new @value.
        negative index accesses items from the end of container counting backwards.

      • voidfunctionsetFlt(intobject, intindex, floatvalue)NativeGlobal
      • voidfunctionsetStr(intobject, intindex, stringvalue)NativeGlobal
      • voidfunctionsetObj(intobject, intindex, intcontainer)NativeGlobal
      • voidfunctionsetForm(intobject, intindex, Formvalue)NativeGlobal
      • voidfunctionaddInt(intobject, intvalue, intaddToIndex=-1)NativeGlobal

        Appends the @value/@container to the end of the array.
        If @addToIndex >= 0 it inserts value at given index. negative index accesses items from the end of container counting backwards.

      • voidfunctionaddFlt(intobject, floatvalue, intaddToIndex=-1)NativeGlobal
      • voidfunctionaddStr(intobject, stringvalue, intaddToIndex=-1)NativeGlobal
      • voidfunctionaddObj(intobject, intcontainer, intaddToIndex=-1)NativeGlobal
      • voidfunctionaddForm(intobject, Formvalue, intaddToIndex=-1)NativeGlobal
      • intfunctioncount(intobject)NativeGlobal

        Returns count of the items in the array

      • voidfunctionclear(intobject)NativeGlobal

        Removes all the items from the array

      • voidfunctioneraseIndex(intobject, intindex)NativeGlobal

        Erases the item at the index. negative index accesses items from the end of container counting backwards.

      • voidfunctioneraseRange(intobject, intfirst, intlast)NativeGlobal

        Erases [first, last] index range of the items. negative index accesses items from the end of container counting backwards.
        For ex. with [1,-1] range it will erase everything except the first item

      • intfunctioneraseInteger(intobject, intvalue)NativeGlobal

        Erase all elements of given value. Returns the number of erased elements.

      • intfunctioneraseFloat(intobject, floatvalue)NativeGlobal
      • intfunctioneraseString(intobject, stringvalue)NativeGlobal
      • intfunctioneraseObject(intobject, intcontainer)NativeGlobal
      • intfunctioneraseForm(intobject, Formvalue)NativeGlobal
      • intfunctionvalueType(intobject, intindex)NativeGlobal

        Returns type of the value at the @index. negative index accesses items from the end of container counting backwards.
        0 - no value, 1 - none, 2 - int, 3 - float, 4 - form, 5 - object, 6 - string

      • voidfunctionswapItems(intobject, intindex1, intindex2)NativeGlobal

        Exchanges the items at @index1 and @index2. negative index accesses items from the end of container counting backwards.

      • intfunctionsort(intobject)NativeGlobal

        Sorts the items into ascending order (none < int < float < form < object < string). Returns the array itself

      • intfunctionunique(intobject)NativeGlobal

        Sorts the items, removes duplicates. Returns array itself. You can treat it as JSet now

      • intfunctionreverse(intobject)NativeGlobal

        Reverse the order of elements. Returns the array itself.

      • boolfunctionwriteToIntegerPArray(intobject, int[]targetArray, intwriteAtIdx=0, intstopWriteAtIdx=-1, intreadIdx=0, intdefaultRead=0)NativeGlobal

        Writes the array's items into the @targetArray array starting at @destIndex
        @writeAtIdx - [-1, 0] - writes all the items in reverse order
        [0, -1] - writes all the items in straight order
        [1, 3] - writes 3 items in straight order

      • boolfunctionwriteToFloatPArray(intobject, float[]targetArray, intwriteAtIdx=0, intstopWriteAtIdx=-1, intreadIdx=0, floatdefaultRead=0.0)NativeGlobal
      • boolfunctionwriteToFormPArray(intobject, Form[]targetArray, intwriteAtIdx=0, intstopWriteAtIdx=-1, intreadIdx=0, FormdefaultRead=NONE)NativeGlobal
      • boolfunctionwriteToStringPArray(intobject, string[]targetArray, intwriteAtIdx=0, intstopWriteAtIdx=-1, intreadIdx=0, stringdefaultRead="")NativeGlobal
      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.