BIS fnc diagPreview: Difference between revisions

Latest revision as of 10:55, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Previews selected classes from given container.
Execution:: call
Groups:: Diagnostic

Syntax

Syntax:

[container, parentClass, distance, startPos] call BIS_fnc_diagPreview

Parameters:

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

"CfgVehicles"
"CfgWeapons"

parentClass: String - (Optional, default typeOf player) parent class of the objects (e.g. "Car" or "Rifle")

distance: Number - (Optional, default 10) distance between objects

startPos: Position - (Optional, default getPos player or screenToWorld]] [0.5,0.5] in Eden Editor) start position

Return Value:

Array - list of created classes

Examples

Example 1:: ["CfgVehicles", "Car", 15, [0,0,0]] call BIS_fnc_diagPreview;

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 classes from given container.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [container, parentClass, distance, startPos] call [[BIS_fnc_diagPreview]]
-	Description:
+|p1= container: [[String]] - (Optional, default "CfgVehicles") class container. Can be:
-	Previews selected classes from given container
+* "CfgVehicles"
+* "CfgWeapons"
-	Parameter(s):
+|p2= parentClass: [[String]] - (Optional, default [[typeOf]] [[player]]) parent class of the objects (e.g. "Car" or "Rifle")
-	_this select 0: STRING - class container. Can be: "CfgVehicles", "CfgWeapons"
-	_this select 1: STRING - parent class of created objects (e.g. "Car" or "Rifle")
-	_this select 2 (Optional): NUMBER - distance between created objects (default: 10m)
-	_this select 3 (Optional): ARRAY - initial position
-	Returns:
+|p3= distance: [[Number]] - (Optional, default 10) distance between objects
-	ARRAY - list of created classes
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_diagPreview]]; --> |= Syntax
+|p4= startPos: [[Position]] - (Optional, default <sqf inline>getPos player</sqf> or <sqf inline>screenToWorld]] [0.5,0.5]</sqf> in [[:Category:Eden Editor|Eden Editor]]) start position
-|p1= |= Parameter 1
+|r1= [[Array]] - list of created classes
-| |= Return value
+|x1= <sqf>["CfgVehicles", "Car", 15, [0,0,0]] call BIS_fnc_diagPreview;</sqf>
-____________________________________________________________________________________________
-|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:diagPreview}}]]
-[[Category:Functions|{{uc:diagPreview}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:diagPreview}}]]