BIS fnc doorOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(21 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= Open a door with an animated doorhandle.


|[] call [[BIS_fnc_DoorOpen]]|Syntax=
{{Feature|informative|This function uses [[animate]] internally.}}


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|s1= [building, doorAnimation, upDownAnimation, downUpAnimation, animationPhase] call [[BIS_fnc_doorOpen]]


|Datatype - description|Return value=
|p1= building: [[Object]] - (Optional, default [[objNull]])


|x1= <code></code>|Example 1=
|p2= doorAnimation: [[String]] - (Optional, default "")


|exec= call |Execution=
|p3= upDownAnimation: [[String]] - (Optional, default "")


| |See also=
|p4= downUpAnimation: [[String]] - (Optional, default "")
 
|p5= animationPhase: [[Number]] - (Optional, default 1)
 
|r1= [[Nothing]]
 
|x1= <sqf>[_house, "door_1_rot", nil, nil, 0.25]  call BIS_fnc_doorOpen;</sqf>
 
|seealso= [[BIS_fnc_doorClose]] [[BIS_fnc_door]] [[animate]] [[animateSource]] [[animateDoor]]
}}
}}
[[Category:Function Group: Scripts|{{uc:DoorOpen}}]]
[[Category:Functions|{{uc:DoorOpen}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:DoorOpen}}]]

Latest revision as of 21:41, 16 May 2024

Hover & click on the images for description

Description

Description:
Open a door with an animated doorhandle.
This function uses animate internally.
Execution:
call
Groups:
Scripts

Syntax

Syntax:
[building, doorAnimation, upDownAnimation, downUpAnimation, animationPhase] call BIS_fnc_doorOpen
Parameters:
building: Object - (Optional, default objNull)
doorAnimation: String - (Optional, default "")
upDownAnimation: String - (Optional, default "")
downUpAnimation: String - (Optional, default "")
animationPhase: Number - (Optional, default 1)
Return Value:
Nothing

Examples

Example 1:
[_house, "door_1_rot", nil, nil, 0.25] call BIS_fnc_doorOpen;

Additional Information

See also:
BIS_fnc_doorClose BIS_fnc_door animate animateSource animateDoor

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