BIS fnc diagPreviewCycle: Difference between revisions

Latest revision as of 11:59, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Previews selected class from the list. When cheat1 (?) is activated, classnames will be shown instead of display names.
Execution:: call
Groups:: Diagnostic

Syntax

Syntax:

[container, position, vector, display] call BIS_fnc_diagPreviewCycle

Parameters:

container: String - (Optional, default "CfgVehicles") class container. Can be:

"CfgVehicles"
"CfgWeapons"

position: [Array]] format Position - (Optional, default [position player, 10, 0] call BIS_fnc_relPos) position of the previewed object

vector Array of Numbers - (Optional, default [0,0]]) vector of previewed object in format:

0: Pitch
1: Bank

display: Display - (Optional, default BIS_fnc_displayMission) parent display

Return Value:

Boolean

Examples

Example 1:: ["CfgVehicles"] call BIS_fnc_diagPreviewCycle;

Additional Information

See also:: Diag functions

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Diagnostic
-|1.00|= Game version
+|descr= Previews selected class from the list. When '''cheat1''' (?) is activated, classnames will be shown instead of display names.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [container, position, vector, display] call [[BIS_fnc_diagPreviewCycle]]
-	Description:
+|p1= container: [[String]] - (Optional, default "CfgVehicles") class container. Can be:
-	Previews selected class from the list.
+* "CfgVehicles"
-	When cheat1 is activated, classnames will be shown instead of display names
+* "CfgWeapons"
-	Parameter(s):
+|p2= position: [Array]] format [[Position]] - (Optional, default <sqf inline>[position player, 10, 0] call BIS_fnc_relPos</sqf>) position of the previewed object
-	_this select 0: STRING - class container. Can be: "CfgVehicles", "CfgWeapons"
-	_this select 1: ARRAY - position of the previewed object
-	_this select 2: ARRAY - vector of previewed object in format [pitch,bank]
-	_this select 3 (Optional): DISPLAY - parent display
-	Returns:
+|p3= vector [[Array]] of [[Number]]s - (Optional, default [0,0]]) vector of previewed object in format:
-	BOOL
+* 0: Pitch
-*/
+* 1: Bank
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p4= display: [[Display]] - (Optional, default [[BIS_fnc_displayMission]]) parent display
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_diagPreviewCycle]]; --> |= Syntax
+|r1= [[Boolean]]
-|p1= |= Parameter 1
+|x1= <sqf>["CfgVehicles"] call BIS_fnc_diagPreviewCycle;</sqf>
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[:Category:Function Group: Diagnostic|Diag functions]]
 }}
-<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:Function Group: Diagnostic|{{uc:diagPreviewCycle}}]]
-[[Category:Functions|{{uc:diagPreviewCycle}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:diagPreviewCycle}}]]