Utility Script
Revision as of 00:13, 30 October 2013 by imported>CraftySentinel (→Global Functions: Added Unlisted Vanilla Functions for the sake of completeness)
Collection of generic utility global functions
Definition
ScriptName UtilityProperties
None
Member Functions
None
Global Functions
| Function | Description |
|---|---|
| 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. |
| 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. |
| 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() | |
| IntGetCurrentBudget(Int aiBudgetNumber) | |
| Bool OverBudget(Int aiBudgetNumber) | |
| String GetBudgetName(Int aiBudgetNumber) |
* Frame Rate Capture functions were only available during beta versions, and are added here for completeness.
SKSE Global Functions
| Function | Description |
|---|---|
| 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. |
Events
None