R3vo – User talk
The Functions Viewer allows you to view all functions, modded or default that are defined in CfgFunctions.
Access
The Functions Viewer can be opened via
- the Debug Console
- executing
[] spawn BIS_fnc_help
- the Eden Editor Menu Bar
Interface
Config Source Combobox
Choose which config file should be used, can be:
TAG Combobox
Select the TAG the function uses. The TAG usually indicates for which project, mod or addon a function was created for. To learn more visit Functions Library.
Category
Select the category of the function. Categories can for example be: Actions, Math or Modules. To learn more visit Functions Library.
Functions List
The functions list contains all functions of given TAG and category and is sorted alphabetically. When a function is selected, Ctrl + C will copy its function name to the clipboard. By pressing a letter key on the keyboard one can quickly jump to the functions which begin with that letter.
Name Text Field
Shows the name of the function. It can be selected and copied.
Path Text Field
Shows the path to the original function file.
Code Text Field
This area will show the code of the function and can be scrolled left and right or up and down. Most functions how a function header at the top of the code which shows useful information about the function, its parameters and return values.
Recompile All Button
Pressing that button will recompile all functions. However, this button is only activated if allowFunctionsRecompile is set to one in the description.ext. Visit Description.ext/Functions Library: Recompiling for more information.
Recompile Selected
Pressing this button will recompile the selected function.
Close
Closes the Functions Viewer.
Shortcuts
The config viewer supports a very basic search functionality. If you focus either the classes list or the attributes list and start typing it will search for a match in the given list.
Key | Effect |
---|---|
Esc | Closes the Functions Viewer |
Functions List
Key | Effect |
---|---|
A...Z | Quickly browse through the functions |
Ctrl + C | Copy function name of selected function to the clipboard |
Code Field
Key | Effect |
---|---|
Ctrl + A | Selects all code |
Ctrl + C | Copy selected code to clipboard |
Alternative Tools
Listed here are some mods which improve the Functions Viewer. If you created one you can add it to the list too.