Arma 3 Scripting

Function in IDWMap

BIN_fnc_setIDWMapDrawPatternIndex

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

Description

Sets map draw pattern

Note

This content is exclusive to the Arma 3 Contact Expansion.

Syntax

syntax inferred from the function header

arg call BIN_fnc_setIDWMapDrawPatternIndex

Parameters:

Returns: BOOL - true on success

Examples

Example 1

// set on the fly
3 call BIN_fnc_setIDWMapDrawPatternIndex; OR [3] call BIN_fnc_setIDWMapDrawPatternIndex;
// set from config
call BIN_fnc_setIDWMapDrawPatternIndex; OR [] call BIN_fnc_setIDWMapDrawPatternIndex;

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:
    Sets map draw pattern

Parameter(s):
    NUMBER - pattern: 0 - triangles, 1 - diamonds, 2 - squares, 3 - diamonds overlapped

Returns:
    BOOL - true on success

Example:
    // set on the fly
    3 call BIN_fnc_setIDWMapDrawPatternIndex; OR [3] call BIN_fnc_setIDWMapDrawPatternIndex;
    // set from config
    call BIN_fnc_setIDWMapDrawPatternIndex; OR [] call BIN_fnc_setIDWMapDrawPatternIndex;
*/