BIS fnc doorOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix returned value)
m (Text replacement - "| arma3 |1.00 " to "|game1= arma3 |version1= 1.00 ")
(11 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= global |Multiplayer Arguments=
|arg= global


|eff= global |Multiplayer Effects=
|eff= global


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


{{Informative | This function uses [[animate]] internally.}} |Description=
{{Feature | Informative | This function uses [[animate]] internally.}}


| [building, doorAnimation, upDownAnimation, downUpAnimation, animationPhase] call [[BIS_fnc_doorOpen]] |Syntax=
|s1=[building, doorAnimation, upDownAnimation, downUpAnimation, animationPhase] call [[BIS_fnc_doorOpen]]


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


|p2= doorAnimation: [[String]] - (Optional, default "") |Parameter 2=
|p2= doorAnimation: [[String]] - (Optional, default "")


|p3= upDownAnimation: [[String]] - (Optional, default "") |Parameter 3=
|p3= upDownAnimation: [[String]] - (Optional, default "")


|p4= downUpAnimation: [[String]] - (Optional, default "") |Parameter 4=
|p4= downUpAnimation: [[String]] - (Optional, default "")


|p5= animationPhase: [[Number]] - (Optional, default 1) |Parameter 5=
|p5= animationPhase: [[Number]] - (Optional, default 1)


| [[Nothing]] |Return value=
|r1= [[Nothing]]


|x1= <code>[_house, "door_1_rot", [[nil]], [[nil]], 0.25]  [[call]] [[BIS_fnc_doorOpen]];</code> |Example 1=
|x1= <code>[_house, "door_1_rot", [[nil]], [[nil]], 0.25]  [[call]] [[BIS_fnc_doorOpen]];</code>


| [[BIS_fnc_doorClose]] [[BIS_fnc_door]] [[animate]] [[animateSource]] [[animateDoor]] |See also=
|seealso= [[BIS_fnc_doorClose]] [[BIS_fnc_door]] [[animate]] [[animateSource]] [[animateDoor]]
}}
}}
[[Category:Function Group: Scripts|{{uc:DoorOpen}}]]

Revision as of 23:38, 13 June 2021

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