@skyrim-platform/jcontainers/JFormDB.js

TypeScript library for the JContainers Skyrim modding utility

/*
==============================================
Typescript definitions for v4.2.1
==============================================

This file was automatically generated by Papyrus-2-Typescript.exe
https://github.com/CarlosLeyvaAyala/Papyrus-2-Typescript

The program has no way to know the intention of the humans that made
the scripts, so it's always advisable to manually check all generated
files to make sure everything is declared as it should.

Take note the program assumes this script exists in some subfolder
to the folder where `skyrimPlatform.ts` is found, otherwise you'll get
"Cannot find module..." type of errors.

If you want to have this script in some other place, just change the
relative path of each `import`.
*/
import * as sp from "skyrimPlatform";
/** Manages form related information (entry). */
var sn = sp.JFormDB;
/** associates given form key and entry (container). set entry to zero to destroy association */
export var setEntry = function (storageName, fKey, entry) { return sn.setEntry(storageName, fKey, entry); };
/** returns (or creates new if not found) JMap entry for given storage and form */
export var makeEntry = function (storageName, fKey) { return sn.makeEntry(storageName, fKey); };
/** search for entry for given storage and form */
export var findEntry = function (storageName, fKey) { return sn.findEntry(storageName, fKey); };
/** attempts to get value associated with path. */
export var solveFlt = function (fKey, path, defaultVal) {
    if (defaultVal === void 0) { defaultVal = 0.0; }
    return sn.solveFlt(fKey, path, defaultVal);
};
export var solveInt = function (fKey, path, defaultVal) {
    if (defaultVal === void 0) { defaultVal = 0; }
    return sn.solveInt(fKey, path, defaultVal);
};
export var solveStr = function (fKey, path, defaultVal) {
    if (defaultVal === void 0) { defaultVal = ""; }
    return sn.solveStr(fKey, path, defaultVal);
};
export var solveObj = function (fKey, path, defaultVal) {
    if (defaultVal === void 0) { defaultVal = 0; }
    return sn.solveObj(fKey, path, defaultVal);
};
export var solveForm = function (fKey, path, defaultVal) {
    if (defaultVal === void 0) { defaultVal = null; }
    return sn.solveForm(fKey, path, defaultVal);
};
/** Attempts to assign value. Returns false if no such path
    With 'createMissingKeys=true' it creates any missing path elements: JFormDB.solveIntSetter(formKey, ".frostfall.keyB", 10, true) creates {frostfall: {keyB: 10}} structure */
export var solveFltSetter = function (fKey, path, value, createMissingKeys) {
    if (createMissingKeys === void 0) { createMissingKeys = false; }
    return sn.solveFltSetter(fKey, path, value, createMissingKeys);
};
export var solveIntSetter = function (fKey, path, value, createMissingKeys) {
    if (createMissingKeys === void 0) { createMissingKeys = false; }
    return sn.solveIntSetter(fKey, path, value, createMissingKeys);
};
export var solveStrSetter = function (fKey, path, value, createMissingKeys) {
    if (createMissingKeys === void 0) { createMissingKeys = false; }
    return sn.solveStrSetter(fKey, path, value, createMissingKeys);
};
export var solveObjSetter = function (fKey, path, value, createMissingKeys) {
    if (createMissingKeys === void 0) { createMissingKeys = false; }
    return sn.solveObjSetter(fKey, path, value, createMissingKeys);
};
export var solveFormSetter = function (fKey, path, value, createMissingKeys) {
    if (createMissingKeys === void 0) { createMissingKeys = false; }
    return sn.solveFormSetter(fKey, path, value, createMissingKeys);
};
/** returns true, if capable resolve given path, e.g. it able to execute solve* or solver*Setter functions successfully */
export var hasPath = function (fKey, path) { return sn.hasPath(fKey, path); };
/** JMap-like interface functions:
    
    returns new array containing all keys */
export var allKeys = function (fKey, key) { return sn.allKeys(fKey, key); };
/** returns new array containing all values */
export var allValues = function (fKey, key) { return sn.allValues(fKey, key); };
/** returns value associated with key */
export var getInt = function (fKey, key) { return sn.getInt(fKey, key); };
export var getFlt = function (fKey, key) { return sn.getFlt(fKey, key); };
export var getStr = function (fKey, key) { return sn.getStr(fKey, key); };
export var getObj = function (fKey, key) { return sn.getObj(fKey, key); };
export var getForm = function (fKey, key) { return sn.getForm(fKey, key); };
/** creates key-value association. replaces existing value if any */
export var setInt = function (fKey, key, value) { return sn.setInt(fKey, key, value); };
export var setFlt = function (fKey, key, value) { return sn.setFlt(fKey, key, value); };
export var setStr = function (fKey, key, value) { return sn.setStr(fKey, key, value); };
export var setObj = function (fKey, key, container) { return sn.setObj(fKey, key, container); };
export var setForm = function (fKey, key, value) { return sn.setForm(fKey, key, value); };