ropeEndPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added ropeEndPosition command documentation based on ingame documentation and experimentation)
 
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(42 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma 3 |= Game name
|game1= arma3
|version1= 1.34


|1.33|= Game version
|gr1= Ropes and Sling Loading


____________________________________________________________________________________________
|descr= Returns start and end positions for the given [[ropeCreate | rope]]. If command fails, empty array {{hl|[]}} is returned.


|Return rope end positions in [[Position3D]] format|= Description
|s1= [[ropeEndPosition]] rope
____________________________________________________________________________________________


|'''ropeEndPosition''' rope|= Syntax
|p1= rope: [[Object]] - rope object
|p1 = rope: [[Object]]
| [[Array]] - [endPos1,endPos2] |= Return value
____________________________________________________________________________________________
|x1 = <code>_ends = '''ropeEndPosition''' ([[ropes]] heli1 [[select]] 0);
_end1 = _ends [[select]] 0;
_end2 = _ends [[select]] 1;</code> |= Example1


| [[ropes]], [[canSlingLoad]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeUnwind]], [[setSlingLoad]], [[slingLoadAssistantShown]] |= See also
|r1= [[Array]] - array in format [startPos, endPos], where:
* startPos: [[Array]] - rope start position in format [[Position#PositionAGL|PositionAGL]]
* endPos: [[Array]] - rope end position in format [[Position#PositionAGL|PositionAGL]]


|x1= <sqf>_ends = ropeEndPosition (ropes heli1 select 0);
_start = _ends select 0;
_end = _ends select 1;</sqf>
|seealso= [[ropes]] [[canSlingLoad]] [[enableRopeAttach]] [[getSlingLoad]] [[ropeAttachedObjects]] [[ropeAttachTo]] [[ropeDestroy]] [[ropeLength]] [[ropeUnwound]] [[ropeAttachedTo]] [[ropeCreate]] [[ropeDetach]] [[ropeAttachEnabled]] [[ropeCut]] [[ropeUnwind]] [[setSlingLoad]] [[slingLoadAssistantShown]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:24, 13 May 2022

Arma 3 logo black.png1.34
Hover & click on the images for description

Description

Description:
Returns start and end positions for the given rope. If command fails, empty array [] is returned.
Groups:
Ropes and Sling Loading

Syntax

Syntax:
ropeEndPosition rope
Parameters:
rope: Object - rope object
Return Value:
Array - array in format [startPos, endPos], where:

Examples

Example 1:
_ends = ropeEndPosition (ropes heli1 select 0); _start = _ends select 0; _end = _ends select 1;

Additional Information

See also:
ropes canSlingLoad enableRopeAttach getSlingLoad ropeAttachedObjects ropeAttachTo ropeDestroy ropeLength ropeUnwound ropeAttachedTo ropeCreate ropeDetach ropeAttachEnabled ropeCut ropeUnwind setSlingLoad slingLoadAssistantShown

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
Retrieved from "https://community.bistudio.com/wiki?title=ropeEndPosition&oldid=319581"