R3vo – User talk

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{RV|type=command
{{TOC|side}}
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.]]


|game1= arma2
= Access =
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]]


|version1= 1.00
= Interface =
== Config Source Combobox ==
Choose which config file should be used, can be:
* [[campaignConfigFile]]
* [[missionConfigFile]]
* [[configFile]]


|game2= arma2oa
== 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 (Arma 3)#Adding a Function|Functions Library]].


|version2= 1.51
== Category ==
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]].


|game3= tkoh
== Functions List ==
The functions list contains all functions of given TAG and category and is sorted alphabetically. When a function is selected, {{KeyboardShortcut|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.


|version3= 1.00
== Name Text Field ==
Shows the name of the function. It can be selected and copied.


|game4= arma3
== Path Text Field ==
Shows the path to the original function file.


|version4= 0.50
== 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.


|eff= local
== 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 (Arma 3)#Recompiling|Functions Library: Recompiling]] for more information.


|gr1= Interaction
== Recompile Selected ==
Pressing this button will recompile the selected function.


|descr= Enable / disable showing of HUD. Defines visibility of weapon crosshair and any informational tags that appear when pointing the weapon at an object as well as availability of the default action menu. Unfortunately, it also hides icons drawn with [[drawIcon3D]].
== Close ==
{{Feature|arma3| '''Since {{arma3}} v1.50''' there is a Description.ext's [[Description.ext#showHUD|showHUD[]<nowiki/>]] array param that is identical in format to the extended [[showHUD]] command. When present, it will disable [[showHUD]] command entirely, allowing mission makers to permanently alter visibility of some HUD elements.<br>
Closes the Functions Viewer.
'''Since Arma 3 v2.04''' it is possible to force drawing of [[drawIcon3D]] icons when HUD is hidden. The icons will also show when custom camera is [[camCreate | created]] and the view is switched to it via [[switchCamera]] or [[cameraEffect]] provided [[cameraEffectEnableHUD]] is enabled. For more information see [[drawIcon3D]].}}


|s1= [[showHUD]] enable
= 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.


|p1= enable: [[Boolean]]
{| class="wikitable"
|-
! Key !! Effect
|-
| {{KeyboardShortcut|Escape}} || Closes the Functions Viewer
|-
| {{KeyboardShortcut|Enter}} || Expand the selected config
|}


|r1= [[Nothing]]
== Functions List ==
{| class="wikitable"
|-
! Key !! Effect
|-
| {{KeyboardShortcut|A...Z}} || Quickly browse through the functions
|-
| {{KeyboardShortcut|Ctrl|C}} || Copy selected code to clipboard
|}


|s2= [[showHUD]] [scriptedHUD, info radar, compass, direction, menu, group, cursors, panels, kills]
== Code Field ==
{| class="wikitable"
|-
! Key !! Effect
|-
| {{KeyboardShortcut|Ctrl|A}} || Selects all code
|-
| {{KeyboardShortcut|Ctrl|C}} || Copy selected code to clipboard
|}


|p21= scriptedHUD: [[Boolean]] - Show scripted HUD such as weapon crosshair, action menu and overlays created with [[cutRsc]] and [[titleRsc]]. Same as [[showHUD]]'s first syntax
{{GameCategory|arma3|Editing}}
 
|p22= info: [[Boolean]] (optional, default [[true]]) - Show vehicle, soldier and weapon info
 
|p23= radar: [[Boolean]] (optional, default [[true]]) - Show vehicle radar
 
|p24= compass: [[Boolean]] (optional, default [[true]]) - Show vehicle compass
 
|p25= direction: [[Boolean]] (optional, default [[true]]) - Show tank direction indicator. Not present in vanilla {{arma3}}
 
|p26= menu: [[Boolean]] (optional, default [[true]]) - Show commanding menu (HC related menus)
 
|p27= group: [[Boolean]] (optional, default [[true]]) - Show group info bar (Squad leader info bar)
 
|p28= cursors: [[Boolean]] (optional, default [[true]]) - Show HUD weapon cursors (connected with scripted HUD)
 
|p29= panels: [[Boolean]] (optional, default [[true]]) - Show [[Arma 3: Custom Info]] {{Since|arma3|1.70|}}
 
|p30= kills: [[Boolean]] (optional, default [[true]]) - Show "x killed by y" [[systemChat]] messages
 
|p31= showIcon3D: [[Boolean]] (optional, default [[false]]) - Show icons drawn with [[drawIcon3D]] even when the HUD is hidden {{Since|arma3|2.04|}}
 
|r2= [[Nothing]]
 
|x1= <code>[[showHUD]] [[false]];</code>
 
|x2= Hide vehicle radar and compass:<code>[[showHUD]] [
  true, {{cc|scriptedHUD}}
  true, {{cc|info}}
  true, {{cc|radar}}
  true, {{cc|compass}}
  true, {{cc|direction}}
  true, {{cc|menu}}
  true, {{cc|group}}
  true, {{cc|cursors}}
  true, {{cc|panels}}
  true, {{cc|kills}}
  true  {{cc|showIcon3D}}
];</code>
 
|x3= Check if HUD visibility is hardcoded in mission config and [[showHUD]] command is overriden:<code>_disabledShowHUD = [[isArray]] ([[missionConfigFile]] >> "showHUD");</code>
 
|seealso= [[shownHUD]], [[showCinemaBorder]], [[showSubtitles]], [[showWatch]], [[showRadio]], [[showMap]], [[showGPS]], [[showCompass]], [[showPad]]
}}
 
 
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on August 17, 2015 - 17:08 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
The "cursors" parameter controls visibility of the action menu as well as weapon cursors. However if 1st param "hud" hides and disables action menu, param "cursors" only hides it. So you get invisible action menu that is fully operational. [[inGameUISetEventHandler]] will still fire on interaction, giving the information about selected item on the action menu even if you cannot see it. Unfortunately it also hides icons drawn with [[drawIcon3D]].
</dd>
<dt><dt>
<dd class="notedate">Posted on March 1, 2020 - 14:33 (UTC)</dd>
<dt class="note">[[User:POLPOX|POLPOX]]</dt>
<dd class="note">
<code>[[showHUD]] [[false]]</code>removes [[Arma 3 Contact|Contact]]'s compass that shown in the top of the screen.
</dd>
</dl>

Revision as of 08:35, 14 April 2021

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

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
Enter ↵ Expand the selected config

Functions List

Key Effect
A...Z Quickly browse through the functions
Ctrl + C Copy selected code to clipboard

Code Field

Key Effect
Ctrl + A Selects all code
Ctrl + C Copy selected code to clipboard
Retrieved from "https://community.bistudio.com/wiki?title=User_talk:R3vo&oldid=255432"