BIS_fnc_boatRack01Init

Description

Main function of the boat recovery system, which lets a player drive a boat onto a boat rack and load it with a hold action. The boat rack must support Vehicle in Vehicle transport. The function is called by the init event handler of the boat rack's class. It does nothing in the Eden Editor or when the boat rack is objNull.

It reads these entries of the rack's CfgVehicles >> class >> BoatRecoverySystem config class:

• triggerAreaSizeX, triggerAreaSizeY, triggerAreaSizeZ - size of the area around each recovery point in which the boat must be
• every subclass is a recovery point; its memoryPointPosLoad is the name of the rack's memory point at the centre of that area

It then creates a local, repeatedly activated trigger ("ANYPLAYER", "PRESENT") around the rack, large enough to cover all recovery areas, and stores the rack on it in the variable "BIS_linkedBoatRack". The trigger uses:

• BIS_fnc_boatRack01ActionCondition as condition: the player drives a boat under 25 km/h inside a recovery area, the rack is empty and can carry the boat
• BIS_fnc_boatRack01ActionAdd on activation, which gives the boat the "Recover Boat" hold action
• BIS_fnc_boatRack01ActionRemove on deactivation

Finally it spawns BIS_fnc_boatRack01InitAdjustZOffsets to adjust the rack to a boat that is already loaded at mission start.

Syntax

[boatRack] call BIS_fnc_boatRack01Init

Parameters:

• boatRack: Object - the boat rack (the init event handler passes it as _this)

Returns: Script Handle - handle of the spawned BIS_fnc_boatRack01InitAdjustZOffsets; Nothing in the Eden Editor or if the boat rack is objNull

Examples

Example 1

Event handler of the boat rack's class:

class EventHandlers
{
    init = "_this call BIS_fnc_BoatRack01Init;";
};

See also

BIS_fnc_boatRack01ActionAdd · BIS_fnc_boatRack01ActionRemove · BIS_fnc_boatRack01AdjustZOffset · BIS_fnc_boatRack01InitAdjustZOffsets · Arma 3: Vehicle in Vehicle Transport