Arma 3 Scripting

Function in IDWMap

BIN_fnc_setIDWMapParams

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

Description

Resets extension data, sets IDWMap params from argument, from config or default *** This function must be called before any data is added to the IDWMap ***

Note

This content is exclusive to the Arma 3 Contact Expansion.

Syntax

syntax inferred from the function header

[param0, param1, param2, param3, param4, param5] call BIN_fnc_setIDWMapParams

Parameters:

Returns: BOOL - true on success

Examples

Example 1

call BIN_fnc_setIDWMapParams

Function header

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

/*
    Killzone_Kid

Description:
    Resets extension data, sets IDWMap params from argument, from config or default
    *** This function must be called before any data is added to the IDWMap ***

Parameter(s):
    0: ARRAY - (Optional) areaParams in format:
        0: NUMBER - minMapX
        1: NUMBER - minMapY
        2: NUMBER - maxMapX
        3: NUMBER - maxMapY
        Default: [0, 0, worldSize, worldSize]
    1: NUMBER (Optional) - idwCellSize. Default: 20
    2: NUMBER (Optional) - idwSpreadRadius. Default: 200
    3: NUMBER (Optional) - idwSpreadPower. Default: 2.0
    4: NUMBER (Optional) - curvePointsInterval. Default: 20
    5: NUMBER (Optional) - curvePointSpreadRadius. Default: idwSpreadRadius

Returns:
    BOOL - true on success

Example:
    call BIN_fnc_setIDWMapParams
*/