Splendid Config Viewer – Arma 3
Jump to navigation
Jump to search
(Using shortcut template now / Can be opened from Eden Editor as well) |
Lou Montana (talk | contribs) m (Text replacement - "Category:Eden Editor" to "Eden Editor") |
||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{TOC|side}} | {{TOC|side}} | ||
The Splendid™ Config Viewer is a way to access the contents of the game's current config. | The Splendid™ Config Viewer is a way to access the contents of the game's current config. | ||
[[File:Config Viewer.png|thumb|The Splendid™ Config Viewer's UI in | [[File:Config Viewer.png|thumb|The Splendid™ Config Viewer's UI in {{arma3}}.]] | ||
= Access = | |||
The config viewer can be opened via | == Access == | ||
The config viewer can be opened ''via'' | |||
* the [[Arma 3: Debug Console|Debug Console]] | * the [[Arma 3: Debug Console|Debug Console]] | ||
* executing | * executing <sqf inline>0 spawn BIS_fnc_configViewer</sqf> | ||
* the [[Eden Editor]] [[Eden Editor: Menu Bar|Menu Bar]] and Context Menu | * the [[:Category:Eden Editor|Eden Editor]] [[Eden Editor: Menu Bar|Menu Bar]] and Context Menu | ||
== Interface == | |||
=== Classes List === | |||
On the left hand side you can find a list of all config classes that are currently loaded by the game. This includes the classes found in the [[Config.cpp/bin_File_Format|main config]] from the base game and mods, the [[campaignConfigFile|campaign's config]] and the [[Description.ext|missions's config]]. Selecting an entry from the list will show the attributes of the class in the right window. A plus to the left of the class indicates that it contains more subclasses. To expand it you can double click the entry. The classes are sorted alphabetically. Be aware that the list list cut off at the end. In case of long configs the last config entries can only be selected by selecting the last visible entry and then using the arrow keys to scroll further down. | On the left hand side you can find a list of all config classes that are currently loaded by the game. This includes the classes found in the [[Config.cpp/bin_File_Format|main config]] from the base game and mods, the [[campaignConfigFile|campaign's config]] and the [[Description.ext|missions's config]]. Selecting an entry from the list will show the attributes of the class in the right window. A plus to the left of the class indicates that it contains more subclasses. To expand it you can double click the entry. The classes are sorted alphabetically. Be aware that the list list cut off at the end. In case of long configs the last config entries can only be selected by selecting the last visible entry and then using the arrow keys to scroll further down. | ||
== Bookmarks == | === Bookmarks === | ||
Below the [[#Classes List|Classes List]] you can find your bookmarked configs. Double clicking on "<Bookmark selected class>" will add the currently selected entry to the list. To remove a bookmark you can select it and press | |||
Below the [[#Classes List|Classes List]] you can find your bookmarked configs. Double clicking on "<Bookmark selected class>" will add the currently selected entry to the list. To remove a bookmark you can select it and press {{Controls|Del}} on your keyboard. Double clicking on a bookmarked class will take you to the config. When opening the Config Viewer the following entries will be added automatically: | |||
* Config of the currently played unit | * Config of the currently played unit | ||
* Config of the currently selected weapon | * Config of the currently selected weapon | ||
| Line 20: | Line 26: | ||
* Config of the ammunition used by the currently loaded magazine | * Config of the ammunition used by the currently loaded magazine | ||
It is not possible to delete the first two entries. To reset the bookmarks and restore the default entries you can execute the following code: | It is not possible to delete the first two entries. To reset the bookmarks and restore the default entries you can execute the following code: | ||
{{Feature| | {{Feature|warning|This action will also remove any bookmarks you saved!}} | ||
<sqf>profileNamespace setVariable ["BIS_fnc_configViewer_bookmarks", nil];</sqf> | |||
=== Attributes List === | |||
The right window displays the attributes of the currently selected class. The attributes are sorted alphabetically. The attributes are colored according to the data type of the attribute: | The right window displays the attributes of the currently selected class. The attributes are sorted alphabetically. The attributes are colored according to the data type of the attribute: | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 29: | Line 36: | ||
! Color !! Data Type | ! Color !! Data Type | ||
|- | |- | ||
| | | {{Color|green|Green}} || [[TokenNameValueTypes|Number]] | ||
|- | |- | ||
| | | {{Color|red|Red}} || [[TokenNameValueTypes|String]] | ||
|- | |- | ||
| | | {{Color|blue|Blue}} || [[TokenNameValueTypes|Array]] | ||
|} | |} | ||
Some attributes are indented a bit which means that those attribute have been [[Class_Inheritance|inherited]] from one of the parent classes. No indentation means that the attribute is specific or new to the config class. | Some attributes are indented a bit which means that those attribute have been [[Class_Inheritance|inherited]] from one of the parent classes. No indentation means that the attribute is specific or new to the config class. | ||
== Path Edit Field == | === Path Edit Field === | ||
The content of this edit field can be used with commands such as [[configClasses]], [[configProperties]], etc.. When an attribute from the right window is selected it will also display the path to it which can be used with [[getText]], [[getNumber]] or [[getArray]]. | The content of this edit field can be used with commands such as [[configClasses]], [[configProperties]], etc.. When an attribute from the right window is selected it will also display the path to it which can be used with [[getText]], [[getNumber]] or [[getArray]]. | ||
== Parents Edit Field == | === Parents Edit Field === | ||
This field lists all the classes that the selected class is inheriting from. It is generated by [[BIS_fnc_returnParents]]. | This field lists all the classes that the selected class is inheriting from. It is generated by [[BIS_fnc_returnParents]]. | ||
== Preview Class == | === Preview Class === | ||
The classes from the following parent configs are supported: | The classes from the following parent configs are supported: | ||
* CfgVehicles: Creates the given vehicle class at the position you are looking at | * CfgVehicles: Creates the given vehicle class at the position you are looking at | ||
* CfgWeapons: Creates the given weapon on the ground and also adds all magazines listed in the {{ | * CfgWeapons: Creates the given weapon on the ground and also adds all magazines listed in the {{hl|magazines}} attributes | ||
=== Preview Param === | |||
You can preview the following attributes: | You can preview the following attributes: | ||
* paa: If the attribute is a string and ends with "paa" it will open a window displaying the paa file | * paa: If the attribute is a string and ends with "paa" it will open a window displaying the paa file | ||
* [[Color|RGBA color]]: If the attribute is a 4D array consisting of numbers only it will display the color | * [[Color|RGBA color]]: If the attribute is a 4D array consisting of numbers only it will display the color | ||
= Shortcuts = | |||
== 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. | 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. | ||
| Line 61: | Line 74: | ||
! Key !! Effect | ! Key !! Effect | ||
|- | |- | ||
| {{ | | {{Controls|Backspace}} || Go up one config level | ||
|- | |- | ||
| {{ | | {{Controls|Enter}} || Expand the selected config | ||
|} | |} | ||
== Classes List == | === Classes List === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Key !! Effect | ! Key !! Effect | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|X}} || Copy path in viewer format | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|Shift|X}} || Copy path in config format | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|C}} || Copy config name | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|Shift|C}} || Copy the names of the subclasses | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|V}} || Takes you to the config previously saved to the clipboard with {{Controls|Ctrl|X}} | ||
|} | |} | ||
== Attributes List == | === Attributes List === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Key !! Effect | ! Key !! Effect | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|C}} || Copies the displayed attribute | ||
|- | |- | ||
| {{ | | {{Controls|Ctrl|Shift|C}} || Copies the entire content of the list | ||
|} | |} | ||
= Alternative Tools = | |||
== Alternative Tools == | |||
Listed here are some config viewers with more options than the Splendid Config Viewer. If you created one you can add it to the list too. | Listed here are some config viewers with more options than the Splendid Config 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=1387934106|text= '''7erra's Editing Extensions''' by Terra}} | ||
* {{Link|link= https://steamcommunity.com/sharedfiles/filedetails/?id=1862880106|text= '''Enhanced Config Viewer in POLPOX's Base Functions''' by POLPOX}} - called via <sqf inline>call PLP_fnc_configViewer</sqf> | |||
{{GameCategory|arma3}} | |||
Latest revision as of 13:27, 9 July 2023
The Splendid™ Config Viewer is a way to access the contents of the game's current config.
Access
The config viewer can be opened via
- the Debug Console
- executing 0 spawn BIS_fnc_configViewer
- the Eden Editor Menu Bar and Context Menu
Interface
Classes List
On the left hand side you can find a list of all config classes that are currently loaded by the game. This includes the classes found in the main config from the base game and mods, the campaign's config and the missions's config. Selecting an entry from the list will show the attributes of the class in the right window. A plus to the left of the class indicates that it contains more subclasses. To expand it you can double click the entry. The classes are sorted alphabetically. Be aware that the list list cut off at the end. In case of long configs the last config entries can only be selected by selecting the last visible entry and then using the arrow keys to scroll further down.
Bookmarks
Below the Classes List you can find your bookmarked configs. Double clicking on "<Bookmark selected class>" will add the currently selected entry to the list. To remove a bookmark you can select it and press Del on your keyboard. Double clicking on a bookmarked class will take you to the config. When opening the Config Viewer the following entries will be added automatically:
- Config of the currently played unit
- Config of the currently selected weapon
- Config of the currently loaded magazine
- Config of the ammunition used by the currently loaded magazine
It is not possible to delete the first two entries. To reset the bookmarks and restore the default entries you can execute the following code:
Attributes List
The right window displays the attributes of the currently selected class. The attributes are sorted alphabetically. The attributes are colored according to the data type of the attribute:
| Color | Data Type |
|---|---|
| Green | Number |
| Red | String |
| Blue | Array |
Some attributes are indented a bit which means that those attribute have been inherited from one of the parent classes. No indentation means that the attribute is specific or new to the config class.
Path Edit Field
The content of this edit field can be used with commands such as configClasses, configProperties, etc.. When an attribute from the right window is selected it will also display the path to it which can be used with getText, getNumber or getArray.
Parents Edit Field
This field lists all the classes that the selected class is inheriting from. It is generated by BIS_fnc_returnParents.
Preview Class
The classes from the following parent configs are supported:
- CfgVehicles: Creates the given vehicle class at the position you are looking at
- CfgWeapons: Creates the given weapon on the ground and also adds all magazines listed in the magazines attributes
Preview Param
You can preview the following attributes:
- paa: If the attribute is a string and ends with "paa" it will open a window displaying the paa file
- RGBA color: If the attribute is a 4D array consisting of numbers only it will display the color
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 |
|---|---|
| ⟵ | Go up one config level |
| Enter ↵ | Expand the selected config |
Classes List
| Key | Effect |
|---|---|
| Ctrl + X | Copy path in viewer format |
| Ctrl + ⇧ Shift + X | Copy path in config format |
| Ctrl + C | Copy config name |
| Ctrl + ⇧ Shift + C | Copy the names of the subclasses |
| Ctrl + V | Takes you to the config previously saved to the clipboard with Ctrl + X |
Attributes List
| Key | Effect |
|---|---|
| Ctrl + C | Copies the displayed attribute |
| Ctrl + ⇧ Shift + C | Copies the entire content of the list |
Alternative Tools
Listed here are some config viewers with more options than the Splendid Config Viewer. If you created one you can add it to the list too.
- Advanced Developer Tools by Leopard20
- 7erra's Editing Extensions by Terra
- Enhanced Config Viewer in POLPOX's Base Functions by POLPOX - called via call PLP_fnc_configViewer