DbMiscFunctions

PlaceAtMe but moves placed ref using MoveToLocalOffset function. PlaceAtMeRef is centerRef, new placed ref is RefToMove.

Apply Havok Impulse from left / right angle + Z direction. No requirements.
Examples:
ApplyHavokImpulseLocal(MyRef, 0, 5, 10) applies havok impulse so the ref flies forward and up
ApplyHavokImpulseLocal(MyRef, 90, -5, 10) applies havok impulse so the ref flies to the right and down

Get the full Version Text displayed in the journal menu e.g "1.5.97.0.8 (SKSE64 2.0.20 rel 65)"
The Journal Menu system page must be open for this function to work.
Use RegisterForMenu("Journal Menu") and the OnMenuOpen event to ensure the Journal Menu is open.
Or, if your mod has an MCM, this will work when the MCM Menu is open, so use OnConfigOpen in your MCM script.
requires skse

Get the Skyrim Version Text displayed in the journal menu, e.g "1.5.97"
The Journal Menu system page must be open for this function to work.
Use RegisterForMenu("Journal Menu") and the OnMenuOpen event to ensure the Journal Menu is open.
Or, if your mod has an MCM, this will work when the MCM Menu is open, so use OnConfigOpen in your MCM script.
requires skse

requires skse

show or hide creation kit markers in Game
If ShowMarkers == true, shows them, otherwise hides them.
If moveToRef == None (default), moves player to either whiterun or markarth fast travel markers.
Must move player to new area after changing bShowMarkers ini so cells reload to display markers.
no requirements

Enable all the object refs in akCell that match formTypeFilter.
If formTypeFilter is 0 (default) enable all refs in the cell.
Requires skse.

Disable all the object refs in akCell that match formTypeFilter.
If formTypeFilter is 0 (default) disable all refs in the cell.
Requires skse.

create new xMarker ObjectReference
if PlaceAtMeRef == none (default) places new marker at the player.
no requirements

unequip all items on actor with delay in between.
requires skse and po3's papyrus extender

remove all items from ref which must be a container or actor to optional otherContainer
requires skse and papyrus extender and SSE
use Form[] Items = PO3_SKSEFunctions.AddAllInventoryItemsToArray(Ref, abNoEquipped, abNoFavorited, abNoQuestItem) for LE

Drop all items from ref, Ref must be a container or actor.
If dropIndividual is true, drops multiple of the same item time individually so they don't stack. If false, items are dropped stacked.
Requires SKSE

Drop the NumofItems from ref individually so they don't stack.
If NumofItems == 0, drops all of the item from ref.
No requirements

add shout to player if necessary and unlock all words of power.
requires skse

requires skse

check if location or any of it's parents has the keyword
Requires Papyrus Extender && SKSE

no requirements.

requires skse. Get name of form. Checks for ObjectReference. return default nullString if not found.

Returns true if the Mod has at least 1 form of type
Requires papyrus extender and skse

Like HasKeywordString but returns true if multiple esp's have keyWords with the same name added.
Requires SKSE

If AllKeywords == false (default) returns true if the akForm has any keyword in the akList formlist.
If allKeywords == true, only returns true if the akForm has all keywords in the akList.
No requirements

If AllKeywords == false (default) returns true if the akForm has any keyword in the akList array.
If allKeywords == true, only returns true if the akForm has all keywords in the akList.
No requirements

If AllKeywords == false (default) returns true if the akForm has any keyword in the StorageUtil Form list.
If allKeywords == true, only returns true if the akForm has all keywords in the List.
Requires skse and PapyrusUtil

If AllKeywords == false (default) returns true if the akForm has any keyword in the JsonUtil Form list.
If allKeywords == true, only returns true if the akForm has all keywords in the List.
Requires skse and PapyrusUtil

Copy keywords from form A onto form B.
Requires skse and papyrus extender

Requires SKSE

is the index in string s between the StartKey and EndKey.
Example:
String s = "() (Some String)"
Bool b = DbMiscFunctions.IsStringIndexBetween(s, 4, "(", ")") ;true
Bool bb = DbMiscFunctions.IsStringIndexBetween(s, 2, "(", ")") ;false
Bool bbb = DbMiscFunctions.IsStringIndexBetween(s, 0, "(", ")") ;false
requires skse

requires skse. Convert int to hex string.
if result string length is less than minDigits,
adds 0's to the start for positive numbers, or f's to the start for negative numbers.
default is 8 (for form IDs)

requires skse
If TreatAsNegative == true, returns hex as negative number.
Example:
ConvertHexToInt("FD4", true) returns -44
ConvertHexToInt("FD4", false) returns 4052
Note that if the hex is 8 digits in length (such as form IDs) and starts with "F" it is always treated as negative natively by papyrus.

For convenience. Returns the akForm ID as a hex string.
requires SKSE.

like Math.Pow, calculates x to the y power, but uses only integers which is more accurate if not needing floats.
Only works for positive y values.

returns floor of the square root of i.

returns absolute value of i.

rounds the float input and returns int
5.4 returns 5
5.5 returns 6

rounds the float input and returns float
5.4 returns 5.0
5.5 returns 6.0

rounds the float down to the specified decimal places
Example:
RoundDownToDec(1.2345, 2) returns 1.23
RoundDownToDec(4.5678, 3) return 4.567
not 100% accurate, limited by string as float conversion.
Example: RoundDownToDec(100.78945, 2) returns 100.779999999

Same as RoundDownToDec but returns string instead of float. In this case RoundDownToDecString(100.78945, 2) returns "100.78"

requires skse

requires SKSE. Splits string by divider and returns as float array.

requires SKSE. Splits string by divider and returns as int array.

Sort========================================================================================
if Direct == true, sorts the passed in akArray directly
if Direct == false, Passed in array is unaffected and returns new array (that is akArray sorted).
if Direct == false requires skse to create the new array.

requires skse.

Opposite of StringUtil.Split. Convert string array to single string, elements separated by divider.
If IgnoreDuplicates == true, only adds an element to the string once

If IgnoreDuplicates == true, only adds an element to the string once

If IgnoreDuplicates == true, only adds an element to the string once

Trace
No requirements.

TraceUser
No requirements.

Notification
No requirements.

MessageBox
No requirements.

ExtendedVanillaMenus.MessageBox
requires ExtendedVanillaMenus and skse

WriteToFile
requires PapyrusUtil and skse

Join up to 20 strings into a single string seperated by the Divider
Stops joining at the first empty "" string it finds.
no requirements

Join all 20 strings into a single string seperated by the Divider
no requirements

get the current screen resolution.
[0] = X or width
[1] = Y or height
requires skse

Get game settings for soul levels
no requirements

Get game setting soul level names
no requirements

Get the actor soul size. 0 = petty, 1 = lesser, 2 = Common, 3 = Greater, 4 = Grand, 5 = Black (for NPCs)
No requirements

Get actor soul size as string.
no requirements

the IsEquipped function doesn't work for spells, hence the need for this function.
no requirements

requires skse and DbSkseFunctions.psc version 6.7 or greater

Is the akActor an NPC?
no requirements

Returns true if akActor is moving.
I've only tested on NPC humanoid actors. Not sure if it works for other types.
No requirements

requires skse. Sort Actors in akArray by their display name.

requires skse. Sort ObjectReferences in akArray by their display name.

requires skse. Sort Forms in akArray by their name.

requires skse, put all actor names of actors in akArray to a string array and return.

requires skse, put all ObjectReference names of ObjectReferences in akArray to a string array and return.

requires skse, put all Form names of Forms in akArray to a string array and return.

requires skse, put all Form names of Forms in akList to a string array and return.

requires skse, put all Form names of Forms in akList to a single string seperated by divider. Default new line.

Requires skse. Add all forms in akList to new form array.

Add all forms in akArray to akList

no requirements

no requirements

no requirements

no requirements

no requirements

no requirements

wait while the keyCode is pressed.
If the key is released before the secondsToWait time has elapsed, returns false.
If the secondsToWait time elapses and the keyCode is still pressed, returns true.
Requires skse

Like WaitWhileKeyIsPressed but this is an interval wait version.
Wait while the keyCode is pressed.
Returns true if the entire waitCount finishes.
Returns false if the key was released before the waitCount is finished.
The wait interval should be a small value (default is 0.01) for this function to be accurate.
Requires skse

requires skse, register for all keys between min and max. Default is 1 to 281, or all keys.

requires skse

Are all the hotkeys pressed?
If onlyTheseKeys is true, (default), returns true only if all the hotkeys are pressed and no other keys are pressed.
requires skse.

validate indexes first.

validate indexes first.

validate indexes first.

validate indexes first.

validate indexes first.

validate indexes first.

validate indexes first.

remove all duplicates in Json int / float / string / form lists, leaving only 1 of each element in the list.
If asceding == true (default) removes duplicate entries from the start of the list first,
Else removes duplicates from end of list first. ======================================================================================

Opposite of String.Split()
Join all elements in Json Int List to a single string seperated by divider. =================================================================================

requires skse and papyrusUtil. Get the string for a form type int.
Exampe: FormTypeToString(SomeMiscObj.GetType()) returns "Misc"
can specify another file other than "Data/interface/DbFormTypeStrings.txt" if desired

requires skse and papyrusUtil.
Get form type strings within a range.

requires skse and papyrusUtil. Get the string for keycode.
Exampe: GetKeyCodeString(28) returns "Enter"
can specify another file other than "Data/interface/DbKeyCodeStrings.txt" if desired

requires skse

requires skse

Return mod name string that the FormID comes from. e.g "Skyrim.esm"
assumes FormID is 8 digits long.
Requires skse

Return mod name string that the akForm comes from. e.g "Skyrim.esm"
Requires skse

get common form types without SKSE =======================================================================
These functions mimic the main Categories in the creation kit.
GetActorFormType corresponds to the Actor category. GetAudioFormType corresponds to the Audo category ect.
Note, can pass in ObjectReference's and it will auto get baseObject and return type.

for base item types in player inventory

includes all of the above form types

Same as above but returns strings instead of ints==============================================================================
If TypeStrings == none, returns the ScriptName of type. Can pass in string array to return different strings for translations.

for base item types in player inventory

includes all of the above types.

Useful for force closing the inventory menu, or forcing the player to sheathe their weapon.
No requirements

add and remove akForm from actor silently.
This is useful for instance after changing an actors speed via akActor.SetAv("SpeedMult", 110)
Or after changing armor model paths, or on the player after changing item names if in the inventory or container menu, will display visually the name change.
No requirements

used to update menus while they are open.
Example, changing a map marker property (name, icon or visibility) while the map menu is open

requires SKSE and Papyrus Extender
swap all worn equipment between actor A and B.

Set all ActorValues to Values on akActor
no requirements

Mod all ActorValues with Values on akActor
no requirements

return all actor values in ActorValueStrings to float array.
if DArrays == none, requires skse. Can pass in DynamicArrays form to not use skse.

same as GetActorValues but returns for instance "Health = 100.0" in string array instead of float values
if ActorValueStrings == none, uses ActorValues for strings.
can specify ActorValueStrings for translations. Indexes in ActorValues and ActorValuesStrings should match.
if DArrays == none, requires skse. Can pass in DynamicArrays form to not use skse.

same as GetActorValueStrings but puts all values in a single string divided by Divider.
if ActorValueStrings == none, uses ActorValues for strings.
can specify ActorValueStrings for translations. Indexes in ActorValues and ActorValuesStrings should match.
no requirements

return all Base actor values in ActorValueStrings to float array.
if DArrays == none, requires skse. Can pass in DynamicArrays form to not use skse.

same as GetBaseActorValues but returns for instance "Health = 100.0" in string array instead of float values
if ActorValueStrings == none, uses ActorValues for strings.
can specify ActorValueStrings for translations. Indexes in ActorValues and ActorValuesStrings should match.
if DArrays == none, requires skse. Can pass in DynamicArrays form to not use skse.

same as GetBaseActorValueStrings but puts all values in a single string divided by Divider.
if ActorValueStrings == none, uses ActorValues for strings.
can specify ActorValueStrings for translations. Indexes in ActorValues and ActorValuesStrings should match.
no requirements

return actor values of akActor from actor values in file to float array.
can specify your own file path. Look at the structure of DbActorValues.txt to make another file.
requires skse and papyrusUtil.

same as GetActorValuesFromFile but returns for instance "Health = 100.0" in string array instead of float values
can specify your own file path. Look at the structure of DbActorValues.txt to make another file.
requires skse and papyrusUtil.

same as GetActorValueStringsFromFile but puts all the values in a single string seperated by Divider
can specify your own file path. Look at the structure of DbActorValues.txt to make another file.
requires skse and papyrusUtil.