Functions Viewer – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{SideTOC}}" to "{{TOC|side}}")
m (Text replacement - "Category:Eden Editor" to "Eden Editor")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TOC|side}}
{{TOC|side}}
The '''Function Viewer''' can be accessed through the [[Mission Editor: Debug Console (Arma 3)|Debug Console]] or [[Eden Editor]] (Menu Strip > Tools).<br>
The Functions Viewer allows you to view all functions, modded or default that are defined in CfgFunctions.
It's useful when searching for a specific function, copying its code, or looking at its function header.
[[File:A3 FunctionViewer Overview.png|thumb|The Functions Viewer UI in Arma 3.]]
 
== Access ==
 
The Functions Viewer can be opened via
* the [[Arma 3: Debug Console|Debug Console]]
* executing <sqf inline>[] spawn BIS_fnc_help</sqf>
* the [[:Category:Eden Editor|Eden Editor]] [[Eden Editor: Menu Bar|Menu Bar]]
 


== Interface ==
== Interface ==


[[File:A3 FunctionViewer Overview.png|800px|center]]
=== Config Source Combobox ===
=== Config File ===


Choose which config file should be used, can be:
Choose which config file should be used, can be:
# [[campaignConfigFile]]
* [[campaignConfigFile]]
# [[missionConfigFile]]
* [[missionConfigFile]]
# [[configFile]]
* [[configFile]]


=== TAG ===
=== TAG Combobox ===


Select the TAG the function uses. The TAG usually indicates for which project, mod or addon a function was created for.
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 (Arma 3)#Adding a Function|Functions Library]].
To learn more visit [[Arma 3: Functions Library#Adding a Function|Functions Library]].


=== Category ===
=== Category Combobox ===


Select the category of the function. Categories can for example be: Actions, Math or Moduls.
Select the category of the function. Categories can for example be: Actions, Math or Modules.
To learn more visit [[Functions_Library_(Arma_3)#Adding_a_Function|Functions Library]].
To learn more visit [[Arma 3: Functions Library#Adding_a_Function|Functions Library]].


=== Function List ===
=== Functions List ===


The functions list contains all functions of given TAG and category and is sorty alphabetically. When a function is selected, pressing '''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.
The functions list contains all functions of given TAG and category and is sorted alphabetically.


=== Name ===
=== Name Text Field ===


Shows the name of the function. It can be selected and copied.
Shows the name of the function. It can be selected and copied.


=== Path ===
=== Path Text Field ===


Shows the path to the original function file.
Shows the path to the original function file.


=== Function Code ===
=== 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 have a function header at the top of the code that 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 in Eden Editor or if function recompiling is [[Description.ext#allowFunctionsRecompile|allowed]] in [[Description.ext]].
 
=== Recompile Selected Button ===
 
Pressing this button will recompile the selected function.
 
=== Close Button ===
 
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.
 
{| class="wikitable"
|-
! Key !! Effect
|-
| {{Controls|Escape}} || Closes the Functions Viewer
|}
 
=== Functions List ===


This area will show the code of the function and can be scrolled left and right or up and down. By pressing '''CTRL + A''' and '''CTRL + C''' all code can be copied to the clipboard.<br>
{| class="wikitable"
Most functions how a function header at the top of the code which shows useful information about the function, its parameters and return values.
|-
! Key !! Effect
|-
| {{Controls|A..Z}} || Quickly browse through the functions
|-
| {{Controls|Ctrl|C}} || Copy function name of selected function to the clipboard
|}


=== Recompile All ===
=== Code Field ===


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 (Arma 3)#Recompiling|Functions Library: Recompiling]] for more information.
{| class="wikitable"
|-
! Key !! Effect
|-
| {{Controls|Ctrl|A}} || Selects all code
|-
| {{Controls|Ctrl|C}} || Copy selected code to clipboard
|}


=== Recompile Selected ===
{{GameCategory|arma3|Editing}}


Exactly the same as point 8 with the exception that only the selected function will be recompiled.


=== Close ===
== Alternative Tools ==


Closes the function viewer. It can however also be closed by pressing '''ESC'''.
Listed here are some mods which improve the Functions Viewer. If you created one you can add it to the list too.
* {{Link|link= https://steamcommunity.com/sharedfiles/filedetails/?id=2369477168|text= '''Advanced Developer Tools''' by Leopard20}}
* {{Link|link= https://steamcommunity.com/sharedfiles/filedetails/?id=1862880106|text= '''Extended Function Viewer''' by Connor}}
* {{Link|link= https://steamcommunity.com/sharedfiles/filedetails/?id=623475643|text= '''3den Enhanced''' by R3vo'''}}




{{GameCategory|arma3|Editing}}
{{GameCategory|arma3|Editing}}

Latest revision as of 13:26, 9 July 2023

The Functions Viewer allows you to view all functions, modded or default that are defined in CfgFunctions.

The Functions Viewer UI in Arma 3.

Access

The Functions Viewer can be opened via


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 Combobox

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.

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 have a function header at the top of the code that 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 in Eden Editor or if function recompiling is allowed in Description.ext.

Recompile Selected Button

Pressing this button will recompile the selected function.

Close Button

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.

Retrieved from "https://community.bistudio.com/wiki?title=Arma_3:_Functions_Viewer&oldid=342171"