@skyrim-platform/jcontainers/JAtomic.d.ts

TypeScript library for the JContainers Skyrim modding utility

import { Form } from "skyrimPlatform";
/** A group of the functions that perform various math on the value at the @path of the container. Returns previos value:
    
        T previousValue = container.path
        container.path = someMathFunction(container.path, value)
        return previousValue
    
    If the value at the @path is None, then the @initialValue being read and passed into math function instead of None.
    If @createMissingKeys is True, the function attemps to create missing @path elements. */
export declare const fetchAddInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const fetchAddFlt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** x *= v */
export declare const fetchMultInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const fetchMultFlt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** x %= v */
export declare const fetchModInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** x /= v */
export declare const fetchDivInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const fetchDivFlt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** x &= v */
export declare const fetchAndInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** x ^= v */
export declare const fetchXorInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** x |= v */
export declare const fetchOrInt: (object: number, path: string, value: number, initialValue?: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** Exchanges the value at the @path with the @value. Returns previous value. */
export declare const exchangeInt: (object: number, path: string, value: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const exchangeFlt: (object: number, path: string, value: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const exchangeStr: (object: number, path: string, value: string, createMissingKeys?: boolean, onErrorReturn?: string) => string;
export declare const exchangeForm: (object: number, path: string, value: Form | null | undefined, createMissingKeys?: boolean, onErrorReturn?: Form | null | undefined) => Form | null | undefined;
export declare const exchangeObj: (object: number, path: string, value: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
/** Compares the value at the @path with the @expected and, if they are equal, exchanges the value at the @path with the @desired values.
    Returns previous value. */
export declare const compareExchangeInt: (object: number, path: string, desired: number, expected: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const compareExchangeFlt: (object: number, path: string, desired: number, expected: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;
export declare const compareExchangeStr: (object: number, path: string, desired: string, expected: string, createMissingKeys?: boolean, onErrorReturn?: string) => string;
export declare const compareExchangeForm: (object: number, path: string, desired: Form | null | undefined, expected: Form | null | undefined, createMissingKeys?: boolean, onErrorReturn?: Form | null | undefined) => Form | null | undefined;
export declare const compareExchangeObj: (object: number, path: string, desired: number, expected: number, createMissingKeys?: boolean, onErrorReturn?: number) => number;