Difference between revisions of "BIS fnc ObjectsGrabber"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fixed small typo)
(Page filling)
Line 1: Line 1:
 
 
{{Function|= Comments
 
{{Function|= Comments
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
Line 8: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>/*
+
| Converts a set of placed objects to an object array ('''as a [[String]]''') for the [[BIS_fnc_ObjectsMapper|DynO mapper]].<br />
File: objectGrabber.sqf
+
Format is the following. First, the header:
 +
<code>{{codecomment|/*
 +
Grab data:
 +
Mission: TheMissionName
 +
World: Stratis
 +
Anchor position: [3781.59, 3289.67]
 +
Area size: 50
 +
Using orientation of objects: yes/no
 +
<nowiki>*/</nowiki>}}</code>
  
Description:
+
Then, data:
Converts a set of placed objects to an object array for the DynO mapper.
+
<code>[
Places this information in the debug output for processing.
+
["B_UAV_01_F",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[0.605018,-0.575293],"","",true,false],
 +
["C_Offroad_01_F",[-4.25903,4.62158,0.0630951],224.14,1,0,[0.812812,0.190543],"","",true,false]
 +
]</code>
  
Parameter(s):
+
or, if object orientation is not used:
_this select 0: position of the anchor point (Array)
+
<code>[
_this select 1: size of the covered area (Scalar)
+
["B_UAV_01_F",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[],"","",true,false],
_this select 2: grab object orientation? (Boolean) [default: false]
+
["C_Offroad_01_F",[-4.25903,4.62158,0.0630951],224.14,1,0,[],"","",true,false]
+
]</code> |= Description
Returns:
+
____________________________________________________________________________________________
Output text (String)
 
*/
 
  
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+
| [position, size, objectOrientation] call [[BIS_fnc_ObjectsGrabber]] |= Syntax
____________________________________________________________________________________________
+
 
 +
|p1= position: [[Position]] - (Optional, default [0,0]) 2D or 3D position, center of the "grabbing" area |= Parameter 1
  
| <!-- [] call [[BIS_fnc_ObjectsGrabber]]; --> |= Syntax
+
|p2= size: [[Number]] - (Optional, default 50) size (radius) of the "grabbing" area |= Parameter 2
  
|p1= |= Parameter 1
+
|p3= objectOrientation: [[Boolean]] - (Optional, default [[false]]) capture object orientation or not. Format [[BIS_fnc_getPitchBank]] |= Parameter 3
  
| |= Return value
+
| [[String]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
|x1= <code><nowiki>[</nowiki>[[getPos]] [[player]], 20, [[true]]] [[call]] [[BIS_fnc_ObjectsGrabber]];</code> |= Example 1
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[BIS_fnc_ObjectsMapper]] |= See also
 
 
 
}}
 
}}
  

Revision as of 21:31, 5 May 2018

Hover & click on the images for description

Description

Description:
Converts a set of placed objects to an object array (as a String) for the DynO mapper.
Format is the following. First, the header: /* Grab data: Mission: TheMissionName World: Stratis Anchor position: [3781.59, 3289.67] Area size: 50 Using orientation of objects: yes/no */ Then, data: [ ["B_UAV_01_F",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[0.605018,-0.575293],"","",true,false], ["C_Offroad_01_F",[-4.25903,4.62158,0.0630951],224.14,1,0,[0.812812,0.190543],"","",true,false] ] or, if object orientation is not used: [ ["B_UAV_01_F",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[],"","",true,false], ["C_Offroad_01_F",[-4.25903,4.62158,0.0630951],224.14,1,0,[],"","",true,false] ]
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[position, size, objectOrientation] call BIS_fnc_ObjectsGrabber
Parameters:
position: Position - (Optional, default [0,0]) 2D or 3D position, center of the "grabbing" area
size: Number - (Optional, default 50) size (radius) of the "grabbing" area
objectOrientation: Boolean - (Optional, default false) capture object orientation or not. Format BIS_fnc_getPitchBank
Return Value:
String

Examples

Example 1:
[getPos player, 20, true] call BIS_fnc_ObjectsGrabber;

Additional Information

See also:
BIS_fnc_ObjectsMapper

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