@skyrim-platform/papyrus-util/PapyrusUtil.d.ts

TypeScript library for the PapyrusUtil Skyrim modding utility

import { ObjectReference } from "skyrimPlatform";
import { Form } from "skyrimPlatform";
import { Alias } from "skyrimPlatform";
import { Actor } from "skyrimPlatform";
export declare const GetVersion: () => number;
export declare const GetScriptVersion: () => number;
export declare const ActorArray: (size: number, filler?: Actor | null | undefined) => Actor[];
export declare const ResizeActorArray: (ArrayValues: Actor[], toSize: number, filler?: Actor | null | undefined) => Actor[];
export declare const ObjRefArray: (size: number, filler?: ObjectReference | null | undefined) => ObjectReference[];
export declare const ResizeObjRefArray: (ArrayValues: ObjectReference[], toSize: number, filler?: ObjectReference | null | undefined) => ObjectReference[];
export declare const PushFloat: (ArrayValues: number[], push: number) => number[];
export declare const PushInt: (ArrayValues: number[], push: number) => number[];
export declare const PushString: (ArrayValues: string[], push: string) => string[];
export declare const PushForm: (ArrayValues: Form[], push: Form | null | undefined) => Form[];
export declare const PushAlias: (ArrayValues: Alias[], push: Alias | null | undefined) => Alias[];
export declare const PushActor: (ArrayValues: Actor[], push: Actor | null | undefined) => Actor[];
export declare const PushObjRef: (ArrayValues: ObjectReference[], push: ObjectReference | null | undefined) => ObjectReference[];
export declare const RemoveFloat: (ArrayValues: number[], ToRemove: number) => number[];
export declare const RemoveInt: (ArrayValues: number[], ToRemove: number) => number[];
export declare const RemoveString: (ArrayValues: string[], ToRemove: string) => string[];
export declare const RemoveForm: (ArrayValues: Form[], ToRemove: Form | null | undefined) => Form[];
export declare const RemoveAlias: (ArrayValues: Alias[], ToRemove: Alias | null | undefined) => Alias[];
export declare const RemoveActor: (ArrayValues: Actor[], ToRemove: Actor | null | undefined) => Actor[];
export declare const RemoveObjRef: (ArrayValues: ObjectReference[], ToRemove: ObjectReference | null | undefined) => ObjectReference[];
export declare const RemoveDupeFloat: (ArrayValues: number[]) => number[];
export declare const RemoveDupeInt: (ArrayValues: number[]) => number[];
export declare const RemoveDupeString: (ArrayValues: string[]) => string[];
export declare const RemoveDupeForm: (ArrayValues: Form[]) => Form[];
export declare const RemoveDupeAlias: (ArrayValues: Alias[]) => Alias[];
export declare const RemoveDupeActor: (ArrayValues: Actor[]) => Actor[];
export declare const RemoveDupeObjRef: (ArrayValues: ObjectReference[]) => ObjectReference[];
export declare const GetDiffFloat: (ArrayValues1: number[], ArrayValues2: number[], CompareBoth?: boolean, IncludeDupes?: boolean) => number[];
export declare const GetDiffInt: (ArrayValues1: number[], ArrayValues2: number[], CompareBoth?: boolean, IncludeDupes?: boolean) => number[];
export declare const GetDiffString: (ArrayValues1: string[], ArrayValues2: string[], CompareBoth?: boolean, IncludeDupes?: boolean) => string[];
export declare const GetDiffForm: (ArrayValues1: Form[], ArrayValues2: Form[], CompareBoth?: boolean, IncludeDupes?: boolean) => Form[];
export declare const GetDiffAlias: (ArrayValues1: Alias[], ArrayValues2: Alias[], CompareBoth?: boolean, IncludeDupes?: boolean) => Alias[];
export declare const GetDiffActor: (ArrayValues1: Actor[], ArrayValues2: Actor[], CompareBoth?: boolean, IncludeDupes?: boolean) => Actor[];
export declare const GetDiffObjRef: (ArrayValues1: ObjectReference[], ArrayValues2: ObjectReference[], CompareBoth?: boolean, IncludeDupes?: boolean) => ObjectReference[];
export declare const GetMatchingFloat: (ArrayValues1: number[], ArrayValues2: number[]) => number[];
export declare const GetMatchingInt: (ArrayValues1: number[], ArrayValues2: number[]) => number[];
export declare const GetMatchingString: (ArrayValues1: string[], ArrayValues2: string[]) => string[];
export declare const GetMatchingForm: (ArrayValues1: Form[], ArrayValues2: Form[]) => Form[];
export declare const GetMatchingAlias: (ArrayValues1: Alias[], ArrayValues2: Alias[]) => Alias[];
export declare const GetMatchingActor: (ArrayValues1: Actor[], ArrayValues2: Actor[]) => Actor[];
export declare const GetMatchingObjRef: (ArrayValues1: ObjectReference[], ArrayValues2: ObjectReference[]) => ObjectReference[];
export declare const CountFloat: (ArrayValues: number[], EqualTo: number) => number;
export declare const CountInt: (ArrayValues: number[], EqualTo: number) => number;
export declare const CountBool: (ArrayValues: boolean[], EqualTo: boolean) => number;
export declare const CountString: (ArrayValues: string[], EqualTo: string) => number;
export declare const CountForm: (ArrayValues: Form[], EqualTo: Form | null | undefined) => number;
export declare const CountAlias: (ArrayValues: Alias[], EqualTo: Alias | null | undefined) => number;
export declare const CountActor: (ArrayValues: Actor[], EqualTo: Actor | null | undefined) => number;
export declare const CountObjRef: (ArrayValues: ObjectReference[], EqualTo: ObjectReference | null | undefined) => number;
export declare const MergeFloatArray: (ArrayValues1: number[], ArrayValues2: number[], RemoveDupes?: boolean) => number[];
export declare const MergeIntArray: (ArrayValues1: number[], ArrayValues2: number[], RemoveDupes?: boolean) => number[];
export declare const MergeStringArray: (ArrayValues1: string[], ArrayValues2: string[], RemoveDupes?: boolean) => string[];
export declare const MergeFormArray: (ArrayValues1: Form[], ArrayValues2: Form[], RemoveDupes?: boolean) => Form[];
export declare const MergeAliasArray: (ArrayValues1: Alias[], ArrayValues2: Alias[], RemoveDupes?: boolean) => Alias[];
export declare const MergeActorArray: (ArrayValues1: Actor[], ArrayValues2: Actor[], RemoveDupes?: boolean) => Actor[];
export declare const MergeObjRefArray: (ArrayValues1: ObjectReference[], ArrayValues2: ObjectReference[], RemoveDupes?: boolean) => ObjectReference[];
export declare const SliceFloatArray: (ArrayValues: number[], StartIndex: number, EndIndex?: number) => number[];
export declare const SliceIntArray: (ArrayValues: number[], StartIndex: number, EndIndex?: number) => number[];
export declare const SliceStringArray: (ArrayValues: string[], StartIndex: number, EndIndex?: number) => string[];
export declare const SliceFormArray: (ArrayValues: Form[], StartIndex: number, EndIndex?: number) => Form[];
export declare const SliceAliasArray: (ArrayValues: Alias[], StartIndex: number, EndIndex?: number) => Alias[];
export declare const SliceActorArray: (ArrayValues: Actor[], StartIndex: number, EndIndex?: number) => Actor[];
export declare const SliceObjRefArray: (ArrayValues: ObjectReference[], StartIndex: number, EndIndex?: number) => ObjectReference[];
export declare const SortIntArray: (ArrayValues: number[], descending?: boolean) => void;
export declare const SortFloatArray: (ArrayValues: number[], descending?: boolean) => void;
export declare const SortStringArray: (ArrayValues: string[], descending?: boolean) => void;
export declare const ClearEmpty: (ArrayValues: string[]) => string[];
export declare const ClearNone: (ArrayValues: Form[]) => Form[];
export declare const CountFalse: (ArrayValues: boolean[]) => number;
export declare const CountTrue: (ArrayValues: boolean[]) => number;
export declare const CountNone: (ArrayValues: Form[]) => number;
export declare const StringSplit: (ArgString: string, Delimiter?: string) => string[];
export declare const StringJoin: (Values: string[], Delimiter?: string) => string;
export declare const AddIntValues: (Values: number[]) => number;
export declare const AddFloatValues: (Values: number[]) => number;
export declare const ClampInt: (value: number, min: number, max: number) => number;
export declare const ClampFloat: (value: number, min: number, max: number) => number;
export declare const WrapInt: (value: number, end: number, start?: number) => number;
export declare const WrapFloat: (value: number, end: number, start?: number) => number;
export declare const SignInt: (doSign: boolean, value: number) => number;
export declare const SignFloat: (doSign: boolean, value: number) => number;
export declare const ResizeBoolArray: (ArrayValues: boolean[], toSize: number, filler?: boolean) => boolean[];
export declare const PushBool: (ArrayValues: boolean[], push: boolean) => boolean[];
export declare const RemoveBool: (ArrayValues: boolean[], ToRemove: boolean) => boolean[];
export declare const MergeBoolArray: (ArrayValues1: boolean[], ArrayValues2: boolean[], RemoveDupes?: boolean) => boolean[];
export declare const SliceBoolArray: (ArrayValues: boolean[], StartIndex: number, EndIndex?: number) => boolean[];
export declare const FloatArray: (size: number, filler?: number) => number[];
export declare const IntArray: (size: number, filler?: number) => number[];
export declare const BoolArray: (size: number, filler?: boolean) => boolean[];
export declare const StringArray: (size: number, filler?: string) => string[];
export declare const FormArray: (size: number, filler?: Form | null | undefined) => Form[];
export declare const AliasArray: (size: number, filler?: Alias | null | undefined) => Alias[];
export declare const ResizeFloatArray: (ArrayValues: number[], toSize: number, filler?: number) => number[];
export declare const ResizeIntArray: (ArrayValues: number[], toSize: number, filler?: number) => number[];
export declare const ResizeStringArray: (ArrayValues: string[], toSize: number, filler?: string) => string[];
export declare const ResizeFormArray: (ArrayValues: Form[], toSize: number, filler?: Form | null | undefined) => Form[];
export declare const ResizeAliasArray: (ArrayValues: Alias[], toSize: number, filler?: Alias | null | undefined) => Alias[];