animateBay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Some wiki formatting)
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma3 |Game name=
|game1= arma3
|version1= 1.70


|1.70|Game Version=
|eff= local


|eff= local |Multiplayer Effects=
|arg= global
|arg= global |Multiplayer Arguments=


|gr1= Animations |GROUP1=
|gr1= Animations
|gr2= Vehicle Loadouts |GROUP2=


____________________________________________________________________________________________
|gr2= Vehicle Loadouts


|Force animation of bay to given state, -1 for reset to engine handling, can cause weapon inoperative, because weapon is released when bay state <nowiki>=</nowiki>1.
|descr= Forces animation of bay to given state, -1 for reset to engine handling, can cause weapon inoperative, because weapon is released when bay state == 1.
<br><br>{{Informative | While there is no getter to read the animation phase of the given bay, [[animationPhase]] command can be used with the individual bay door name from [[animationNames]] as a workaround. For example for UCAV Sentinel <tt>ucav [[animateBay]] [1, 1]</tt> could be checked with <tt>ucav [[animationPhase]] "weapons_bay_l_1"</tt> or <tt>ucav [[animationPhase]] "weapons_bay_l_2"</tt>}}|DESCRIPTION=
{{Feature|informative|
____________________________________________________________________________________________
While there is no getter to read the animation phase of the given bay, the [[animationPhase]] command can be used with the individual bay door name from [[animationNames]] as a workaround (See {{Link|#Example 3}}).
}}
 
|s1= vehicle [[animateBay]] [bay, animphase, instant]


| vehicle '''animateBay''' [bay, animphase, instant] |SYNTAX=
|p1= vehicle: [[Object]]


|p1= vehicle: [[Object]] |PARAMETER1=
|p2= bay: [[Number]] - bay index (index starts from 1 and different from pylon index)
|p2= [bay, animphase, instant] : [[Array]] |PARAMETER2=
|p3= bay: [[Number]] - bay index (index starts from 1 and different from pylon index) |PARAMETER3=
|p4= animphase: [[Number]] - animation phase (0...1) |PARAMETER4=
|p5= instant (Optional): [[Boolean]] - animate immediately |PARAMETER5=


| [[Nothing]] |RETURNVALUE=
|p4= animphase: [[Number]] - animation phase in range 0..1


____________________________________________________________________________________________
|p5= instant: [[Boolean]] - (Optional, default [[false]]) animate immediately


|x1= <code>[[vehicle]] [[player]] [[animateBay]] [1, 0.5];</code>|EXAMPLE1=
|r1= [[Nothing]]
|x2= <code>[[vehicle]] [[player]] [[animateBay]] [1, 1, [[true]]];</code>|EXAMPLE2=
____________________________________________________________________________________________


| [[Arma 3 Vehicle Loadouts]],[[getCompatiblePylonMagazines]],[[getPylonMagazines]],[[setAmmoOnPylon]],[[ammoOnPylon]],[[animatePylon]],[[setPylonsPriority]],[[setPylonLoadout]] |SEEALSO=
|x1= <sqf>vehicle player animateBay [1, 0.5];</sqf>


}}
|x2= <sqf>vehicle player animateBay [1, 1, true];</sqf>


|x3= Getter example, here for the UCAV Sentinel:<sqf>
ucav animateBay [1, 1];
// can be checked with
ucav animationPhase "weapons_bay_l_1";
// or
ucav animationPhase "weapons_bay_l_2";
</sqf>


<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Arma 3: Vehicle Loadouts]] [[getCompatiblePylonMagazines]] [[getPylonMagazines]] [[setAmmoOnPylon]] [[ammoOnPylon]] [[animatePylon]] [[setPylonsPriority]] [[setPylonLoadout]]
{{GameCategory|arma3|New_Scripting_Commands_List}}
}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:17, 8 November 2023

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

Description

Description:
Forces animation of bay to given state, -1 for reset to engine handling, can cause weapon inoperative, because weapon is released when bay state == 1.
ⓘ
While there is no getter to read the animation phase of the given bay, the animationPhase command can be used with the individual bay door name from animationNames as a workaround (See Example 3).
Groups:
AnimationsVehicle Loadouts

Syntax

Syntax:
vehicle animateBay [bay, animphase, instant]
Parameters:
vehicle: Object
bay: Number - bay index (index starts from 1 and different from pylon index)
animphase: Number - animation phase in range 0..1
instant: Boolean - (Optional, default false) animate immediately
Return Value:
Nothing

Examples

Example 1:
vehicle player animateBay [1, 0.5];
Example 2:
vehicle player animateBay [1, 1, true];
Example 3:
Getter example, here for the UCAV Sentinel:
ucav animateBay [1, 1]; // can be checked with ucav animationPhase "weapons_bay_l_1"; // or ucav animationPhase "weapons_bay_l_2";

Additional Information

See also:
Arma 3: Vehicle Loadouts getCompatiblePylonMagazines getPylonMagazines setAmmoOnPylon ammoOnPylon animatePylon setPylonsPriority setPylonLoadout

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=animateBay&oldid=347988"