GetFormDescription - DbSkseFunctions | Skyrim SE

Found in:

Dylbills PE

stringfunctionGetFormDescription(FormakForm, intmaxCharacters=0, stringoverMaxCharacterSuffix="..", stringnewLineReplacer="", intnoneStringType=0, stringnullFormString="ull")NativeGlobal

Description

Documentation Comment

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 newLineReplacer is not empty "", replaces new lines in description with newLineReplacer
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, returns nullFormString

[DEV SERVER] Loading description...

Caveats

Parameters

FormakForm

intmaxCharacters=0

stringoverMaxCharacterSuffix=".."

stringnewLineReplacer=""

intnoneStringType=0

stringnullFormString="ull"

Examples

Auto-Generated Example

Form myForm__akForm
int myInt__maxCharacters
string myString__overMaxCharacterSuffix
string myString__newLineReplacer
int myInt__noneStringType
string myString__nullFormString

string returnedValue = DbSkseFunctions.GetFormDescription(myForm__akForm, myInt__maxCharacters, myString__overMaxCharacterSuffix, myString__newLineReplacer, myInt__noneStringType, myString__nullFormString)Form myForm__akForm
int myInt__maxCharacters
string myString__overMaxCharacterSuffix
string myString__newLineReplacer
int myInt__noneStringType
string myString__nullFormString

string returnedValue = DbSkseFunctions.GetFormDescription(myForm__akForm, myInt__maxCharacters, myString__overMaxCharacterSuffix, myString__newLineReplacer, myInt__noneStringType, myString__nullFormString)