BIS fnc diagPreview: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (pf)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Previews selected classes from given container.|= Description


Description:
____________________________________________________________________________________________
Previews selected classes from given container


Parameter(s):
|  [container, parentClass, distance, startPos] call [[BIS_fnc_diagPreview]] |= Syntax
_this select 0: STRING - class container. Can be: "CfgVehicles", "CfgWeapons"
____________________________________________________________________________________________
_this select 1: STRING - parent class of created objects (e.g. "Car" or "Rifle")
|p1= container: [[String]] - (Optional, default "CfgVehicles") - Class container. Can be:
_this select 2 (Optional): NUMBER - distance between created objects (default: 10m)
*"CfgVehicles"
_this select 3 (Optional): ARRAY - initial position
*"CfgWeapons"|= Parameter 1
 
|p2= parentClass: [[String]] - (Optional, default [[typeOf]] [[player]]) - Parent class of the objects (e.g. "Car" or "Rifle")|= Parameter 2
Returns:
|p3= distance: [[Number]] - (Optional, default 10) - Distance between objects|= Parameter 3
ARRAY - list of created classes
|p4= startPos: [[Position]] - (Optional, default [[screenToWorld]] [0.5,0.5] in [[Eden Editor]] or [[position]] [[player]]) - Start position|= Parameter 4
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_diagPreview]]; --> |= Syntax
| [[Array]] - List of created classes|= Return value
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[ "CfgVehicles", "Car", 15, [0,0,0] ] [[call]] [[BIS_fnc_diagPreview]];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|[[:Category:Function Group: Diagnostic|Diag functions]]|= See also
 
}}
}}



Revision as of 10:57, 3 June 2018

Hover & click on the images for description

Description

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

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 screenToWorld [0.5,0.5] in Eden Editor or position player) - 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

Notes

Bottom Section