R3vo – User talk

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
{{TOC|side}}
{{User:Lou_Montana/Sandbox2
The Functions Viewer allows you to view all functions, modded or default that are defined in CfgFunctions.
[[File:A3 FunctionViewer Overview.png|thumb|The Functions Viewer UI in Arma 3.]]


= Access =
|selected= 2
The Functions Viewer can be opened via
* the [[Arma 3: Debug Console|Debug Console]]
* executing {{ic|[] [[spawn]] [[BIS_fnc_help]]}}
* the [[Eden Editor]] [[Eden Editor: Menu Bar|Menu Bar]]


= Interface =
|title1= {{Icon|arma2oa|link=}} {{arma2oa}} {{Icon|tkoh|link=}} {{tkoh}}
== Config Source Combobox ==
|content1=
Choose which config file should be used, can be:
{{RV|type=command
* [[campaignConfigFile]]
* [[missionConfigFile]]
* [[configFile]]


== TAG Combobox ==
|game1= arma2oa
Select the TAG the function uses. The TAG usually indicates for which project, mod or addon a function was created for.
|version1= 1.51
To learn more visit [[Functions Library (Arma 3)#Adding a Function|Functions Library]].


== Category ==
|game2= tkoh
Select the category of the function. Categories can for example be: Actions, Math or Modules.
|version2= 1.00
To learn more visit [[Functions_Library_(Arma_3)#Adding_a_Function|Functions Library]].


== Functions List ==
|gr1= Lights
The functions list contains all functions of given TAG and category and is sorted alphabetically.
|gr2= Weapons


== Name Text Field ==
|arg= local
Shows the name of the function. It can be selected and copied.
|eff= global


== Path Text Field ==
|descr= Toggles the target group's gun light(s).
Shows the path to the original function file.


== Code Text Field ==
|s1= target [[enableGunLights]] state
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 ==
|p1= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
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.


== Recompile Selected ==
|p2= state: [[Boolean]] - [[true|True]] to enable, [[false]] to disable
Pressing this button will recompile the selected function.


== Close ==
|r1= [[Nothing]]
Closes the Functions Viewer.


= Shortcuts =
|x1= <code>_group [[enableGunLights]] [[false]];</code>
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"
|seealso= [[isFlashlightOn]]
|-
}}
! Key !! Effect
|-
| {{KeyboardShortcut|Escape}} || Closes the Functions Viewer
|}


== Functions List ==
|title2= {{Icon|arma3|link=}} {{arma3}}
{| class="wikitable"
|content2=
|-
{{RV|type=command
! Key !! Effect
|-
| {{KeyboardShortcut|A...Z}} || Quickly browse through the functions
|-
| {{KeyboardShortcut|Ctrl|C}} || Copy function name of selected function to the clipboard
|}


== Code Field ==
|game1= arma3
{| class="wikitable"
|version1= 0.50
|-
! Key !! Effect
|-
| {{KeyboardShortcut|Ctrl|A}} || Selects all code
|-
| {{KeyboardShortcut|Ctrl|C}} || Copy selected code to clipboard
|}


{{GameCategory|arma3|Editing}}
|gr1= Lights
|gr2= Weapons


= Alternative Tools =
|arg= local
Listed here are some mods which improve the Functions Viewer. If you created one you can add it to the list too.
|eff= global
* [https://steamcommunity.com/sharedfiles/filedetails/?id=2369477168 '''Advanced Developer Tools''' by Leopard20]
 
* [https://steamcommunity.com/sharedfiles/filedetails/?id=1862880106 '''Extended Function Viewer''' by Connor]
|descr= Toggles the target group's gun light(s).
* [https://steamcommunity.com/sharedfiles/filedetails/?id=623475643 '''3den Enhanced''' by R3vo''']
 
|s1= target [[enableGunLights]] mode
 
|p1= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
 
|p2= mode: [[String]] - Can be:
* <tt>"Auto"</tt> - Depends on combat mode
* <tt>"ForceOn"</tt> - Always on
* <tt>"ForceOff"</tt> - Always off
 
|r1= [[Nothing]]
 
|x1= <code>_unit [[enableGunLights]] "Auto";</code>
 
|x2= <code>_unit [[enableGunLights]] "ForceOff";</code>
 
|seealso= [[isFlashlightOn]]
}}
}}

Revision as of 14:29, 20 April 2021

RV/type Template

-Type not defined-


RV/param Template

Missing Name: Template:RV/type