BIS fnc diagPreview: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(27 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= Diagnostic
____________________________________________________________________________________________


| Previews selected classes from given container.|DESCRIPTION=
|descr= Previews selected classes from given container.


____________________________________________________________________________________________
|s1= [container, parentClass, distance, startPos] call [[BIS_fnc_diagPreview]]


|  [container, parentClass, distance, startPos] call [[BIS_fnc_diagPreview]] |SYNTAX=
|p1= container: [[String]] - (Optional, default "CfgVehicles") class container. Can be:
____________________________________________________________________________________________
* "CfgVehicles"
|p1= container: [[String]] - (Optional, default "CfgVehicles") - Class container. Can be:
* "CfgWeapons"
*"CfgVehicles"
*"CfgWeapons"|PARAMETER1=
|p2= parentClass: [[String]] - (Optional, default [[typeOf]] [[player]]) - Parent class of the objects (e.g. "Car" or "Rifle")|PARAMETER2=
|p3= distance: [[Number]] - (Optional, default 10) - Distance between objects|PARAMETER3=
|p4= startPos: [[Position]] - (Optional, default [[screenToWorld]] [0.5,0.5] in [[Eden Editor]] or [[position]] [[player]]) - Start position|PARAMETER4=
____________________________________________________________________________________________


| [[Array]] - List of created classes|RETURNVALUE=
|p2= parentClass: [[String]] - (Optional, default [[typeOf]] [[player]]) parent class of the objects (e.g. "Car" or "Rifle")
____________________________________________________________________________________________


|x1= <code>[ "CfgVehicles", "Car", 15, [0,0,0] ] [[call]] [[BIS_fnc_diagPreview]];</code> |=
|p3= distance: [[Number]] - (Optional, default 10) distance between objects
____________________________________________________________________________________________


|[[:Category:Function Group: Diagnostic|Diag functions]]|SEEALSO=
|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
}}


<h3 style="display:none">Notes</h3>
|r1= [[Array]] - list of created classes
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>["CfgVehicles", "Car", 15, [0,0,0]] call BIS_fnc_diagPreview;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[:Category:Function Group: Diagnostic|Diag functions]]
[[Category:Function Group: Diagnostic|{{uc:diagPreview}}]]
}}
[[Category:Functions|{{uc:diagPreview}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:diagPreview}}]]

Latest revision as of 11:55, 8 November 2023

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