BIS fnc objectsGrabber: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Replacement)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 5: Line 4:
| arma2 |= Game name
| arma2 |= Game name


|?|= Game version
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| Converts a set of placed objects within a specified area, to an object array for use with the DynO mapper. The information is copied to the clipboard and returned via [[call]] as a string. |= Description
| 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|/*
Grab data:
Mission: TheMissionName
World: Stratis
Anchor position: [3781.59, 3289.67]
Area size: 50
Using orientation of objects: yes/no
<nowiki>*/</nowiki>}}</code>
 
Then, data:
<code>[
["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>
 
or, if object orientation is not used:
<code>[
["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
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''[<nowiki>[Anchor Point]</nowiki>, Radius, getDir]''' call [[BIS_fnc_objectsGrabber]]; |= Syntax
| [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


|p1= '''Anchor Point''': [[Array]] - Position of center. |=
|p2= size: [[Number]] - (Optional, default 50) size (radius) of the "grabbing" area |= Parameter 2
|p2= '''Radius''': [[Number]] - Size of area. |=
|p3= '''getDir''': [[Boolean]] - (optional) grab direction of objects. |=


| [[String]] - Output text used as parameter for [[BIS_fnc_ObjectsMapper]] |= Return value
|p3= objectOrientation: [[Boolean]] - (Optional, default [[false]]) capture object orientation or not. Format [[BIS_fnc_getPitchBank]] |= Parameter 3
 
| [[String]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[getPos player, 200, true] [[call]] [[BIS_fnc_objectsGrabber]];</code> |=
|x1= <code><nowiki>[</nowiki>[[getPos]] [[player]], 20, [[true]]] [[call]] [[BIS_fnc_ObjectsGrabber]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_ObjectsMapper]] |= See also
| [[BIS_fnc_ObjectsMapper]], [[BIS_fnc_getPitchBank]], [[BIS_fnc_setPitchBank]] |= See also
 
}}
}}


Line 35: Line 56:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Spawning|{{uc:sortBy}}]]
[[Category:Function Group: Spawning|{{uc:ObjectsGrabber}}]]
[[Category:Functions|{{uc:sortBy}}]]
[[Category:Functions|{{uc:ObjectsGrabber}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:sortBy}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:ObjectsGrabber}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sortBy}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:ObjectsGrabber}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:ObjectsGrabber}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ObjectsGrabber}}]]

Revision as of 21:38, 5 May 2018

Logo A2.png1.00
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_ObjectsMapperBIS_fnc_getPitchBankBIS_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_objectsGrabber&oldid=107125"