Difference between revisions of "SetFormDescription"
Jump to navigation
Jump to search
imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Sets the '''Description''' text of the specified form (e.g. Note, Perk, Message, Terminal, Weapon Mod, Challenge, Loading Screen, etc.)....") |
imported>Jazzisparis |
||
| Line 9: | Line 9: | ||
|Type = ref | |Type = ref | ||
}}{{FunctionArgument | }}{{FunctionArgument | ||
|Name = | |Name = descriptionText | ||
|Type = | |Type = formattedString | ||
}}{{FunctionArgument | |||
|Name = formatVars(up to 20) | |||
|Optional = y | |||
}} | }} | ||
|example = SetFormDescription McCarranFieldNote01 "Put some text here" | |example = SetFormDescription McCarranFieldNote01 "Put some text here" | ||
}} | }} | ||
==Notes== | |||
*<i>descriptionText</i> supports [[String Formatting|string formatting]], and up to 20 variables may be used. | |||
==See Also== | ==See Also== | ||
*[[GetFormDescription]] | *[[GetFormDescription]] | ||
[[Category:Functions_(JIP)]] | [[Category:Functions_(JIP)]] | ||
[[Category:Miscellaneous Functions (JIP)]] | [[Category:Miscellaneous Functions (JIP)]] | ||
Latest revision as of 03:05, 9 October 2015
< [[::Category:Functions|Category:Functions]]
A function added by the JIP NVSE Plugin.
Description
Sets the Description text of the specified form (e.g. Note, Perk, Message, Terminal, Weapon Mod, Challenge, Loading Screen, etc.).
Syntax
(success:0/1) SetFormDescription baseForm:ref descriptionText:formattedString formatVars(up to 20)
Example
SetFormDescription McCarranFieldNote01 "Put some text here"
Notes
- descriptionText supports string formatting, and up to 20 variables may be used.