{"name":"BIS_fnc_moduleRespawnVehicle","operator":null,"title":"BIS fnc moduleRespawnVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRespawnVehicle","revid":364509,"updated":"2024-05-16T20:42:07Z","groups":["Modules","Broken Functions"],"status":"broken","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":"Set vehicle respawn, compatible both with SP and MP.\n\n> [!NOTE]\n> Respawned abandoned vehicles do not reduce respawn tickets","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4, param5, param6, param7, param8] call BIS_fnc_moduleRespawnVehicle","since":null,"effect":null,"exec":null,"params":[{"name":"param0","type":"Object","types":["Object"],"optional":false,"default":null,"description":"vehicle","since":null,"text":"0: OBJECT - vehicle","source":"docblock"},{"name":"param1","type":"Number, Boolean","types":["Number","Boolean"],"optional":false,"default":"0","description":"NUMBER - respawn delay in seconds (default is 0)\nBOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn","since":null,"text":"1: NUMBER - respawn delay in seconds (default is 0)\nBOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn","source":"docblock"},{"name":"param2","type":"Number","types":["Number"],"optional":false,"default":"-1, i.e., disabled","description":"how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)","since":null,"text":"2: NUMBER - how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)","source":"docblock"},{"name":"param3","type":"Number","types":["Number"],"optional":false,"default":"-1, i.e., unlimited","description":"number of time the vehicle can be respawned (default is -1, i.e., unlimited)","since":null,"text":"3: NUMBER - number of time the vehicle can be respawned (default is -1, i.e., unlimited)","source":"docblock"},{"name":"param4","type":"Code","types":["Code"],"optional":false,"default":null,"description":"code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.","since":null,"text":"4: CODE - code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.","source":"docblock"},{"name":"param5","type":"Position","types":["Position"],"optional":false,"default":null,"description":"type of respawn position:\n0 = where it started\n1 = where it was destroyed\n2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n3 = on BLUFOR respawn marker\n4 = on OPFOR respawn marker\n5 = on Independent respawn marker\n6 = on Civilian respawn marker\n7 = on side respawn marker of unit which destroyed the vehicle","since":null,"text":"5: POSITION - type of respawn position:\n0 = where it started\n1 = where it was destroyed\n2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n3 = on BLUFOR respawn marker\n4 = on OPFOR respawn marker\n5 = on Independent respawn marker\n6 = on Civilian respawn marker\n7 = on side respawn marker of unit which destroyed the vehicle","source":"docblock"},{"name":"param6","type":"Number","types":["Number"],"optional":false,"default":null,"description":"position selection type (0 = random, 1 = newest, 2 = oldest)","since":null,"text":"6: NUMBER - position selection type (0 = random, 1 = newest, 2 = oldest)","source":"docblock"},{"name":"param7","type":"Number","types":["Number"],"optional":false,"default":null,"description":"type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)","since":null,"text":"7: NUMBER - type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)","source":"docblock"},{"name":"param8","type":"Boolean","types":["Boolean"],"optional":false,"default":null,"description":"true to show notifcation when the vehicle is respawned","since":null,"text":"8: BOOL - true to show notifcation when the vehicle is respawned","source":"docblock"}],"returns":{"type":"Boolean","types":["Boolean"],"description":null,"text":"BOOL","source":"docblock"},"inferred":true}],"examples":[],"multiplayer":null,"problems":null,"aliases":[],"see_also":[],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Broken Functions","Function Group: Modules","Functions","Introduced with Arma 3 version 1.00"],"docblock":{"author":null,"description":"Set vehicle respawn, compatible both with SP and MP.","params":[{"index":0,"name":null,"types":["Object"],"optional":false,"default":null,"description":"vehicle","text":"OBJECT - vehicle"},{"index":1,"name":null,"types":["Number","Boolean"],"optional":false,"default":"0","description":"NUMBER - respawn delay in seconds (default is 0)\nBOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn","text":"NUMBER - respawn delay in seconds (default is 0)\nBOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn"},{"index":2,"name":null,"types":["Number"],"optional":false,"default":"-1, i.e., disabled","description":"how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)","text":"NUMBER - how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)"},{"index":3,"name":null,"types":["Number"],"optional":false,"default":"-1, i.e., unlimited","description":"number of time the vehicle can be respawned (default is -1, i.e., unlimited)","text":"NUMBER - number of time the vehicle can be respawned (default is -1, i.e., unlimited)"},{"index":4,"name":null,"types":["Code"],"optional":false,"default":null,"description":"code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.","text":"CODE - code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed."},{"index":5,"name":null,"types":["Position"],"optional":false,"default":null,"description":"type of respawn position:\n0 = where it started\n1 = where it was destroyed\n2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n3 = on BLUFOR respawn marker\n4 = on OPFOR respawn marker\n5 = on Independent respawn marker\n6 = on Civilian respawn marker\n7 = on side respawn marker of unit which destroyed the vehicle","text":"POSITION - type of respawn position:\n0 = where it started\n1 = where it was destroyed\n2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n3 = on BLUFOR respawn marker\n4 = on OPFOR respawn marker\n5 = on Independent respawn marker\n6 = on Civilian respawn marker\n7 = on side respawn marker of unit which destroyed the vehicle"},{"index":6,"name":null,"types":["Number"],"optional":false,"default":null,"description":"position selection type (0 = random, 1 = newest, 2 = oldest)","text":"NUMBER - position selection type (0 = random, 1 = newest, 2 = oldest)"},{"index":7,"name":null,"types":["Number"],"optional":false,"default":null,"description":"type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)","text":"NUMBER - type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)"},{"index":8,"name":null,"types":["Boolean"],"optional":false,"default":null,"description":"true to show notifcation when the vehicle is respawned","text":"BOOL - true to show notifcation when the vehicle is respawned"}],"returns":{"types":["Boolean"],"text":"BOOL"},"examples":[],"syntax":null,"execution":null,"notes":null,"requirements":null,"meta":{},"text":"Description:\nSet vehicle respawn, compatible both with SP and MP.\n\nParameter(s):\n    0: OBJECT - vehicle\n    1:\n        NUMBER - respawn delay in seconds (default is 0)\n        BOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn\n    2: NUMBER - how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)\n    3: NUMBER - number of time the vehicle can be respawned (default is -1, i.e., unlimited)\n    4: CODE - code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.\n    5: POSITION - type of respawn position:\n        0 = where it started\n        1 = where it was destroyed\n        2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n        3 = on BLUFOR respawn marker\n        4 = on OPFOR respawn marker\n        5 = on Independent respawn marker\n        6 = on Civilian respawn marker\n        7 = on side respawn marker of unit which destroyed the vehicle\n    6: NUMBER - position selection type (0 = random, 1 = newest, 2 = oldest)\n    7: NUMBER - type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)\n    8: BOOL - true to show notifcation when the vehicle is respawned\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]}