BIS fnc carAlarm: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - " |s1=[" to " |s1= [")
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.76


| arma3 |= Game name
|gr1= Object Manipulation


|1.76|= Game version
|descr= Play car alarm effect.
____________________________________________________________________________________________


| Play car alarm effect. |DESCRIPTION=
|s1= [mode, car] call [[BIS_fnc_carAlarm]]
____________________________________________________________________________________________
 
| [mode, car] call [[BIS_fnc_carAlarm]] |SYNTAX=


|p1= mode: [[String]] - can be one of:
|p1= mode: [[String]] - can be one of:
* "init": add "Hit" and "GetIn" event handler on the car
* "init": add "Hit" and "GetIn" event handler on the car
* "play": play the alarm effect |PARAMETER1=
* "play": play the alarm effect


|p2= car: [[Object]] - vehicle protected by alarm
|p2= car: [[Object]] - vehicle protected by alarm


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>["init", myCar] [[call]] [[BIS_fnc_carAlarm]];</code> |EXAMPLE1=
|x1= <sqf>["init", myCar] call BIS_fnc_carAlarm;</sqf>
____________________________________________________________________________________________


| [[Arma_3:_Event_Handlers|Arma 3 Event Handlers]] |SEEALSO=
|seealso= [[Arma_3:_Event_Handlers|Arma 3 Event Handlers]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:carAlarm}}]]
[[Category:Functions|{{uc:carAlarm}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:carAlarm}}]]

Latest revision as of 00:11, 13 July 2022

Hover & click on the images for description

Description

Description:
Play car alarm effect.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[mode, car] call BIS_fnc_carAlarm
Parameters:
mode: String - can be one of:
  • "init": add "Hit" and "GetIn" event handler on the car
  • "play": play the alarm effect
car: Object - vehicle protected by alarm
Return Value:
Nothing

Examples

Example 1:
["init", myCar] call BIS_fnc_carAlarm;

Additional Information

See also:
Arma 3 Event Handlers

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