Background for Skyrim SE

The JLua Script

    The JLua 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:

    • 10 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    No properties found.

      Events

        No events found.

      Functions

      • floatfunctionevalLuaFlt(stringluaCode, inttransport, floatdefault=0.0, boolminimizeLifetime=true)NativeGlobal

        Evaluates piece of Lua code. The arguments are carried by @transport object.
        The @transport is any kind of object, not just JMap.
        If @minimizeLifetime is True the function will invoke JValue.zeroLifetime on the @transport object.
        It is more than wise to re-use @transport when evaluating lot of lua code at once.
        Returns @default value if evaluation fails.

        WARNING: You can transfer in/out from Lua only 24-bit integers with exact precision (+/- 16 777 216)
        Anything bigger or smaller than that will have "holes" due to how the floating point rounding works.

        Usage example:

          ; 7 from the end until 9 from the end. Returns "Lua" string
          string input = "Hello Lua user"
          string s = JLua.evaLuaStr("return string.sub(args.string, args.low, args.high)",\
              JLua.setStr("string",input, JLua.setInt("low",7, JLua.setInt("high",9 )))\
          )
        
      • intfunctionevalLuaInt(stringluaCode, inttransport, intdefault=0, boolminimizeLifetime=true)NativeGlobal
      • stringfunctionevalLuaStr(stringluaCode, inttransport, stringdefault="", boolminimizeLifetime=true)NativeGlobal
      • intfunctionevalLuaObj(stringluaCode, inttransport, intdefault=0, boolminimizeLifetime=true)NativeGlobal
      • FormfunctionevalLuaForm(stringluaCode, inttransport, Formdefault=NONE, boolminimizeLifetime=true)NativeGlobal
      • intfunctionsetStr(stringkey, stringvalue, inttransport=0)NativeGlobal

        Inserts new (or replaces existing) {key -> value} pair. Expects that @transport is JMap object, if @transport is 0 it creates new JMap object.
        Returns @transport

      • intfunctionsetFlt(stringkey, floatvalue, inttransport=0)NativeGlobal
      • intfunctionsetInt(stringkey, intvalue, inttransport=0)NativeGlobal
      • intfunctionsetForm(stringkey, Formvalue, inttransport=0)NativeGlobal
      • intfunctionsetObj(stringkey, intvalue, inttransport=0)NativeGlobal
      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.