BIS fnc doorClose: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (filled page, needs proper example)
m (Some wiki formatting)
 
(19 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


<!--|exec= server|=-->
|arg= global


| arg = global | Effects in MP =
|eff= global


| eff = global | Effects in MP =
|descr= Close a door with an animated doorhandle.


|Open a door with an animated doorhandle.|Description=
|s1= [building, doorAnimation, handleDownAnimation, doorHandleUpAnimation, animationPhase] call [[BIS_fnc_doorClose]]


|mp= Effect is global|=
|p1= building: [[Object]] - (Optional, default [[objNull]]) building


|[building, door, doorHandleUp, doorHandleDown, animationPhase] call [[BIS_fnc_DoorOpen]]|SYNTAX=
|p2= doorAnimation: [[String]] - (Optional, default "") name of the door animation


|p1=building: [[Object]] - (Optional, default [[ObjNull]]) Building|PARAMETER1=
|p3= handleDownAnimation: [[String]] - (Optional, default "") animation source of handle down


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


|p3=doorHandleUp: [[String]] - (Optional, default "") Handle up->down animation|PARAMETER1=
|p5= animationPhase: [[Number]] - (Optional, default 0) value from 0-1


|p4=doorHandleDown: [[String]] - (Optional, default "") Handle down->up animation|PARAMETER1=
|r1= [[Nothing]]


|p5=animationPhase: [[Number]] - (Optional, default 0) Value from 0 to 1|PARAMETER1=
|x1= <sqf>[building, "doorAnimation", "animationUp", "animationDown", 1] call BIS_fnc_doorClose;</sqf>


| [[Nothing]] |RETURNVALUE=
|seealso= [[animate]] [[animateSource]] [[BIS_fnc_door]]
 
|x1= <code>[building,"doorAnim","handleUpAnim","handleDownAnim"] [[call]] [[BIS_fnc_DoorOpen]];</code> |EXAMPLE1=
 
|exec= call |Execution=
 
| [[BIS_fnc_Door]] |See also=
}}
}}

Latest revision as of 12:13, 17 June 2024

Arma 3 logo black.png1.00
GAGlobalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_doorClose&oldid=364843"