BIS fnc objectsGrabber: Difference between revisions

Latest revision as of 16:44, 1 November 2022

1.00

1.50

1.00

0.50

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:: Object Manipulation

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 - arrays are in format [classname, relPos, azimuth, fuel, damage, pitchBankResult, vehicleVarName, initCommands, simulationEnabled, isASL]:

classname: String
relPos: Array
azimuth: Number
fuel: Number
damage: Number
pitchBankResult: Array - return from BIS_fnc_getPitchBank (only if objectOrientation is true)
vehicleVarName: String
initCommands: String
simulationEnabled: Boolean
isASL: Boolean

Examples

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

Additional Information

See also:: BIS_fnc_objectsMapper BIS_fnc_getPitchBank BIS_fnc_setPitchBank

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: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2oa
-____________________________________________________________________________________________
+|version2= 1.50
-| Converts a set of placed objects to an object array ('''as a [[String]]''') for the [[BIS_fnc_ObjectsMapper|DynO mapper]].<br />
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
+|gr1= Object Manipulation
+|descr= Converts a set of placed objects to an object array ('''as a [[String]]''') for the [[BIS_fnc_objectsMapper|DynO mapper]].<br>
 Format is the following. First, the header:
-<code>{{codecomment|/*
+<sqf>
+/*
 Grab data:
 Mission: TheMissionName
@@ Line 16: / Line 25: @@
 Area size: 50
 Using orientation of objects: yes/no
-<nowiki>*/</nowiki>}}</code>
+*/
+</sqf>
 Then, data:
-<code>[
+<sqf>
+[
 	["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>
+]
+</sqf>
 or, if object orientation is not used:
-<code>[
+<sqf>
+[
 	["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]
-]</code> |DESCRIPTION=
+]
-____________________________________________________________________________________________
+</sqf>
-| [position, size, objectOrientation] call [[BIS_fnc_ObjectsGrabber]] |SYNTAX=
+|s1= [position, size, objectOrientation] call [[BIS_fnc_objectsGrabber]]
-|p1= position: [[Position]] - (Optional, default [0,0]) 2D or 3D position, center of the "grabbing" area |PARAMETER1=
+|p1= position: [[Position]] - (Optional, default [0,0]) 2D or 3D position, center of the "grabbing" area
-|p2= size: [[Number]] - (Optional, default 50) size (radius) of the "grabbing" area |PARAMETER2=
+|p2= size: [[Number]] - (Optional, default 50) size (radius) of the "grabbing" area
-|p3= objectOrientation: [[Boolean]] - (Optional, default [[false]]) capture object orientation or not. Format [[BIS_fnc_getPitchBank]] |PARAMETER3=
+|p3= objectOrientation: [[Boolean]] - (Optional, default [[false]]) capture object orientation or not. Format [[BIS_fnc_getPitchBank]]
-| [[String]] |RETURNVALUE=
+|r1= [[String]] - arrays are in format [classname, relPos, azimuth, fuel, damage, pitchBankResult, vehicleVarName, initCommands, simulationEnabled, isASL]:
-____________________________________________________________________________________________
+* classname: [[String]]
+* relPos: [[Array]]
+* azimuth: [[Number]]
+* fuel: [[Number]]
+* damage: [[Number]]
+* pitchBankResult: [[Array]] - return from [[BIS_fnc_getPitchBank]] (only if ''objectOrientation'' is true)
+* vehicleVarName: [[String]]
+* initCommands: [[String]]
+* simulationEnabled: [[Boolean]]
+* isASL: [[Boolean]]
-|x1= <code><nowiki>[</nowiki>[[getPos]] [[player]], 20, [[true]]] [[call]] [[BIS_fnc_ObjectsGrabber]];</code> |EXAMPLE1=
+|x1= <sqf>[getPos player, 20, true] call BIS_fnc_objectsGrabber;</sqf>
-____________________________________________________________________________________________
-| [[BIS_fnc_ObjectsMapper]], [[BIS_fnc_getPitchBank]], [[BIS_fnc_setPitchBank]] |SEEALSO=
+|seealso= [[BIS_fnc_objectsMapper]] [[BIS_fnc_getPitchBank]] [[BIS_fnc_setPitchBank]]
 }}
-<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: Spawning|{{uc:ObjectsGrabber}}]]
-[[Category:Functions|{{uc:ObjectsGrabber}}]]
-[[Category:{{Name|arma2}}: Functions|{{uc:ObjectsGrabber}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:ObjectsGrabber}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:ObjectsGrabber}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:ObjectsGrabber}}]]