Difference between revisions of "GetFormDescription"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
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 =...")
 
imported>Jazzisparis
 
Line 1: Line 1:
{{Function
{{Function
  |origin = JIP
  |origin = JIP
  |summary = Returns the <i>Description</i> text of the passed form.
  |summary = Returns the '''Description''' text of the specified form (e.g. Note, Perk, Message, Terminal, Weapon Mod, Challenge, Loading Screen, etc.).
  |name = GetFormDescription
  |name = GetFormDescription
  |returnType = description:string_var
  |returnType = description:string_var
Line 15: Line 15:
  let sDescr := GetFormDescription ModNV127mmPistolSilencer
  let sDescr := GetFormDescription ModNV127mmPistolSilencer
}}
}}
==Notes==
*Obviously, this function will only work with form types which have <i>Description</i> data.
==See Also==
==See Also==
*[[SetFormDescription]]
[[Category:Functions_(JIP)]]
[[Category:Functions_(JIP)]]
[[Category:Miscellaneous Functions (JIP)]]
[[Category:Miscellaneous Functions (JIP)]]

Latest revision as of 02:22, 9 October 2015

< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Description

Returns the Description text of the specified form (e.g. Note, Perk, Message, Terminal, Weapon Mod, Challenge, Loading Screen, etc.).

Syntax

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

Example

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

See Also