Arma 3 Scripting

Function in Boat Recovery

BIS_fnc_boatRack01InitAdjustZOffsets

Also available as Markdown and JSON, or read the original wiki page.

Description

Syntax

[] call BIS_fnc_boatRack01InitAdjustZOffsets

Parameters:

Returns: nothing On mission startup adjusts the hight (Z offset) of boat rack suspension to prevent different boats clipping with visual mesh.

Examples

Example 1

[_boatRack] spawn BIS_fnc_boatRack01InitAdjustZOffsets;

Function header

The comment at the top of the function's file in the game; this page's description, params, returns, examples come from it.

/*
Author: Bravo Zero One development
- John_Spartan

Description:
- This is sub function for 'boat recovery' functionality.

Execution:
- Call from Init EH script that is added to object (boat rack).

Example:
    [_boatRack] spawn BIS_fnc_boatRack01InitAdjustZOffsets;

Required:
    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.

    Parameters used from cfgVehicles configuration:
    cargoBayAnimationSelection         = "CargoBay_Move_Z";
    supportedVehicleOffsetsZ[]        = {{"C_Boat_Civil_01_F",0.55}};

Parameter(s):
    _this select 0: mode (Scalar)
    0: boat rack object
    and
    other parameters from boat rack's cfgVehicles configuration.

Returns: nothing
Result: On mission startup adjusts the hight (Z offset) of boat rack suspension to prevent different boats clipping with visual mesh.
*/