BIS fnc doorClose: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Some wiki formatting)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Scripts


<!---|arg= local |Multiplayer Arguments=--->
|arg= global


<!---|eff= local |Multiplayer Effects=--->
|eff= global


| ''N/A'' |Description=
|descr= Close a door with an animated doorhandle.


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


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p1= building: [[Object]] - (Optional, default [[objNull]]) building


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


|x1= <code></code>|Example 1=
|p3= handleDownAnimation: [[String]] - (Optional, default "") animation source of handle down


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


| |See also=
|p5= animationPhase: [[Number]] - (Optional, default 0) value from 0-1
 
|r1= [[Nothing]]
 
|x1= <sqf>[building, "doorAnimation", "animationUp", "animationDown", 1] call BIS_fnc_doorClose;</sqf>
 
|seealso= [[animate]] [[animateSource]] [[BIS_fnc_door]]
}}
}}
[[Category:Function Group: Scripts|{{uc:DoorClose}}]]
[[Category:Functions|{{uc:DoorClose}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:DoorClose}}]]

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