BIS_fnc_animateFlag

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.67|1.67]]

Hover & click on the images for description

Description

Description:

Smoothly animates given flag from current position on the flag pole to the given position. The function is global, MP and JIP compatible, persistent and will syncronise flags across the network. When flag animation is done, the scripted event handler "FlagAnimationDone" is called. To add scripted event handler to the flag use:

_eh = [<yourflag>, "FlagAnimationDone", <yourcode>] call BIS_fnc_addScriptedEventHandler;

NOTE: Never put call to this function into object init field

Execution:

call

Groups:

Uncategorised

Syntax

Syntax:

[flag, phase, instant] call BIS_fnc_animateFlag

Parameters:

flag: Object - flag object of the type "FlagCarrier"

phase: Number - desired animation phase 0...1 (0 - bottom of the flag pole, 1 - top of the flag pole)

instant (Optional):

• Boolean - when true, animation is instant ("FlagAnimationDone" EH is not called in this case). Default: false
• Number - animation duration multiplier

Return Value:

Nothing

Examples

Example 1:

[flag1, 0] call BIS_fnc_animateFlag;

Additional Information

See also:

flagflagOwnersetFlagOwnersetFlagSidesetFlagTextureflagSideflagTexturesetFlagAnimationPhaseflagAnimationPhaseFlag Textures

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

[[Category:Introduced with arma3dev version 1.67]][[ Category: arma3dev: New Functions | BIS FNC ANIMATEFLAG]][[ Category: arma3dev: Functions | BIS FNC ANIMATEFLAG]]