BIS fnc carrier01AnimateDeflectors: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.68


| arma3 |= Game name
|arg= local
|eff= local


|1.00|= Game version
|gr1= Aircraft Carrier
____________________________________________________________________________________________


| <pre>/*
|descr= Plays a set of animations to animate the carriers' catapult jet blast deflectors. See [[Arma 3: Aircraft Systems]] for information about needed config changes.
Author: Bravo Zero One development
- John_Spartan & Jiri Wainar


Description:
|s1= [carrierPart, animations, animationState] spawn [[BIS_fnc_carrier01AnimateDeflectors]]
- On demand function to invoke set of animations associated with carrier catapult jet blast deflector.


Exucution:
|p1 = carrierPart: [[Object]] - part to animate
- Call the function via code/script


[_carrierPart, _animations, 10] spawn BIS_fnc_Carrier01AnimateDeflectors;
|p2 = animations: [[Array]] - animations to be played


Requirments:
|p3 = animationState: [[Number]] - animation state
- Compatible carrier part must have a config definition for all sub-systems that will be invoked by this function


example of cfgVehicles subclass definitions for carrier part;
|r1= [[Nothing]]
class Catapults
{
class Catapult1
{
memoryPoint = "pos_catapult_01"; Memory point in carrier part model.p3d
dirOffset = -5.5; Offset angle in degrees between carrier part direction and actual catapult launch direction
animations[] = {"Deflector_1","Deflector_1_hydraulic_1", "Deflector_1_hydraulic_2","Deflector_1_hydraulic_3"}; Array with animation names for carrier part jet blast deflectors
launchActionName = "$STR_A3_action_launchFromCatapult_1"; Visual display name of "Attach Action"
detachActionName = "$STR_A3_action_detachFromCatapult_1"; Visual display name of "Dettach Action"
};
};


Parameter(s):
|x1= <sqf>[_carrierPart, ["Deflector_1", "Deflector_1_hydraulic_1", "Deflector_1_hydraulic_2", "Deflector_1_hydraulic_3"], 10] spawn BIS_fnc_carrier01AnimateDeflectors;</sqf>
_this select 0: mode (Scalar)
0: carrier part/object to animate
1: animations/array of animations to animate
2: animationState/int for required animation state


|exec = spawn


Returns: nothing
|seealso= [[BIS_fnc_aircraftTailhook]] [[BIS_fnc_aircraftCatapultLaunch]]
Result: Aircraft carrier part's specified catapult's animations are played/animated
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_Carrier01AnimateDeflectors]]; --> |SYNTAX=
|p1= |= Parameter 1
 
| |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |SEEALSO=
 
}}
}}
<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: AircraftCarrier|{{uc:Carrier01AnimateDeflectors}}]]
[[Category:Functions|{{uc:Carrier01AnimateDeflectors}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:Carrier01AnimateDeflectors}}]]

Latest revision as of 20:57, 13 May 2022

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

Description

Description:
Plays a set of animations to animate the carriers' catapult jet blast deflectors. See Arma 3: Aircraft Systems for information about needed config changes.
Execution:
spawn
Groups:
Aircraft Carrier

Syntax

Syntax:
[carrierPart, animations, animationState] spawn BIS_fnc_carrier01AnimateDeflectors
Parameters:
carrierPart: Object - part to animate
animations: Array - animations to be played
animationState: Number - animation state
Return Value:
Nothing

Examples

Example 1:
[_carrierPart, ["Deflector_1", "Deflector_1_hydraulic_1", "Deflector_1_hydraulic_2", "Deflector_1_hydraulic_3"], 10] spawn BIS_fnc_carrier01AnimateDeflectors;

Additional Information

See also:
BIS_fnc_aircraftTailhook BIS_fnc_aircraftCatapultLaunch

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=BIS_fnc_carrier01AnimateDeflectors&oldid=321361"