BIS fnc exportGUIBaseClasses: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= GUI


|gr1= GUI |GROUP1=
|gr2= Diagnostic


|gr2= Diagnostic |GROUP2=
|gr3= Broken Functions


|gr3= Broken Functions |GROUP3=
|descr= Export GUI macros and base classes to the clipboard.
____________________________________________________________________________________________
{{Feature|obsolete|the [[import (Config)|import]] keyword was introduced.|arma3|2.01.146644}}
{{Feature|warning|
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'''}}.
}}


| Export GUI macros and base classes to the clipboard.{{Warning|The exported the Eden Editor base classes have several inheritance issues. If you need the base classes you can get them [https://github.com/LarrowZurb/A3_GUI_Defines '''here'''].}}|Description=
|s1= mode call [[BIS_fnc_exportGUIBaseClasses]]
____________________________________________________________________________________________


| mode call [[BIS_fnc_exportGUIBaseClasses]] |Syntax=
|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".
}}


|p1=mode: [[String]] - Mode, can be:<br>
|r1= [[String]] - {{hl|.hpp}} file content to be included in [[Description.ext]], also copied to the clipboard
"Default" - Classic base classes like RscText or RscPicture<br>
"3DEN" - [[Eden Editor]] base classes like ctrlStatic or ctrlStaticPicture<br>
"all" - All GUI base classes, including more exotic ones
{{Important|All modes are case sensitive. If the capitalization 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".}}
|Parameter 1=


| [[String]] - Content of *.hpp file to be included in description.ext. The result is also copied to clipboard |Return value=
|x1= <sqf>"all" call BIS_fnc_exportGUIBaseClasses;</sqf>
____________________________________________________________________________________________


|x1= <code>"all" [[call]] [[BIS_fnc_exportGUIBaseClasses]];</code>|Example 1=
|seealso= [[Arma: GUI Configuration]] [[Arma 3: Utilities]]
}}


____________________________________________________________________________________________
{{Note
 
|user= Killzone_Kid
| [[Arma: GUI Configuration]] [[Arma 3 Utilities]] |See also=
|timestamp= 20180928143700
|text= You can use [[Arma 3: Utilities]] to get the base class for your mission config.
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'''.
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">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:exportGUIBaseClasses}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportGUIBaseClasses}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 28, 2018 - 14:37 (UTC)</dd>
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>
<dd class="note"> You can use [[Arma 3 Utilities]] to get the base class for your mission config. For example if you need <tt>RscPicture</tt> base, enter '''utils 2''' in the debug console and click '''LOCAL EXEC''', type <tt>RscPicture</tt> 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. 
</dd>
</dl>
<!-- DISCONTINUE Notes -->
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 28, 2020 - 13:18 (UTC)</dd>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
With {{GVI|a3|2.02}} the keyword [[import]] was added to the game which allows to import base classes from [[configFile|config file]] in to the [[missionConfigFile|mission config]].
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 18:00, 30 October 2023

Arma 3 logo black.png1.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:
GUIDiagnosticBroken 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.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_exportGUIBaseClasses&oldid=347871"