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

TypeScript library for the PapyrusUtil Skyrim modding utility

import { Race } from "skyrimPlatform";
import { ObjectReference } from "skyrimPlatform";
import { Keyword } from "skyrimPlatform";
import { Faction } from "skyrimPlatform";
import { Actor } from "skyrimPlatform";
/** Cell scanning functions */
export declare const ScanCellObjects: (formType: number, CenterOn: ObjectReference | null | undefined, radius?: number, HasKeyword?: Keyword | null | undefined) => ObjectReference[];
export declare const ScanCellNPCs: (CenterOn: ObjectReference | null | undefined, radius?: number, HasKeyword?: Keyword | null | undefined, IgnoreDead?: boolean) => Actor[];
export declare const ScanCellNPCsByFaction: (FindFaction: Faction | null | undefined, CenterOn: ObjectReference | null | undefined, radius?: number, minRank?: number, maxRank?: number, IgnoreDead?: boolean) => Actor[];
/** Camera functions */
export declare const ToggleFreeCamera: (stopTime?: boolean) => void;
export declare const SetFreeCameraSpeed: (speed: number) => void;
export declare const SetFreeCameraState: (enable: boolean, speed?: number) => void;
/** File related functions */
export declare const FilesInFolder: (directory: string, extension?: string) => string[] | null;
export declare const FoldersInFolder: (directory: string) => string[] | null;
export declare const FileExists: (fileName: string) => boolean;
export declare const ReadFromFile: (fileName: string) => string | null;
export declare const WriteToFile: (fileName: string, text: string, append?: boolean, timestamp?: boolean) => boolean;
/** Misc */
export declare const PrintConsole: (text: string) => void;
export declare const GetRaceEditorID: (raceForm: Race | null | undefined) => string;
export declare const GetActorRaceEditorID: (actorRef: Actor | null | undefined) => string;
export declare const SetMenus: (enabled: boolean) => void;
export declare const GetNodeRotation: (obj: ObjectReference | null | undefined, nodeName: string, firstPerson: boolean, rotationIndex: number) => number;
export declare const ScanCellActors: (CenterOn: ObjectReference | null | undefined, radius?: number, HasKeyword?: Keyword | null | undefined) => Actor[];