BIS fnc exportGUIBaseClasses: Difference between revisions

Latest revision as of 18:00, 30 October 2023

1.00

Hover & click on the images for description

Description

Description:: Export GUI macros and base classes to the clipboard.
🕖
This information is obsolete as of Arma 3 v2.01.146644. Reason: the import keyword was introduced.

⚠
The exported the Eden Editor base classes have several inheritance issues. If you need the base classes you can get them here.
Execution:: call
Groups:: GUI Diagnostic Broken Functions

Syntax

Syntax:

mode call BIS_fnc_exportGUIBaseClasses

Parameters:

mode: String - mode, case-sensitive; can be one of:

"Default" - classic base classes like RscText or RscPicture
"3DEN" - Eden Editor base classes like ctrlStatic or ctrlStaticPicture
"all" - all GUI base classes, including more exotic ones

⚠

All modes are case sensitive. If the capitalisation is disregarded the function will default to the "all" mode. In fact there is no explicit "all" mode, rather it is the fallback if the mode is not one of "Default" or "3DEN".

Return Value:

String - .hpp file content to be included in Description.ext, also copied to the clipboard

Examples

Example 1:: "all" call BIS_fnc_exportGUIBaseClasses;

Additional Information

See also:: Arma: GUI Configuration Arma 3: Utilities

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Killzone_Kid - c: Posted on Sep 28, 2018 - 14:37 (UTC)
: You can use Arma 3: Utilities to get the base class for your mission config. For example if you need RscPicture base, enter utils 2 in the debug console and click LOCAL EXEC, type RscPicture and press Enter, check Include Inherited box, then click COPY. The config is now copied to Clipboard and you can paste it in your description.ext and then derive your class from it.

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= GUI
-____________________________________________________________________________________________
-| Export GUI macros and base classes.|Description=
+|gr2= Diagnostic
-____________________________________________________________________________________________
-| mode call [[BIS_fnc_exportGUIBaseClasses]] |Syntax=
+|gr3= Broken Functions
-|p1=mode: [[String]] - Mode, can be:<br>
+|descr= Export GUI macros and base classes to the clipboard.
-Default" - Classic base classes like RscText or RscPicture<br>
+{{Feature|obsolete|the [[import (Config)|import]] keyword was introduced.|arma3|2.01.146644}}
-"3DEN" - [[Eden Editor]] base classes like ctrlStatic or ctrlStaticPicture<br>
+{{Feature|warning|
-"all" - All GUI base classes, including more exotic ones|Parameter 1=
+The exported the Eden Editor base classes have several inheritance issues.
+If you need the base classes you can get them {{Link|https://github.com/LarrowZurb/A3_GUI_Defines|'''here'''}}.
+}}
-| [[String]] - Content of *.hpp file to be included in description.ext. The result is also copied to clipboard |Return value=
+|s1= mode call [[BIS_fnc_exportGUIBaseClasses]]
-____________________________________________________________________________________________
+|p1= mode: [[String]] - mode, '''case-sensitive'''; can be one of:
+* {{hl|"Default"}} - classic base classes like {{hl|RscText}} or {{hl|RscPicture}}
+* {{hl|"3DEN"}} - [[:Category:Eden Editor|Eden Editor]] base classes like {{hl|ctrlStatic}} or {{hl|ctrlStaticPicture}}
+* {{hl|"all"}} - all GUI base classes, including more exotic ones
+{{Feature|important|
+All modes are case sensitive. If the capitalisation is disregarded the function will default to the "all" mode.
+In fact there is no explicit "all" mode, rather it is the fallback if the mode is not one of "Default" or "3DEN".
+}}
-|x1= <code>"all" [[call]] [[BIS_fnc_exportGUIBaseClasses]];</code>|Example 1=
+|r1= [[String]] - {{hl|.hpp}} file content to be included in [[Description.ext]], also copied to the clipboard
-____________________________________________________________________________________________
+|x1= <sqf>"all" call BIS_fnc_exportGUIBaseClasses;</sqf>
-| [[Dialog Control]]  |See also=
+|seealso= [[Arma: GUI Configuration]] [[Arma 3: Utilities]]
 }}
-<h3 style="display:none">Notes</h3>
+{{Note
-<dl class="command_description">
+|user= Killzone_Kid
-<!-- Note Section BEGIN -->
+|timestamp= 20180928143700
+|text= You can use [[Arma 3: Utilities]] to get the base class for your mission config.
-<!-- Note Section END -->
+For example if you need {{hl|RscPicture}} base, enter '''utils 2''' in the debug console and click '''LOCAL EXEC''', type {{hl|RscPicture}} and press Enter, check '''Include Inherited''' box, then click '''COPY'''.
-</dl>
+The config is now copied to Clipboard and you can paste it in your [[Description.ext|description.ext]] and then derive your class from it.
+}}
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: GUI|{{uc:exportGUIBaseClasses}}]]
-[[Category:Functions|{{uc:exportGUIBaseClasses}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:exportGUIBaseClasses}}]]