{"name":"BIS_fnc_moduleFriendlyFire","operator":null,"title":"BIS fnc moduleFriendlyFire","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFriendlyFire","revid":349534,"updated":"2023-11-08T17:16:42Z","groups":["Modules"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Handles the friendly fire. Use either the module interface in the editor, or call individual functions.","syntaxes":[{"syntax":"[param1, param2] call BIS_fnc_moduleFriendlyFire","since":null,"effect":null,"exec":null,"params":[{"name":"param1","type":null,"types":[],"optional":false,"default":null,"description":"string, list of functions:\n- Init\n- Destroy\n- AddUnits\n- RemoveUnits\n- ChangePriority\n- ListActiveUnit","since":null,"text":"1: function called - string, list of functions:\n- Init\n- Destroy\n- AddUnits\n- RemoveUnits\n- ChangePriority\n- ListActiveUnit","source":"docblock"},{"name":"param2","type":null,"types":[],"optional":false,"default":null,"description":"parameter for the function","since":null,"text":"2: parameter for the function","source":"docblock"}],"returns":{"type":null,"types":[],"description":null,"text":"depends on the function called","source":"docblock"},"inferred":true}],"examples":[{"text":"```sqf\n// Initializes the module if not added in editor\n// No units are directly checked for friendly fire, but renegade state is checked anyway\n_ret = [\"Init\", []] call BIS_fnc_moduleFriendlyFire\n```","code":["// Initializes the module if not added in editor\n// No units are directly checked for friendly fire, but renegade state is checked anyway\n_ret = [\"Init\", []] call BIS_fnc_moduleFriendlyFire"]},{"text":"```sqf\n// Initializes the module if not added in editor\n// BIS_vip1, BIS_vip2, BIS_noVip units are directly checked for friendly fire\nx = [\"Init\", [[BIS_vip1, BIS_vip2, BIS_noVip],true]] call BIS_fnc_moduleFriendlyFire\n```","code":["// Initializes the module if not added in editor\n// BIS_vip1, BIS_vip2, BIS_noVip units are directly checked for friendly fire\nx = [\"Init\", [[BIS_vip1, BIS_vip2, BIS_noVip],true]] call BIS_fnc_moduleFriendlyFire"]},{"text":"```sqf\n// De-initializes the module\n_ret = [\"Destroy\"] call BIS_fnc_moduleFriendlyFire\n```","code":["// De-initializes the module\n_ret = [\"Destroy\"] call BIS_fnc_moduleFriendlyFire"]},{"text":"```sqf\n// Add BIS_vip3 unit to be checked for friendly fire\nx = [\"AddUnits\", [[BIS_vip3]]] call BIS_fnc_moduleFriendlyFire\n```","code":["// Add BIS_vip3 unit to be checked for friendly fire\nx = [\"AddUnits\", [[BIS_vip3]]] call BIS_fnc_moduleFriendlyFire"]},{"text":"```sqf\n// Remove BIS_vip1 unit from active units\nx = [\"RemoveUnits\", [[BIS_vip1]]] call BIS_fnc_moduleFriendlyFire\n```","code":["// Remove BIS_vip1 unit from active units\nx = [\"RemoveUnits\", [[BIS_vip1]]] call BIS_fnc_moduleFriendlyFire"]},{"text":"```sqf\n// set another priority for a vehicle- if it is hit once, considered as friendly fire\nx = [\"ChangePriority\",  [BIS_vip,1]] call BIS_fnc_moduleFriendlyFire\n```","code":["// set another priority for a vehicle- if it is hit once, considered as friendly fire\nx = [\"ChangePriority\",  [BIS_vip,1]] call BIS_fnc_moduleFriendlyFire"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":[],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Modules","Functions","Introduced with Arma 3 version 1.00"],"docblock":{"author":"Zozo","description":"Handles the friendly fire. Use either the module interface in the editor, or call individual functions.","params":[{"index":1,"name":null,"types":[],"optional":false,"default":null,"description":"string, list of functions:\n- Init\n- Destroy\n- AddUnits\n- RemoveUnits\n- ChangePriority\n- ListActiveUnit","text":"function called - string, list of functions:\n- Init\n- Destroy\n- AddUnits\n- RemoveUnits\n- ChangePriority\n- ListActiveUnit"},{"index":2,"name":null,"types":[],"optional":false,"default":null,"description":"parameter for the function","text":"parameter for the function"}],"returns":{"types":[],"text":"depends on the function called"},"examples":["// Initializes the module if not added in editor\n// No units are directly checked for friendly fire, but renegade state is checked anyway\n_ret = [\"Init\", []] call BIS_fnc_moduleFriendlyFire","// Initializes the module if not added in editor\n// BIS_vip1, BIS_vip2, BIS_noVip units are directly checked for friendly fire\nx = [\"Init\", [[BIS_vip1, BIS_vip2, BIS_noVip],true]] call BIS_fnc_moduleFriendlyFire","// De-initializes the module\n_ret = [\"Destroy\"] call BIS_fnc_moduleFriendlyFire","// Add BIS_vip3 unit to be checked for friendly fire\nx = [\"AddUnits\", [[BIS_vip3]]] call BIS_fnc_moduleFriendlyFire","// Remove BIS_vip1 unit from active units\nx = [\"RemoveUnits\", [[BIS_vip1]]] call BIS_fnc_moduleFriendlyFire","// set another priority for a vehicle- if it is hit once, considered as friendly fire\nx = [\"ChangePriority\",  [BIS_vip,1]] call BIS_fnc_moduleFriendlyFire"],"syntax":null,"execution":null,"notes":null,"requirements":null,"meta":{"version":"2.0","name":"Friendly Fire"},"text":"Version:            2.0\nName:                Friendly Fire\nAuthor:                Zozo\nDESCRIPTION:    Handles the friendly fire. Use either the module interface in the editor, or call individual functions.\nPARAMETERS:        1) function called - string, list of functions:\n            - Init\n            - Destroy\n            - AddUnits\n            - RemoveUnits\n            - ChangePriority\n            - ListActiveUnit\n            2) parameter for the function\nRETURNED VALUE:    depends on the function called\n    EXAMPLES:\n            // Initializes the module if not added in editor\n            // No units are directly checked for friendly fire, but renegade state is checked anyway\n            _ret = [\"Init\", []] call BIS_fnc_moduleFriendlyFire\n\n            // Initializes the module if not added in editor\n            // BIS_vip1, BIS_vip2, BIS_noVip units are directly checked for friendly fire\n            x = [\"Init\", [[BIS_vip1, BIS_vip2, BIS_noVip],true]] call BIS_fnc_moduleFriendlyFire\n\n            // De-initializes the module\n            _ret = [\"Destroy\"] call BIS_fnc_moduleFriendlyFire\n\n            // Add BIS_vip3 unit to be checked for friendly fire\n            x = [\"AddUnits\", [[BIS_vip3]]] call BIS_fnc_moduleFriendlyFire\n\n            // Remove BIS_vip1 unit from active units\n            x = [\"RemoveUnits\", [[BIS_vip1]]] call BIS_fnc_moduleFriendlyFire\n\n            // set another priority for a vehicle- if it is hit once, considered as friendly fire\n            x = [\"ChangePriority\",  [BIS_vip,1]] call BIS_fnc_moduleFriendlyFire"},"filled_from_docblock":["description","params","syntax","returns","examples"]}