canSlingLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added command documentation based on ingame documentation and experimentation)
 
m (Text replacement - "since= Arma3" to "since= arma3")
 
(46 intermediate revisions by 6 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 [[true]] if [[setSlingLoad]] is possible.


| Returns true if it is possible to sling load cargo |= Description
|s1=heli [[canSlingLoad]] cargo
____________________________________________________________________________________________


|vehicle '''canSlingLoad''' cargo|= Syntax
|p1= heli: [[Object]] - a helicopter
|p1 = vehicle: [[Object]]
|p2 = cargo: [[Object]]
| [[Boolean]] |= Return value
____________________________________________________________________________________________
|x1 = <code>_slingable = veh1 '''canSlingLoad''' veh2;</code> |= Example1


|x2 = <code>[[hint]] [[str]] (([[vehicle]] [[player]]) '''canSlingLoad''' veh1);</code> |= Example1
|p2= cargo: [[Object]] - an entity


|r1= [[Boolean]] - [[true]] if [[setSlingLoad]] is possible


| [[ropes]], [[enableRopeAttach]], [[getSlingLoad]], [[ropeAttachedObjects]], [[ropeAttachTo]], [[ropeDestroy]], [[ropeLength]], [[ropeUnwound]], [[ropeAttachedTo]], [[ropeCreate]], [[ropeDetach]], [[ropeAttachEnabled]], [[ropeCut]], [[ropeEndPosition]], [[ropeUnwind]], [[setSlingLoad]], [[slingLoadAssistantShown]] |= See also
|s2=typeOfHeli [[canSlingLoad]] typeOfCargo
|s2since= arma3 2.12
 
|p21= typeOfHeli: [[String]] - a config type of helicopter
 
|p22= typeOfCargo: [[String]] - a config type of cargo (the object of type cargo has to exist in the mission)
 
|r2= [[Boolean]] - [[true]] if can be sling loaded ''in principle''


}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>_canSling = veh1 canSlingLoad veh2;</sqf>
<dl class="command_description">


</dl>
|x2= <sqf>hint str ((vehicle player) canSlingLoad veh1);</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[ropes]] [[enableRopeAttach]] [[getSlingLoad]] [[ropeAttachedObjects]] [[ropeAttachTo]] [[ropeDestroy]] [[ropeLength]] [[ropeUnwound]] [[ropeAttachedTo]] [[ropeCreate]] [[ropeDetach]] [[ropeAttachEnabled]] [[ropeCut]] [[ropeEndPosition]] [[ropeUnwind]] [[setSlingLoad]] [[slingLoadAssistantShown]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
}}

Latest revision as of 16:26, 9 February 2024

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

Description

Description:
Returns true if setSlingLoad is possible.
Groups:
Ropes and Sling Loading

Syntax

Syntax:
heli canSlingLoad cargo
Parameters:
heli: Object - a helicopter
cargo: Object - an entity
Return Value:
Boolean - true if setSlingLoad is possible

Alternative Syntax

Syntax:
typeOfHeli canSlingLoad typeOfCargo
Parameters:
typeOfHeli: String - a config type of helicopter
typeOfCargo: String - a config type of cargo (the object of type cargo has to exist in the mission)
Return Value:
Boolean - true if can be sling loaded in principle

Examples

Example 1:
_canSling = veh1 canSlingLoad veh2;
Example 2:
hint str ((vehicle player) canSlingLoad veh1);

Additional Information

See also:
ropes enableRopeAttach getSlingLoad ropeAttachedObjects ropeAttachTo ropeDestroy ropeLength ropeUnwound ropeAttachedTo ropeCreate ropeDetach ropeAttachEnabled ropeCut ropeEndPosition 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=canSlingLoad&oldid=352426"