BIS fnc doorClose: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )V([a-z])" to "$1v$3")
m (Some wiki formatting)
 
Line 10: Line 10:
|eff= global
|eff= global


|descr=Close a door with an animated doorhandle.
|descr= Close a door with an animated doorhandle.


|s1= [building, doorAnimation, handleDownAnimation, doorHandleUpAnimation, animationPhase] call [[BIS_fnc_doorClose]]
|s1= [building, doorAnimation, handleDownAnimation, doorHandleUpAnimation, animationPhase] call [[BIS_fnc_doorClose]]


|p1=building: [[Object]] - (Optional, default [[objNull]]) building
|p1= building: [[Object]] - (Optional, default [[objNull]]) building


|p2=doorAnimation: [[String]] - (Optional, default "") name of the door animation
|p2= doorAnimation: [[String]] - (Optional, default "") name of the door animation


|p3=handleDownAnimation: [[String]] - (Optional, default "") animation source of handle down
|p3= handleDownAnimation: [[String]] - (Optional, default "") animation source of handle down


|p4=doorHandleUpAnimation: [[String]] - (Optional, default "") animation source of handle up
|p4= doorHandleUpAnimation: [[String]] - (Optional, default "") animation source of handle up


|p5=animationPhase: [[Number]] - (Optional, default 0) value from 0-1
|p5= animationPhase: [[Number]] - (Optional, default 0) value from 0-1


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <sqf>[building,"doorAnimation","animationUp","animationDown",1] call BIS_fnc_doorClose;</sqf>
|x1= <sqf>[building, "doorAnimation", "animationUp", "animationDown", 1] call BIS_fnc_doorClose;</sqf>


|seealso= [[animate]] [[animateSource]] [[BIS_fnc_door]]
|seealso= [[animate]] [[animateSource]] [[BIS_fnc_door]]
}}
}}

Latest revision as of 12:13, 17 June 2024

Hover & click on the images for description

Description

Description:
Close a door with an animated doorhandle.
Execution:
call
Groups:
Scripts

Syntax

Syntax:
[building, doorAnimation, handleDownAnimation, doorHandleUpAnimation, animationPhase] call BIS_fnc_doorClose
Parameters:
building: Object - (Optional, default objNull) building
doorAnimation: String - (Optional, default "") name of the door animation
handleDownAnimation: String - (Optional, default "") animation source of handle down
doorHandleUpAnimation: String - (Optional, default "") animation source of handle up
animationPhase: Number - (Optional, default 0) value from 0-1
Return Value:
Nothing

Examples

Example 1:
[building, "doorAnimation", "animationUp", "animationDown", 1] call BIS_fnc_doorClose;

Additional Information

See also:
animate animateSource BIS_fnc_door

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