Arma 3 Scripting

Function in Destroyer

BIS_fnc_destroyer01GetShipPart

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

Description

Syntax

[] call BIS_fnc_destroyer01GetShipPart

Parameters:

Returns: object (ship part that matches selected class name) n/a

Examples

Example 1

[_this, 'Land_Destroyer_01_hull_05_F'] call BIS_fnc_destroyer01GetShipPart;

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 a helper function to get ship components (objects) by class name from stored array in ships master component's name-space ("BIS_CarrierParts" array).

Execution:
- Call from script or config.

    Example:
    [_this, 'Land_Destroyer_01_hull_05_F'] call BIS_fnc_destroyer01GetShipPart;

Requirements:
- Ships master object must be present. Ships master object must have initialized the array of sub components.

Parameter(s):
    _this select 0: mode (Scalar)
    0: ship Base/object
    1: ship part class name to find

Returns: object (ship part that matches selected class name)
Result: n/a
*/