Arma 3 Scripting

Function in TXScan

BIN_fnc_createTXScan

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

Description

Creates a scan with the name defined as class in CfgTXScans or from given params. If name doesn't exists in config and params are not provided, default scan is created which could be tweaked later

Note

This content is exclusive to the Arma 3 Contact Expansion.

Syntax

syntax inferred from the function header

[param0, param0, param1, param2, param3, param4] call BIN_fnc_createTXScan

Parameters:

Returns: BOOL - false on error

Examples

Example 1

"MyScan" call BIN_fnc_createTXScan
"" call BIN_fnc_createTXScan - creates every scan from config
["MyScan", [1,2,3], 20, 0.1] call BIN_fnc_createTXScan - creates every scan from config

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:
    Creates a scan with the name defined as class in CfgTXScans or from given params.
    If name doesn't exists in config and params are not provided, default scan is created which could be tweaked later

Parameter(s):
    0: STRING - "" create every scan from config
    or
    0: STRING - scan name
    1: ARRAY (Optional) - TX position
    2: NUMBER (Optional) - scan angle
    3: NUMBER (Optional) - scan precision
    4: ARRAY (Optional) - scan polygon

Returns:
    BOOL - false on error

Examples:
    "MyScan" call BIN_fnc_createTXScan
    "" call BIN_fnc_createTXScan - creates every scan from config
    ["MyScan", [1,2,3], 20, 0.1] call BIN_fnc_createTXScan - creates every scan from config
*/