The Utility Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

No properties found.

No events found.

• Found in:
  • Vanilla
  • F4SE

  varfunctionCallGlobalFunction(stringasScriptName, stringasFuncName, var[]aParams)NativeGlobal

  Calls a global function synchronously and returns whatever that function does.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionCallGlobalFunctionNoWait(stringasScriptName, stringasFuncName, var[]aParams)NativeGlobal

  Calls a global function asynchronously. Script execution continues immediately without waiting for the global function you called to finish (or even start).

• Found in:
  • Vanilla
  • F4SE

  stringfunctionGameTimeToString(floatafGameTime)NativeGlobal

  Converts the passed-in game time (in game days passed) to a string detailing the date and time it represents. The resulting format is: "MM/DD/YYYY HH:MM" and uses a 24-hour clock.

• Found in:
  • Vanilla
  • F4SE

  floatfunctionGetCurrentGameTime()NativeGlobal

  Obtains the current game time in terms of game days passed (same as the global variable)

• Found in:
  • Vanilla
  • F4SE

  floatfunctionGetCurrentRealTime()NativeGlobal

  Gets the number of real-world seconds that have elapsed since the game has launched. This time does not count time the game has been alt-tabbed, or other cases where the game has been frozen (i.e. during a save or load, time in a menu is counted). This function is most useful for timing a long operation.

• Found in:
  • Vanilla
  • F4SE

  intfunctionGetCurrentStackID()NativeGlobalDebugOnly

  Obtains the stack ID of the currently running stack where this function is called.

• Found in:
  • Vanilla
  • F4SE

  boolfunctionIsInMenuMode()NativeGlobal

  Obtains whether the game is currently in "menu mode" or not. Menu mode is basically defined as whenever the game is paused, usually because some menu is showing. Dialogue does not pause the game, and so does not put the game into "menu mode".

• Found in:
  • Vanilla
  • F4SE

  intfunctionRandomInt(intaiMin=0, intaiMax=100)NativeGlobal

  Generates a random integer between the minimum and maximum values (inclusive).

• Found in:
  • Vanilla
  • F4SE

  floatfunctionRandomFloat(floatafMin=0.0, floatafMax=1.0)NativeGlobal

  Generates a random floating point number between the minimum and maximum values (inclusive).

• Found in:
  • Vanilla
  • F4SE

  voidfunctionSetINIFloat(stringini, floatvalue)NativeGlobalDebugOnly

  Sets a float value in the Fallout 4 Initialization Files (.ini).

• Found in:
  • Vanilla
  • F4SE

  voidfunctionSetINIInt(stringini, intvalue)NativeGlobalDebugOnly

  Sets an integer value in the Fallout 4 Initialization Files (.ini).

• Found in:
  • Vanilla
  • F4SE

  voidfunctionSetINIBool(stringini, boolvalue)NativeGlobalDebugOnly

  Sets a boolean value in the Fallout 4 Initialization Files (.ini).

• Found in:
  • Vanilla
  • F4SE

  voidfunctionSetINIString(stringini, stringvalue)NativeGlobalDebugOnly

  Sets a string value in the Fallout 4 Initialization Files (.ini).

• Found in:
  • Vanilla
  • F4SE

  voidfunctionWait(floatafSeconds)NativeGlobal

  Pauses the script for at least the specified amount of time. This function is latent. Time will not be counted while the player is in a menu.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionWaitGameTime(floatafHours)NativeGlobal

  Pauses the script for at least the specified amount of game time. This function is latent.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionWaitMenuMode(floatafSeconds)NativeGlobal

  Pauses the script for at least the specified amount of time. This function is latent. Time will be counted while the player is in a menu.

• Found in:
  • Vanilla
  • F4SE

  stringfunctionCaptureFrameRate(intnumFrames)NativeGlobalDebugOnly

  Gets you a string describing the frame rate for a certain number of frames
  (String will be no longer than 1K characters long, separated by commas)

• Found in:
  • Vanilla
  • F4SE

  voidfunctionEnterTestData(stringastestType, stringastestMatter, stringastestDetails, stringastestResultContext, stringastestResult)NativeGlobalDebugOnly

  Sends the passed in test data to the tests website.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionPostStartUpTimes()NativeGlobalDebugOnly

  Sends the start up times to the tests website.

• Found in:
  • Vanilla
  • F4SE

  voidfunctionStartFrameRateCapture()NativeGlobalDebugOnly

  Starts or ends a frame rate capture -- then you can get the min or max since
  frame capture started at any time

• Found in:
  • Vanilla
  • F4SE

  voidfunctionEndFrameRateCapture()NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  floatfunctionGetAverageFrameRate()NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  floatfunctionGetMinFrameRate()NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  floatfunctionGetMaxFrameRate()NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  stringfunctionGetCurrentMemory()NativeGlobalDebugOnly

  Memory tracking functions - only available if memory tracking is turned on

• Found in:
  • Vanilla
  • F4SE

  intfunctionGetBudgetCount()NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  stringfunctionGetCurrentBudget(intaiBudgetNumber)NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  stringfunctionGetBudgetLimit(intaiBudgetNumber)NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  boolfunctionOverBudget(intaiBudgetNumber)NativeGlobalDebugOnly
• Found in:
  • Vanilla
  • F4SE

  stringfunctionGetBudgetName(intaiBudgetNumber)NativeGlobalDebugOnly
• Found in:
  • F4SE

  var[]functionVarToVarArray(varv)NativeGlobal

  Converts Var to Var[]

• Found in:
  • F4SE

  varfunctionVarArrayToVar(var[]v)NativeGlobal

  Converts Var[] to Var