The JValue script is a part of Skyrim SE’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like JContainers (JContainers).
For this script, the Papyrus index knows about:
- 39 functions
Inheritance Tree
No indexed scripts extend this script.
Properties
No properties found.
Events
No events found.
Functions
- Found in:
- JContainers
Most call entries made to JC will be logged. Heavy traffic, by default is disabled.
Not thread safe for multiple users (though harmless).- Found in:
- JContainers
--- Lifetime management functionality.
Read this https://github.com/ryobg/JContainers/wiki/Lifetime-Management before using any of lifetime management functionsRetains and returns the object.
- Found in:
- JContainers
Releases the object and returns zero, so you can release and nullify with one line of code: object = JValue.release(object)
- Found in:
- JContainers
Just a union of retain-release calls. Releases @previousObject, retains and returns @newObject.
- Found in:
- JContainers
Releases all objects tagged with @tag.
Internally invokes JValue.release on each object same amount of times it has been retained.- Found in:
- JContainers
Minimizes the time JC temporarily owns the object, returns the object.
By using this function you help JC to delete unused objects as soon as possible.
Has zero effect if the object is being retained or if another object contains/references it.- Found in:
- JContainers
Handly for temporary objects (objects with no owners) - the pool 'locationName' owns any amount of objects, preventing their destuction, extends lifetime.
Do not forget to clean the pool later! Typical use:
int jTempMap = JValue.addToPool(JMap.object(), "uniquePoolName")
int jKeys = JValue.addToPool(JMap.allKeys(someJMap), "uniquePoolName")
and anywhere later:
JValue.cleanPool("uniquePoolName")- Found in:
- JContainers
- Found in:
- JContainers
--- Mics. functionality
Returns shallow copy (won't copy child objects)
- Found in:
- JContainers
Returns deep copy
- Found in:
- JContainers
Tests whether given object identifier is not the null object.
Note that many other API functions already check that too.- Found in:
- JContainers
Returns true if the object is map, array or formmap container
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers
Returns true, if the container is empty
- Found in:
- JContainers
Returns amount of items in the container
- Found in:
- JContainers
Removes all items from the container
- Found in:
- JContainers
JSON serialization/deserialization:
Creates and returns a new container object containing contents of JSON file
- Found in:
- JContainers
Parses JSON files in a directory (non recursive) and returns JMap containing {filename, container-object} pairs.
Note: by default it does not filter files by extension and will try to parse everything- Found in:
- JContainers
Creates a new container object using given JSON string-prototype
- Found in:
- JContainers
Writes the object into JSON file
- Found in:
- JContainers
Returns type of resolved value. 0 - no value, 1 - none, 2 - int, 3 - float, 4 - form, 5 - object, 6 - string
- Found in:
- JContainers
Path resolving:
Returns true, if it's possible to resolve given path, i.e. if it's possible to retrieve the value at the path.
For ex. JValue.hasPath(container, ".player.health") will test whether @container structure close to this one - {'player': {'health': health_value}}- Found in:
- JContainers
Attempts to retrieve value at given path. If fails, returns @default value
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers
boolfunctionsolveFltSetter(intobject, stringpath, floatvalue, boolcreateMissingKeys=false)NativeGlobalAttempts to assign the value. If @createMissingKeys is False it may fail to assign - if no such path exist.
With 'createMissingKeys=true' it creates any missing path element: solveIntSetter(map, ".keyA.keyB", 10, true) on empty JMap creates {keyA: {keyB: 10}} structure- Found in:
- JContainers
boolfunctionsolveIntSetter(intobject, stringpath, intvalue, boolcreateMissingKeys=false)NativeGlobal- Found in:
- JContainers
boolfunctionsolveStrSetter(intobject, stringpath, stringvalue, boolcreateMissingKeys=false)NativeGlobal- Found in:
- JContainers
boolfunctionsolveObjSetter(intobject, stringpath, intvalue, boolcreateMissingKeys=false)NativeGlobal- Found in:
- JContainers
boolfunctionsolveFormSetter(intobject, stringpath, Formvalue, boolcreateMissingKeys=false)NativeGlobal- Found in:
- JContainers
Evaluates piece of lua code. Lua support is experimental
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers
- Found in:
- JContainers