DumpCommandWikiDoc

A function added by the New Vegas Script Extender version 6.3.6.

Description

Dumps GECK Wiki-style documentation for the specified command to nvse.log. Useful for documenting new functions.

Note that for certain plugins, the origin name and Category:Functions (?) category name may be incorrect due to naming scheme inconsistencies. In those cases, create an issue for xNVSE on github so that the correct strings may be hardcoded.

This function can only be used in a script, not as a Condition.

Syntax

[help]

DumpCommandWikiDoc commandName:string 

Or:

DumpWikiDoc commandName:string 

Example

• From console:

DumpWikiDoc "Ar_Cat"

Resulting text in nvse.log:

{{Function
 |origin = JIP
 |originVersion = [TO SPECIFY]
 |summary = [TO DOCUMENT]
 |name = ar_Cat
 |alias = pinto_Cat
 |returnVal = [Insert return val name here, or remove this arg]
 |returnType = Float [remove this arg if func returns nothing]
 |conditionFunc = Script
 |arguments =
  {{FunctionArgument
   |Name = [Enter Arg Name]
   |Type = Integer
  }}{{FunctionArgument
   |Name = [Enter Arg Name]
   |Type = Integer
  }}{{FunctionArgument
   |Name = [Enter Arg Name]
   |Type = Integer
   |Optional = y
  }}
}}
[[Category:Functions (JIP)]]
[[Category:? [Add other relevant categories] ]]