{"name":"BIS_fnc_boatRack01AdjustZOffset","operator":null,"title":"BIS fnc boatRack01AdjustZOffset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01AdjustZOffset","revid":286020,"updated":"2021-06-20T17:24:24Z","groups":["Boat Recovery"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.84"}],"since":{"game":"arma3","name":"Arma 3","version":"1.84"},"arma3_since":"1.84","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"- This is sub function for 'boat recovery' functionality.","syntaxes":[{"syntax":"[] call BIS_fnc_boatRack01AdjustZOffset","since":null,"effect":null,"exec":null,"params":[{"name":"mode","type":"Number","types":["Number"],"optional":false,"default":null,"description":"(Scalar)","since":null,"text":"0: (Scalar)","source":"docblock"},{"name":"param0","type":null,"types":[],"optional":false,"default":null,"description":"boat rack object","since":null,"text":"0: boat rack object","source":"docblock"},{"name":"param1","type":null,"types":[],"optional":false,"default":null,"description":"boat in cargo\nand\nother parameters from boat rack's cfgVehicles configuration.","since":null,"text":"1: boat in cargo\nand\nother parameters from boat rack's cfgVehicles configuration.","source":"docblock"}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"nothing\nAdjusts the hight (Z offset) of boat rack suspension to prevent different boats clipping with visual mesh.","source":"docblock"}}],"examples":[{"text":"```sqf\n[_boatRack, _boat] call BIS_fnc_boatRack01AdjustZOffset;\n```","code":["[_boatRack, _boat] call BIS_fnc_boatRack01AdjustZOffset;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":[],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Boat Recovery","Functions","Introduced with Arma 3 version 1.84"],"docblock":{"author":"Bravo Zero One development, John_Spartan","description":"- This is sub function for 'boat recovery' functionality.","params":[{"index":0,"name":"mode","types":["Number"],"optional":false,"default":null,"description":"(Scalar)","text":"(Scalar)"},{"index":0,"name":null,"types":[],"optional":false,"default":null,"description":"boat rack object","text":"boat rack object"},{"index":1,"name":null,"types":[],"optional":false,"default":null,"description":"boat in cargo\nand\nother parameters from boat rack's cfgVehicles configuration.","text":"boat in cargo\nand\nother parameters from boat rack's cfgVehicles configuration."}],"returns":{"types":["Nothing"],"text":"nothing\nAdjusts the hight (Z offset) of boat rack suspension to prevent different boats clipping with visual mesh."},"examples":["[_boatRack, _boat] call BIS_fnc_boatRack01AdjustZOffset;"],"syntax":null,"execution":"- Call from Init EH script that is added to object (boat rack) or from action code.","notes":null,"requirements":"Object (boat rack) must have vehicle in vehicle behavior configured (https://community.bistudio.com/wiki/Arma_3_Vehicle_in_Vehicle_Transport). Object (boat rack) must have triggers set up with continuous actions. Object (boat rack) must have set of Z offset's predefined in cfgVehicles for know/supported boat types.\n\nParameters used from cfgVehicles configuration: cargoBayAnimationSelection         = \"CargoBay_Move_Z\"; supportedVehicleOffsetsZ[]        = {{\"C_Boat_Civil_01_F\",0.55}};","meta":{},"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This is sub function for 'boat recovery' functionality.\n\nExecution:\n- Call from Init EH script that is added to object (boat rack) or from action code.\n\nExample:\n    [_boatRack, _boat] call BIS_fnc_boatRack01AdjustZOffset;\n\nRequired:\n    Object (boat rack) must have vehicle in vehicle behavior configured (https://community.bistudio.com/wiki/Arma_3_Vehicle_in_Vehicle_Transport).\n    Object (boat rack) must have triggers set up with continuous actions.\n    Object (boat rack) must have set of Z offset's predefined in cfgVehicles for know/supported boat types.\n\n    Parameters used from cfgVehicles configuration:\n    cargoBayAnimationSelection         = \"CargoBay_Move_Z\";\n    supportedVehicleOffsetsZ[]        = {{\"C_Boat_Civil_01_F\",0.55}};\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: boat rack object\n    1: boat in cargo\n    and\n    other parameters from boat rack's cfgVehicles configuration.\n\nReturns: nothing\nResult: Adjusts the hight (Z offset) of boat rack suspension to prevent different boats clipping with visual mesh."},"filled_from_docblock":["description","params","returns","examples"]}