Utility Script

From Creation Kit
Jump to: navigation, search

Collection of generic utility global functions

Definition

ScriptName Utility

Properties

None


Member Functions

None

Global Functions

String GameTimeToString()
  • Converts a float game time (in terms of game days passed) to a string detailing the date and time it represents.
Float GetCurrentGameTime()
  • Obtains the current game time in terms of game days passed (the same as the global variable of a similar name)
Float GetCurrentRealTime()
  • Obtains the number of real-world seconds that have passed since the game has launched (ignoring time alt-tabbed away, or other cases where the game might be frozen)
Bool IsInMenuMode()
  • Returns whether the game is currently in "menu mode" or not.
Float RandomFloat(Float afMin, Float afMax)
  • Generates a random float between the minimum and maximum (inclusive)
Int RandomInt(Int aiMin, Int aiMax)
  • Generates a random integer between the minimum and maximum (inclusive)
SetINIFloat(String ini, Float value)
  • Sets the float value of the associated INI entry.
SetINIInt(String ini, Int value)
  • Sets the integer value of the associated INI entry.
SetINIBool(String ini, Bool value)
  • Sets the boolean value of the associated INI entry.
SetINIString(String ini, String value)
  • Sets the string value of the associated INI entry.
Wait(Float afSeconds)
  • Pauses the script for at least the specified time (latent). Does not count time spent in a menu.
WaitGameTime(Float afHours)
  • Pauses the script for at least the specified amount of game time (latent).
WaitMenuMode(Float afSeconds)
  • Pauses the script for at least the specified time (latent). Does count time spent in a menu.
Int GetCurrentMemory()
  • Returns the currently used memory amount. To use any other memory functions this must be called first as it sets up the memory stats used by the other functions.
Int GetBudgetCount()
Int GetCurrentBudget(Int aiBudgetNumber)
Bool OverBudget(Int aiBudgetNumber)
String GetBudgetName(Int aiBudgetNumber)

Global Functions Only Available in Beta

Frame Rate Capture functions were only available during beta versions, and are added here for completeness.

String CaptureFrameRate(Int numFrames)
  • Gets a string describing the frame rate for a certain number of frames, the string returned will never be longer then 1,000 characters and is separated by commas.
StartFrameRateCapture()
  • Starts a frame rate capture.
EndFrameRateCapture()
  • Ends a frame rate capture.
GetAverageFrameRate()
  • Returns the average frame rate during the capture.
GetMinFrameRate()
  • Returns the minimum frame rate during the capture.
GetMaxFrameRate()
  • Returns the maximum frame rate during the capture.

SKSE Global Functions

Float GetINIFloat(String ini)
  • Returns the float value of the associated INI entry.
Int GetINIInt(String ini)
  • Returns the integer value of the associated INI entry.
Bool GetINIBool(String ini)
  • Returns the boolean value of the associated INI entry.
String GetINIString(String ini)
  • Returns the string value of the associated INI entry.
Float[] CreateFloatArray(Int size, Float fill = 0.0)
  • Creates and returns a Float array with length size, with each element initialized to fill.
  • Be careful when using this function. It is possible to create arrays longer than 128 elements, and size is treated as an unsigned integer. Negative numbers will produce extremely large values, which can cause major issues.
Int[] CreateIntArray(Int size, Int fill = 0)
  • Creates and returns an Int array with length size, with each element initialized to fill.
  • Be careful when using this function. It is possible to create arrays longer than 128 elements, and size is treated as an unsigned integer. Negative numbers will produce extremely large values, which can cause major issues.
Bool[] CreateBoolArray(Int size, Bool fill = False)
  • Creates and returns a Bool array with length size, with each element initialized to fill.
  • Be careful when using this function. It is possible to create arrays longer than 128 elements, and size is treated as an unsigned integer. Negative numbers will produce extremely large values, which can cause major issues.
String[] CreateStringArray(Int size, String fill = "")
  • Creates and returns a String array with length size, with each element initialized to fill.
  • Be careful when using this function. It is possible to create arrays longer than 128 elements, and size is treated as an unsigned integer. Negative numbers will produce extremely large values, which can cause major issues.
Form[] CreateFormArray(Int size, Form fill = None)
  • Creates and returns a String array with length size, with each element initialized to fill.
  • Be careful when using this function. It is possible to create arrays longer than 128 elements, and size is treated as an unsigned integer. Negative numbers will produce extremely large values, which can cause major issues.
Alias[] CreateAliasArray(Int size, Alias fill = None)
  • Creates and returns an Alias array with length size, with each element initialized to fill.
  • Be careful when using this function. It is possible to create arrays longer than 128 elements, and size is treated as an unsigned integer. Negative numbers will produce extremely large values, which can cause major issues.

Events

None