BIS fnc doorClose: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (filled page, needs proper example)
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=


| arma3 |Game name=
|arma3|Game name=


|1.00|Game version=
|1.00|Game version=


<!---|arg= local |Multiplayer Arguments=--->
<!--|exec= server|=-->


<!---|eff= local |Multiplayer Effects=--->
| arg = global | Effects in MP =


| ''N/A'' |Description=
| eff = global | Effects in MP =


|[] call [[BIS_fnc_DoorClose]]|Syntax=
|Open a door with an animated doorhandle.|Description=


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|mp= Effect is global|=


|Datatype - description|Return value=
|[building, door, doorHandleUp, doorHandleDown, animationPhase] call [[BIS_fnc_DoorOpen]]|SYNTAX=


|x1= <code></code>|Example 1=
|p1=building: [[Object]] - (Optional, default [[ObjNull]]) Building|PARAMETER1=
 
|p2=door: [[String]] - (Optional, default "") Door animation|PARAMETER1=
 
|p3=doorHandleUp: [[String]] - (Optional, default "") Handle up->down animation|PARAMETER1=
 
|p4=doorHandleDown: [[String]] - (Optional, default "") Handle down->up animation|PARAMETER1=
 
|p5=animationPhase: [[Number]] - (Optional, default 0) Value from 0 to 1|PARAMETER1=
 
| [[Nothing]] |RETURNVALUE=
 
|x1= <code>[building,"doorAnim","handleUpAnim","handleDownAnim"] [[call]] [[BIS_fnc_DoorOpen]];</code> |EXAMPLE1=


|exec= call |Execution=
|exec= call |Execution=


| |See also=
| [[BIS_fnc_Door]] |See also=
}}
}}
[[Category:Function Group: Scripts|{{uc:DoorClose}}]]
[[Category:Functions|{{uc:DoorClose}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:DoorClose}}]]

Revision as of 20:07, 5 January 2020

Hover & click on the images for description

Description

Description:
Open a door with an animated doorhandle.
Execution:
call
Multiplayer:
Effect is global
Groups:
Uncategorised

Syntax

Syntax:
[building, door, doorHandleUp, doorHandleDown, animationPhase] call BIS_fnc_DoorOpen
Parameters:
building: Object - (Optional, default ObjNull) Building
door: String - (Optional, default "") Door animation
doorHandleUp: String - (Optional, default "") Handle up->down animation
doorHandleDown: String - (Optional, default "") Handle down->up animation
animationPhase: Number - (Optional, default 0) Value from 0 to 1
Return Value:
Nothing

Examples

Example 1:
[building,"doorAnim","handleUpAnim","handleDownAnim"] call BIS_fnc_DoorOpen;

Additional Information

See also:
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