GetFormDescription

From the Fallout3 GECK Wiki
Revision as of 20:30, 23 September 2015 by imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Returns the <i>Description</i> text of the passed form. |name = GetFormDescription |returnType = description:string_var |arguments =...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Description

Returns the Description text of the passed form.

Syntax

[help]
(description:string_var) GetFormDescription baseForm:ref

Example

let sDescr := GetFormDescription ActionBoy
let sDescr := GetFormDescription GSFixedRadioMsg
let sDescr := GetFormDescription ModNV127mmPistolSilencer

Notes

  • Obviously, this function will only work with form types which have Description data.

See Also