{"name":"captive","operator":null,"title":"captive","type":"command","url":"https://community.bistudio.com/wiki/captive","revid":318573,"updated":"2022-05-13T09:21:07Z","groups":["Object Manipulation","Sides"],"status":"ok","replaced_by":[],"games":[{"game":"ofp","name":"Operation Flashpoint","version":"1.00"},{"game":"ofpe","name":"Operation Flashpoint: Elite","version":"1.00"},{"game":"arma1","name":"Armed Assault","version":"1.00"},{"game":"arma2","name":"Arma 2","version":"1.00"},{"game":"arma2oa","name":"Arma 2: Operation Arrowhead","version":"1.50"},{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"ofp","name":"Operation Flashpoint","version":"1.00"},"arma3_since":"0.50","branch":null,"locality":{"argument":"global","effect":null,"server_exec":false},"exec":null,"description":"Returns the captive state of the given unit (set with setCaptive). A captive unit will not be attacked by its enemies.\n\n> [!IMPORTANT]\n> While a captive unit won't be attacked, it will still attack its enemies – be sure to setBehaviour \"CARELESS\" / removeAllWeapons accordingly.","syntaxes":[{"syntax":"captive object","since":null,"effect":null,"exec":null,"params":[{"name":"object","type":"Object","optional":false,"default":null,"description":"unit or vehicle","types":["Object"],"since":null,"text":"object: Object - unit or vehicle"}],"returns":{"type":"Boolean","types":["Boolean"],"description":"true if the unit is captive, false if not","text":"Boolean - true if the unit is captive, false if not"},"form":"unary","operator":null,"left":null,"right":{"text":"object","types":["Object"]}}],"examples":[{"text":"```sqf\nif (captive _general) then { removeAllWeapons _general; };\n```","code":["if (captive _general) then { removeAllWeapons _general; };"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["captiveNum","setCaptive","side"],"notes":[],"categories":["ArmA: Armed Assault: Scripting Commands","Arma 2: Operation Arrowhead: Scripting Commands","Arma 2: Scripting Commands","Arma 3: Scripting Commands","Command Group: Object Manipulation","Command Group: Sides","Introduced with Operation Flashpoint version 1.00","Operation Flashpoint: Elite: Scripting Commands","Operation Flashpoint: New Scripting Commands","Operation Flashpoint: Scripting Commands","Scripting Commands","Take On Helicopters: Scripting Commands"]}