The PapyrusUtil Script

No properties found.

No events found.

• Found in:
  • PapyrusUtil

  intfunctionGetVersion()NativeGlobal

  Get version of papyrus DLL library. Version 4.6 will return 46.

• Found in:
  • PapyrusUtil

  intfunctionGetScriptVersion()Global

  Get version of compiled papyrus scripts which should match return from GetVersion()

• Found in:
  • PapyrusUtil

  Actor[]functionActorArray(intsize, Actorfiller=NONE)NativeGlobal

  Few extra array types not provided by SKSE normally to help avoid having to use and cast Form arrays

• Found in:
  • PapyrusUtil

  Actor[]functionResizeActorArray(Actor[]ArrayValues, inttoSize, Actorfiller=NONE)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionObjRefArray(intsize, ObjectReferencefiller=NONE)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionResizeObjRefArray(ObjectReference[]ArrayValues, inttoSize, ObjectReferencefiller=NONE)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionPushFloat(float[]ArrayValues, floatpush)NativeGlobal

  Append a value to the end of the given array and return the new array.

  NOTE: The array has to be recreated each time you call this. For the sake of memory usage and performance, DO NOT use these to build up an array through a loop,

  in such a situation it is significantly faster to create the full length array first and then fill it. Best to limit to only the occasional need.

• Found in:
  • PapyrusUtil

  int[]functionPushInt(int[]ArrayValues, intpush)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionPushString(string[]ArrayValues, stringpush)NativeGlobal

  bool[] function PushBool(bool[] ArrayValues, bool push) global native ; // Bugged - Non-native version available below

• Found in:
  • PapyrusUtil

  Form[]functionPushForm(Form[]ArrayValues, Formpush)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionPushAlias(Alias[]ArrayValues, Aliaspush)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionPushActor(Actor[]ArrayValues, Actorpush)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionPushObjRef(ObjectReference[]ArrayValues, ObjectReferencepush)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionRemoveFloat(float[]ArrayValues, floatToRemove)NativeGlobal

  Removes all elements from the given array matching the provided value and returns the shortened array.

• Found in:
  • PapyrusUtil

  int[]functionRemoveInt(int[]ArrayValues, intToRemove)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionRemoveString(string[]ArrayValues, stringToRemove)NativeGlobal

  bool[] function RemoveBool(bool[] ArrayValues, bool ToRemove) global native ; // Bugged - Non-native version available below

• Found in:
  • PapyrusUtil

  Form[]functionRemoveForm(Form[]ArrayValues, FormToRemove)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionRemoveAlias(Alias[]ArrayValues, AliasToRemove)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionRemoveActor(Actor[]ArrayValues, ActorToRemove)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionRemoveObjRef(ObjectReference[]ArrayValues, ObjectReferenceToRemove)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionRemoveDupeFloat(float[]ArrayValues)NativeGlobal

  Removes all duplicate elements from the given array and returns the shortened array with only a single instance of all element values.

• Found in:
  • PapyrusUtil

  int[]functionRemoveDupeInt(int[]ArrayValues)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionRemoveDupeString(string[]ArrayValues)NativeGlobal
• Found in:
  • PapyrusUtil

  Form[]functionRemoveDupeForm(Form[]ArrayValues)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionRemoveDupeAlias(Alias[]ArrayValues)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionRemoveDupeActor(Actor[]ArrayValues)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionRemoveDupeObjRef(ObjectReference[]ArrayValues)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionGetDiffFloat(float[]ArrayValues1, float[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal

  Get an array of values from ArrayValues1 that ARE NOT among the values of ArrayValues2. Duplicates are removed by default.

  Setting CompareBoth = true will change the behavior to also include the reverse comparison of ArrayValues2 values that are not present in ArrayValues1.

  Setting IncludeDupes = true will allow the resulting array to include duplicate entries of the same value if they were also duplicated in the input arrays.

• Found in:
  • PapyrusUtil

  int[]functionGetDiffInt(int[]ArrayValues1, int[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionGetDiffString(string[]ArrayValues1, string[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  Form[]functionGetDiffForm(Form[]ArrayValues1, Form[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionGetDiffAlias(Alias[]ArrayValues1, Alias[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionGetDiffActor(Actor[]ArrayValues1, Actor[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionGetDiffObjRef(ObjectReference[]ArrayValues1, ObjectReference[]ArrayValues2, boolCompareBoth=false, boolIncludeDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionGetMatchingFloat(float[]ArrayValues1, float[]ArrayValues2)NativeGlobal

  Get an array of values that are present in both ArrayValues1 and ArrayValues2.

• Found in:
  • PapyrusUtil

  int[]functionGetMatchingInt(int[]ArrayValues1, int[]ArrayValues2)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionGetMatchingString(string[]ArrayValues1, string[]ArrayValues2)NativeGlobal
• Found in:
  • PapyrusUtil

  Form[]functionGetMatchingForm(Form[]ArrayValues1, Form[]ArrayValues2)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionGetMatchingAlias(Alias[]ArrayValues1, Alias[]ArrayValues2)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionGetMatchingActor(Actor[]ArrayValues1, Actor[]ArrayValues2)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionGetMatchingObjRef(ObjectReference[]ArrayValues1, ObjectReference[]ArrayValues2)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountFloat(float[]ArrayValues, floatEqualTo)NativeGlobal

  Returns the number of instances an array has an element equal to the given value

• Found in:
  • PapyrusUtil

  intfunctionCountInt(int[]ArrayValues, intEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountBool(bool[]ArrayValues, boolEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountString(string[]ArrayValues, stringEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountForm(Form[]ArrayValues, FormEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountAlias(Alias[]ArrayValues, AliasEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountActor(Actor[]ArrayValues, ActorEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionCountObjRef(ObjectReference[]ArrayValues, ObjectReferenceEqualTo)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionMergeFloatArray(float[]ArrayValues1, float[]ArrayValues2, boolRemoveDupes=false)NativeGlobal

  Returns two arrays combined into one, optionally also removing any duplicate occurrences of a value.

• Found in:
  • PapyrusUtil

  int[]functionMergeIntArray(int[]ArrayValues1, int[]ArrayValues2, boolRemoveDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionMergeStringArray(string[]ArrayValues1, string[]ArrayValues2, boolRemoveDupes=false)NativeGlobal

  bool[] function MergeBoolArray(bool[] ArrayValues1, bool[] ArrayValues2, bool RemoveDupes = false) global native ; // Bugged - Non-native version available below

• Found in:
  • PapyrusUtil

  Form[]functionMergeFormArray(Form[]ArrayValues1, Form[]ArrayValues2, boolRemoveDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionMergeAliasArray(Alias[]ArrayValues1, Alias[]ArrayValues2, boolRemoveDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionMergeActorArray(Actor[]ArrayValues1, Actor[]ArrayValues2, boolRemoveDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionMergeObjRefArray(ObjectReference[]ArrayValues1, ObjectReference[]ArrayValues2, boolRemoveDupes=false)NativeGlobal
• Found in:
  • PapyrusUtil

  float[]functionSliceFloatArray(float[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal

  Returns a sub section of an array indicated by a starting and ending index.

  The default argument "int EndIndex = -1" clamps the to the end of the array. Equivalent of setting EndIndex = (ArrayValues.Length - 1)

• Found in:
  • PapyrusUtil

  int[]functionSliceIntArray(int[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionSliceStringArray(string[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal

  bool[] function SliceBoolArray(bool[] ArrayValues, int StartIndex, int EndIndex = -1) global native ; // Bugged - Non-native version available below

• Found in:
  • PapyrusUtil

  Form[]functionSliceFormArray(Form[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal
• Found in:
  • PapyrusUtil

  Alias[]functionSliceAliasArray(Alias[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal
• Found in:
  • PapyrusUtil

  Actor[]functionSliceActorArray(Actor[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal
• Found in:
  • PapyrusUtil

  ObjectReference[]functionSliceObjRefArray(ObjectReference[]ArrayValues, intStartIndex, intEndIndex=-1)NativeGlobal
• Found in:
  • PapyrusUtil

  voidfunctionSortIntArray(int[]ArrayValues, booldescending=false)NativeGlobal

  Sorts a given array's elements alphanumerically. Sorted in ascending order by default.

• Found in:
  • PapyrusUtil

  voidfunctionSortFloatArray(float[]ArrayValues, booldescending=false)NativeGlobal
• Found in:
  • PapyrusUtil

  voidfunctionSortStringArray(string[]ArrayValues, booldescending=false)NativeGlobal
• Found in:
  • PapyrusUtil

  string[]functionClearEmpty(string[]ArrayValues)Global
• Found in:
  • PapyrusUtil

  Form[]functionClearNone(Form[]ArrayValues)Global
• Found in:
  • PapyrusUtil

  intfunctionCountFalse(bool[]ArrayValues)Global
• Found in:
  • PapyrusUtil

  intfunctionCountTrue(bool[]ArrayValues)Global
• Found in:
  • PapyrusUtil

  intfunctionCountNone(Form[]ArrayValues)Global
• Found in:
  • PapyrusUtil

  string[]functionStringSplit(stringArgString, stringDelimiter="")NativeGlobal

  Similar to SKSE's native StringUtil.Split() except results are whitespace trimmed. So comma, separated,list,can, be, spaced,or,not.

• Found in:
  • PapyrusUtil

  stringfunctionStringJoin(string[]Values, stringDelimiter="")NativeGlobal

  Opposite of StringSplit()

• Found in:
  • PapyrusUtil

  intfunctionAddIntValues(int[]Values)NativeGlobal

  Return the total sum of all values stored in the given array

• Found in:
  • PapyrusUtil

  floatfunctionAddFloatValues(float[]Values)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionClampInt(intvalue, intmin, intmax)NativeGlobal

  Returns the value clamped to the min or max when out of range

• Found in:
  • PapyrusUtil

  floatfunctionClampFloat(floatvalue, floatmin, floatmax)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionWrapInt(intvalue, intend, intstart=0)NativeGlobal

  Similar to the clamp functions, only values wrap around to the other side of range instead.

  Mostly useful for traversing around array values by wrapping the index from end to end without having to check for it being out of range first.

  i.e.: Form var = myFormArray[WrapInt(i, (myFormArray.Length - 1))]

• Found in:
  • PapyrusUtil

  floatfunctionWrapFloat(floatvalue, floatend, floatstart=0.0)NativeGlobal
• Found in:
  • PapyrusUtil

  intfunctionSignInt(booldoSign, intvalue)NativeGlobal

  Returns the given value signed if bool is true, unsigned if false, regardless if value started out signed or not.

• Found in:
  • PapyrusUtil

  floatfunctionSignFloat(booldoSign, floatvalue)NativeGlobal
• Found in:
  • PapyrusUtil

  bool[]functionResizeBoolArray(bool[]ArrayValues, inttoSize, boolfiller=false)Global
• Found in:
  • PapyrusUtil

  bool[]functionPushBool(bool[]ArrayValues, boolpush)Global
• Found in:
  • PapyrusUtil

  bool[]functionRemoveBool(bool[]ArrayValues, boolToRemove)Global
• Found in:
  • PapyrusUtil

  bool[]functionMergeBoolArray(bool[]ArrayValues1, bool[]ArrayValues2, boolRemoveDupes=false)Global
• Found in:
  • PapyrusUtil

  bool[]functionSliceBoolArray(bool[]ArrayValues, intStartIndex, intEndIndex=-1)Global
• Found in:
  • PapyrusUtil

  float[]functionFloatArray(intsize, floatfiller=0.0)Global
• Found in:
  • PapyrusUtil

  int[]functionIntArray(intsize, intfiller=0)Global
• Found in:
  • PapyrusUtil

  bool[]functionBoolArray(intsize, boolfiller=false)Global
• Found in:
  • PapyrusUtil

  string[]functionStringArray(intsize, stringfiller="")Global
• Found in:
  • PapyrusUtil

  Form[]functionFormArray(intsize, Formfiller=NONE)Global
• Found in:
  • PapyrusUtil

  Alias[]functionAliasArray(intsize, Aliasfiller=NONE)Global
• Found in:
  • PapyrusUtil

  float[]functionResizeFloatArray(float[]ArrayValues, inttoSize, floatfiller=0.0)Global
• Found in:
  • PapyrusUtil

  int[]functionResizeIntArray(int[]ArrayValues, inttoSize, intfiller=0)Global
• Found in:
  • PapyrusUtil

  string[]functionResizeStringArray(string[]ArrayValues, inttoSize, stringfiller="")Global
• Found in:
  • PapyrusUtil

  Form[]functionResizeFormArray(Form[]ArrayValues, inttoSize, Formfiller=NONE)Global
• Found in:
  • PapyrusUtil

  Alias[]functionResizeAliasArray(Alias[]ArrayValues, inttoSize, Aliasfiller=NONE)Global