BIS fnc destroyer01OperateHangarDoors: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (adding cat)
m (Some wiki formatting)
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.84


|1.84|Game version=
|gr1= Destroyer


<!---|arg= local |Multiplayer Arguments=--->
|descr= This function is designed to handle animations of ship hangar doors from vehicle user action (see {{Link|#Examples}}).
It calls [[BIS_fnc_destroyer01AnimateHangarDoors]].


<!---|eff= local |Multiplayer Effects=--->
{{Feature|important|Object (ship) must have all animations correctly defined and user actions configured.}}


| <pre>/*
|s1= [shipPart, doorState] call [[BIS_fnc_destroyer01OperateHangarDoors]]
Author: Bravo Zero One development
- John_Spartan


Description:
|p1= shipPart: [[Object]]
- This is a sub function designed to handle animations of ship hangar doors.


Execution:
|p2= doorState: [[Number]] - doors' animation state; 1 to open, 0 to close
- Call from vehicle user actions.


Example:
|r1= [[Nothing]]
class OpenHangarDoor_1
{
displayNameDefault ="<img image='\A3\Ui_f\data\IGUI\Cfg\Actions\open_door_ca.paa' size='2.5' />";
displayName = $STR_DN_OUT_O_DOOR;
position = "pos_Door_Hangar_1_Trigger";
priority = 0.4;
radius = 1.5;
onlyForPlayer = 0;
condition = "(((nearestObjects [this,[""Land_Destroyer_01_hull_04_F""],50, false]) select 0) animationPhase ""Door_Hangar_1_1_open"") < 0.1;";
statement = "[this,1] call bis_fnc_destroyer01OperateHangarDoors;";
};
class CloseHangarDoor_1: OpenHangarDoor_1
{
displayName = $STR_DN_OUT_C_DOOR;
position = "pos_Door_Hangar_1_Trigger";
condition = "(((nearestObjects [this,[""Land_Destroyer_01_hull_04_F""],50, false]) select 0) animationPhase ""Door_Hangar_1_1_open"") >= 0.1;";
statement = "[this,0] call bis_fnc_destroyer01OperateHangarDoors;";
};


Required:
|x1= <sqf>
Object (ship) must have all animations correctly defined and user actions configured.
[this, 1] call BIS_fnc_destroyer01OperateHangarDoors; // to open doors
[this, 0] call BIS_fnc_destroyer01OperateHangarDoors; // to close doors
</sqf>


Parameter(s):
<syntaxhighlight lang="cpp">
_this select 0: mode (Scalar)
class OpenHangarDoor_1
0: ship-part object
{
and
displayNameDefault = "<img image='\A3\Ui_f\data\IGUI\Cfg\Actions\open_door_ca.paa' size='2.5' />";
1: animation state of doors
displayName = "$STR_DN_OUT_O_DOOR";
position = "pos_Door_Hangar_1_Trigger";
priority = 0.4;
radius = 1.5;
onlyForPlayer = 0;
condition = "(((nearestObjects [this, ['Land_Destroyer_01_hull_04_F'], 50, false]) select 0) animationPhase 'Door_Hangar_1_1_open') < 0.1;";
statement = "[this, 1] call BIS_fnc_destroyer01OperateHangarDoors;";
};


Returns: nothing
class CloseHangarDoor_1 : OpenHangarDoor_1
Result: Ship's hangar door animation is played with sounds added.
{
Calls bis_fnc_destroyer01AnimateHangarDoors to execute action.
displayName = "$STR_DN_OUT_C_DOOR";
position = "pos_Door_Hangar_1_Trigger";
condition = "(((nearestObjects [this, ['Land_Destroyer_01_hull_04_F'], 50, false]) select 0) animationPhase 'Door_Hangar_1_1_open') >= 0.1;";
statement = "[this, 0] call BIS_fnc_destroyer01OperateHangarDoors;";
};
</syntaxhighlight>


*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
|seealso= [[BIS_fnc_destroyer01AnimateHangarDoors]]
 
|[] call [[BIS_fnc_Destroyer01OperateHangarDoors]]|Syntax=
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Destroyer|{{uc:Destroyer01OperateHangarDoors}}]]
[[Category:Functions|{{uc:Destroyer01OperateHangarDoors}}]]
[[Category:Placeholder function]]

Latest revision as of 21:08, 13 June 2024

Arma 3 logo black.png1.84
Hover & click on the images for description

Description

Description:
This function is designed to handle animations of ship hangar doors from vehicle user action (see Examples). It calls BIS_fnc_destroyer01AnimateHangarDoors.
⚠
Object (ship) must have all animations correctly defined and user actions configured.
Execution:
call
Groups:
Destroyer

Syntax

Syntax:
[shipPart, doorState] call BIS_fnc_destroyer01OperateHangarDoors
Parameters:
shipPart: Object
doorState: Number - doors' animation state; 1 to open, 0 to close
Return Value:
Nothing

Examples

Example 1:
[this, 1] call BIS_fnc_destroyer01OperateHangarDoors; // to open doors [this, 0] call BIS_fnc_destroyer01OperateHangarDoors; // to close doors
class OpenHangarDoor_1
{
	displayNameDefault		= "<img image='\A3\Ui_f\data\IGUI\Cfg\Actions\open_door_ca.paa' size='2.5' />";
	displayName 			= "$STR_DN_OUT_O_DOOR";
	position 				= "pos_Door_Hangar_1_Trigger";
	priority 				= 0.4;
	radius 					= 1.5;
	onlyForPlayer 			= 0;
	condition 				= "(((nearestObjects [this, ['Land_Destroyer_01_hull_04_F'], 50, false]) select 0) animationPhase 'Door_Hangar_1_1_open') < 0.1;";
	statement 				= "[this, 1] call BIS_fnc_destroyer01OperateHangarDoors;";
};

class CloseHangarDoor_1 : OpenHangarDoor_1
{
	displayName 			= "$STR_DN_OUT_C_DOOR";
	position 				= "pos_Door_Hangar_1_Trigger";
	condition 				= "(((nearestObjects [this, ['Land_Destroyer_01_hull_04_F'], 50, false]) select 0) animationPhase 'Door_Hangar_1_1_open') >= 0.1;";
	statement 				= "[this, 0] call BIS_fnc_destroyer01OperateHangarDoors;";
};

Additional Information

See also:
BIS_fnc_destroyer01AnimateHangarDoors

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_destroyer01OperateHangarDoors&oldid=364795"