GetFormDescriptions - DbSkseFunctions | Skyrim SE

Found in:

Dylbills PE

string[]functionGetFormDescriptions(Form[]akForms, intsortOption=0, intmaxCharacters=0, stringoverMaxCharacterSuffix="..", stringnewLineReplacer="", intnoneStringType=0, stringnullFormString="ull")NativeGlobal

Description

Documentation Comment

get form descriptions for akForms.
if maxCharacters is greater than 0, limits the number of characters for descriptions.
If a description exceeds maxCharacters, adds the overMaxCharacterSuffix to the end of the description.
if noneStringType is 1 and a description is empty, "", gets editorID instead of the description
if noneStringType is 2 and a description is empty, "", gets form ID instead of the description
if akForm is none, sets nullFormString for that form.
Sort options are as follows. Note, to sort by editor Id reliably, po3 tweaks must be installed.
0 = not sorted,
1 = sorted by description ascending,
2 = sorted by description descending,
3 = by form name ascending,
4 = by form name descending,
5 = by form editor Id name ascending,
6 = by form editor Id name descending,
7 = by form Id ascending,
8 = by form Id descending

[DEV SERVER] Loading description...

Caveats

Parameters

Form[]akForms

intsortOption=0

intmaxCharacters=0

stringoverMaxCharacterSuffix=".."

stringnewLineReplacer=""

intnoneStringType=0

stringnullFormString="ull"

Examples

Auto-Generated Example

Form[] myFormArray__akForms
int myInt__sortOption
int myInt__maxCharacters
string myString__overMaxCharacterSuffix
string myString__newLineReplacer
int myInt__noneStringType
string myString__nullFormString

string[] returnedValue = DbSkseFunctions.GetFormDescriptions(myFormArray__akForms, myInt__sortOption, myInt__maxCharacters, myString__overMaxCharacterSuffix, myString__newLineReplacer, myInt__noneStringType, myString__nullFormString)Form[] myFormArray__akForms
int myInt__sortOption
int myInt__maxCharacters
string myString__overMaxCharacterSuffix
string myString__newLineReplacer
int myInt__noneStringType
string myString__nullFormString

string[] returnedValue = DbSkseFunctions.GetFormDescriptions(myFormArray__akForms, myInt__sortOption, myInt__maxCharacters, myString__overMaxCharacterSuffix, myString__newLineReplacer, myInt__noneStringType, myString__nullFormString)