API: Functions

Index of API functions (128 entries)
A B C D F G H I P R S T U V
A `TFAR_fnc_activeLrRadio` `TFAR_fnc_activeSwRadio` `TFAR_fnc_addEventHandler`
B `TFAR_fnc_backpackLr`
C `TFAR_fnc_calcTerrainInterception` `TFAR_fnc_canSpeak` `TFAR_fnc_canUseDDRadio` `TFAR_fnc_canUseLRRadio` `TFAR_fnc_canUseSWRadio` `TFAR_fnc_copyRadioSettingMenu` `TFAR_fnc_CopySettings` `TFAR_fnc_currentDirection` `TFAR_fnc_currentUnit`
D `TFAR_fnc_defaultPositionCoordinates`
F `TFAR_fnc_fireEventHandlers` `TFAR_fnc_forceSpectator`
G `TFAR_fnc_generateDDFreq` `TFAR_fnc_generateFrequencies` `TFAR_fnc_generateLrSettings` `TFAR_fnc_generateSwSettings` `TFAR_fnc_getAdditionalLrChannel` `TFAR_fnc_getAdditionalLrStereo` `TFAR_fnc_getAdditionalSwChannel` `TFAR_fnc_getAdditionalSwStereo` `TFAR_fnc_getChannelFrequency` `TFAR_fnc_getConfigProperty` `TFAR_fnc_getCurrentLrStereo` `TFAR_fnc_getCurrentSwStereo` `TFAR_fnc_getDefaultRadioClasses` `TFAR_fnc_getLrChannel` `TFAR_fnc_getLrFrequency` `TFAR_fnc_getLrRadioCode` `TFAR_fnc_getLrRadioProperty` `TFAR_fnc_getLrSettings` `TFAR_fnc_getLrSpeakers` `TFAR_fnc_getLrStereo` `TFAR_fnc_getLrVolume` `TFAR_fnc_getRadioOwner` `TFAR_fnc_getSideRadio` `TFAR_fnc_getSwChannel` `TFAR_fnc_getSwFrequency` `TFAR_fnc_getSwRadioCode` `TFAR_fnc_getSwSettings` `TFAR_fnc_getSwSpeakers` `TFAR_fnc_getSwStereo` `TFAR_fnc_getSwVolume` `TFAR_fnc_getTeamSpeakChannelName` `TFAR_fnc_getTeamSpeakServerName` `TFAR_fnc_getTransmittingDistanceMultiplicator` `TFAR_fnc_getVehicleSide`
H `TFAR_fnc_hasVehicleRadio` `TFAR_fnc_haveDDRadio` `TFAR_fnc_haveLRRadio` `TFAR_fnc_haveSWRadio` `TFAR_fnc_HideHint`
I `TFAR_fnc_initialiseBaseModule` `TFAR_fnc_initialiseEnforceUsageModule` `TFAR_fnc_initialiseFreqModule` `TFAR_fnc_isForcedCurator` `TFAR_fnc_isPrototypeRadio` `TFAR_fnc_isRadio` `TFAR_fnc_isSameRadio` `TFAR_fnc_isSpeaking` `TFAR_fnc_isTeamSpeakPluginEnabled` `TFAR_fnc_isVehicleIsolated`
P `TFAR_fnc_preparePositionCoordinates` `TFAR_fnc_processGroupFrequencySettings` `TFAR_fnc_processLRChannelKeys` `TFAR_fnc_processLRCycleKeys` `TFAR_fnc_processLRStereoKeys` `TFAR_fnc_processPlayerPositions` `TFAR_fnc_processRespawn` `TFAR_fnc_processSWChannelKeys` `TFAR_fnc_processSWCycleKeys` `TFAR_fnc_processSWStereoKeys` `TFAR_fnc_ProcessTangent`
R `TFAR_fnc_radioReplaceProcess` `TFAR_fnc_radiosList` `TFAR_fnc_radiosListSorted` `TFAR_fnc_radioToRequestCount` `TFAR_fnc_removeEventHandler` `TFAR_fnc_requestRadios`
S `TFAR_fnc_sendFrequencyInfo` `TFAR_fnc_sendPlayerInfo` `TFAR_fnc_sendPlayerKilled` `TFAR_fnc_sendVersionInfo` `TFAR_fnc_ServerInit` `TFAR_fnc_sessionTracker` `TFAR_fnc_setActiveLrRadio` `TFAR_fnc_setActiveSwRadio` `TFAR_fnc_setAdditionalLrChannel` `TFAR_fnc_setAdditionalLrStereo` `TFAR_fnc_setAdditionalSwChannel` `TFAR_fnc_setAdditionalSwStereo` `TFAR_fnc_setChannelFrequency` `TFAR_fnc_setChannelViaDialog` `TFAR_fnc_setLongRangeRadioFrequency` `TFAR_fnc_setLrChannel` `TFAR_fnc_setLrFrequency` `TFAR_fnc_setLrRadioCode` `TFAR_fnc_setLrSettings` `TFAR_fnc_setLrSpeakers` `TFAR_fnc_setLrStereo` `TFAR_fnc_setLrVolume` `TFAR_fnc_setPersonalRadioFrequency` `TFAR_fnc_setRadioOwner` `TFAR_fnc_setSwChannel` `TFAR_fnc_setSwFrequency` `TFAR_fnc_setSwRadioCode` `TFAR_fnc_setSwSettings` `TFAR_fnc_setSwSpeakers` `TFAR_fnc_setSwStereo` `TFAR_fnc_setSwVolume` `TFAR_fnc_setVoiceVolume` `TFAR_fnc_setVolumeViaDialog` `TFAR_fnc_ShowHint` `TFAR_fnc_ShowRadioInfo` `TFAR_fnc_showRadioSpeakers` `TFAR_fnc_ShowRadioVolume` `TFAR_fnc_swRadioMenu` `TFAR_fnc_swRadioSubMenu`
T `TFAR_fnc_TaskForceArrowheadRadioInit`
U `TFAR_fnc_updateDDDialog` `TFAR_fnc_updateLRDialogToChannel` `TFAR_fnc_updateSWDialogToChannel`
V `TFAR_fnc_vehicleId` `TFAR_fnc_vehicleIsIsolatedAndInside` `TFAR_fnc_vehicleLr`

❗Please note, all functions are appended with a symbol that is not actually part of their names, and is meant only to denote authorship of each particular entry, the following way:

ɠ – Garth de Wet (L-H)

ɱ – Michail Nikolaev (NKey)

Alpha

TFAR_fnc_activeLrRadio ^ɱ
^{Returns the active LR radio.}
_Parameters Nothing	_Returns `ARRAY` – active LR radio.

Example

_radio = call TFAR_fnc_activeLRRadio;

TFAR_fnc_activeSwRadio ^ɱ
^{Returns the active SW radio.}
_Parameters Nothing	_Returns `STRING` – active SW radio.

Example

_radio = call TFAR_fnc_activeLRRadio;

TFAR_fnc_addEventHandler ^ɠ
^{Adds an eventhandler to the passed unit unless the unit is null then fires globally.}
_Parameters `STRING` – custom handler ID. `STRING` – event ID. `CODE` – code to execute when event is fired. `OBJECT` – unit to add the event to; `ObjNull` to add globally.	_Returns Nothing

Example

["MyID", "OnSpeak", {
_unit = _this select 0;
_volume = _this select 1;
hint format ["%1 is speaking %2", name _unit, _volume];
}, player] call TFAR_fnc_addEventHandler;

Bravo

TFAR_fnc_backpackLr ^ɱ
^{Returns the backpack radio (if there is one).}
_Parameters `OBJECT` – unit.	_Returns `ARRAY` – manpack or empty array.

Example

_radio = player call TFAR_fnc_backpackLR;

Charlie

TFAR_fnc_calcTerrainInterception ^ɱ
^{Calculates the terrain interference between the player and the passed unit.}
_Parameters `OBJECT` – unit to calculate terrain interference with.	_Returns `NUMBER` – terrain interference.

Example

_interception = soldier2 call TFAR_fnc_calcTerrainInterception;

TFAR_fnc_canSpeak ^ɱ
^{Tests whether it is possible to speak at the given eye height, and if the unit is within an isolated vehicle.}
_Parameters `BOOLEAN` – whether the unit is isolated and inside a vehicle. `NUMBER` – the eye depth.	_Returns `BOOLEAN` – whether it is possible to speak.

Example

_canSpeak = [false, -12] call TFAR_fnc_canSpeak;

TFAR_fnc_canUseDDRadio ^ɱ
^{Checks whether it is possible for the DD radio to be used at the current height and isolated status.}
_Parameters `NUMBER` – depth. `BOOLEAN` – isolated and inside.	_Returns `BOOLEAN`

Example

_canUseDD = [-12,true] call TFAR_fnc_canUseDDRadio;

TFAR_fnc_canUseLRRadio ^ɱ
^{Checks whether the LR radio would be able to be used at passed depth.}
_Parameters `OBJECT` – unit. `BOOLEAN` – isolated and inside. `BOOLEAN` – can speak. `NUMBER` – depth.	_Returns `BOOLEAN`

Example

_canUseSW = [player, false, false, 10] call TFAR_fnc_canUseLrRadio;

TFAR_fnc_canUseSWRadio ^ɱ
^{Checks whether the SW radio would be able to be used at passed depth.}
_Parameters `OBJECT` – unit. `BOOLEAN` – isolated and inside. `BOOLEAN` – can speak. `NUMBER` – depth.	_Returns `BOOLEAN`

Example

_canUseSW = [player, false, false, 10] call TFAR_fnc_canUseSwRadio;

TFAR_fnc_copyRadioSettingMenu ^ɱ
^{Returns a submenu for radio settings copying.}
_Parameters Nothing	_Returns `ARRAY` – CBA UI menu.

Example

Called internally by CBA UI

TFAR_fnc_CopySettings ^ɠ
^{Copies the settings from a radio to another.}
_Parameters `ARRAY` / `STRING` – source (SW / LR). `ARRAY` / `STRING` – target (SW / LR).	_Returns Nothing

Example

// LR - LR
[(call TFAR_fnc_activeLrRadio),[(vehicle player), "driver"]] call TFAR_fnc_CopySettings;
// SW - SW
[(call TFAR_fnc_activeSwRadio),"tf_anprc148jem_20"] call TFAR_fnc_CopySettings;

TFAR_fnc_currentDirection ^ɱ
^{Returns current facing diration of player.}
_Parameters Nothing	_Returns `NUMBER` – head direction azimuth.

Example

call TFAR_fnc_currentDirection;

TFAR_fnc_currentUnit ^ɱ
^{Return current player unit (player- or remote-controlled by Zeus).}
_Parameters Nothing	_Returns `OBJECT` – current unit.

Example

call TFAR_fnc_currentUnit;

Delta

TFAR_fnc_defaultPositionCoordinates ^ɱ
^{Prepares the position coordinates of the passed unit.}
_Parameters `OBJECT` – unit. `BOOLEAN` – is near player.	_Returns Nothing

Foxtrot

TFAR_fnc_fireEventHandlers ^ɠ
^{Fires all event handlers associated with the passed unit.}
_Parameters `STRING` – ID for event. `OBJECT` – unit to fire events on. `ANY` – parameters.	_Returns Nothing

Example

["OnSpeak", player, [player, TF_speak_volume_meters]] call TFAR_fnc_fireEventHandlers;

TFAR_fnc_forceSpectator ^ɠ
^{If the 2nd parameter is true – player is forced into spectator mode (at radio level); false – default behavior.}
_Parameters `ARRAY` – settings: 0.`OBJECT` – player. 1.`BOOLEAN` – force or not.	_Returns Nothing

Example

[player, true] call TFAR_fnc_forceSpectator;

Golf

TFAR_fnc_generateDDFreq ^ɱ
^{Generates frequency for diver radio.}

Example

call TFAR_fnc_generateDDFreq;

TFAR_fnc_generateFrequencies ^ɠɱ
^{Generates frequencies based on the passed parameters to be used in radio settings.}
_Parameters `NUMBER` – channels. `NUMBER` – MAX freq value. `NUMBER` – MIN freq value. `NUMBER` – frequency round power.	_Returns `ARRAY` – frequencies for channels.

Example

// LR
_frequencies = [TF_MAX_LR_CHANNELS,TF_MAX_ASIP_FREQ,TF_MIN_ASIP_FREQ,TF_FREQ_ROUND_POWER] call TFAR_fnc_generateFrequencies;
// SW
_sw_frequencies = [TF_MAX_CHANNELS,TF_MAX_SW_FREQ,TF_MIN_SW_FREQ,TF_FREQ_ROUND_POWER] call TFAR_fnc_generateFrequencies;

TFAR_fnc_generateLrSettings ^ɠɱ
^{Generates settings for the LR radio.}
_Parameters `BOOLEAN` – (optional) `false` to generate settings without generating frequencies.	_Returns `ARRAY` – settings: 0.`NUMBER` – active channel (CH). 1.`NUMBER` – volume. 2.`ARRAY` – CH freqs. 3.`NUMBER` – stereo (S) setting. 4.`STRING` – encryption code. 5.`NUMBER` – ADDL active CH. 6.`NUMBER` – ADDL active CH (S). 7.`NUMBER` – speaker mode.

Example

_settings = call TFAR_fnc_generateLrSettings;

TFAR_fnc_generateSwSettings ^ɠɱ
^{Generates settings for the SW radio.}
_Parameters `BOOLEAN` – (optional) `false` to generate settings without generating frequencies.	_Returns `ARRAY` – settings: 0.`NUMBER` – active channel (CH). 1.`NUMBER` – volume. 2.`ARRAY` – CH freqs. 3.`NUMBER` – stereo (S) setting. 4.`STRING` – encryption code. 5.`NUMBER` – ADDL active CH. 6.`NUMBER` – ADDL active CH (S). 7.`OBJECT` – owner. 8.`NUMBER` – speaker mode.

Example

_settings = call TFAR_fnc_generateSwSettings;

TFAR_fnc_getAdditionalLrChannel ^ɱ
^{Gets the additional channel for the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – channel.

Example

_channel = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getAdditionalLrChannel;

TFAR_fnc_getAdditionalLrStereo ^ɱ
^{Gets the stereo setting of additional channel of the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.

Example

_stereo = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getAdditionalLrStereo;

TFAR_fnc_getAdditionalSwChannel ^ɱ
^{Gets the additional channel for the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `NUMBER` – channel.

Example

_channel = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getAdditionalSwChannel;

TFAR_fnc_getAdditionalSwStereo ^ɱ
^{Gets the stereo setting of additional channel of the passed radio.}
_Parameters `ARRAY` – radio class name.	_Returns `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.

Example

_stereo = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getAdditionalSwStereo;

TFAR_fnc_getChannelFrequency ^ɠ
^{Returns the frequency for the passed channel and radio.}
_Parameters `OBJECT` / `STRING` – radio.	_Returns `STRING` – frequency.

Example

// LR radio - channel 1
[(call TFAR_fnc_activeLrRadio), 1] call TFAR_fnc_GetChannelFrequency;
// SW radio - channel 1
[(call TFAR_fnc_activeSwRadio), 1] call TFAR_fnc_GetChannelFrequency;

TFAR_fnc_getConfigProperty ^ɠɱ
^{Gets a config property – getNumber / getText. Only works for CfgVehicles.}
_Parameters `STRING` – item class name. `STRING` – property. `ANYTHING` – (optional) default.	_Returns `NUMBER` / `TEXT` – result.

Example

[_LRradio, "tf_hasLrRadio", 0] call TFAR_fnc_getConfigProperty;

TFAR_fnc_getCurrentLrStereo ^ɱ
^{Gets the stereo of current channel (special logic for additional) setting of the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.

Example

_stereo = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getCurrentLrStereo;

TFAR_fnc_getCurrentSwStereo ^ɱ
^{Gets the stereo setting of current channel (special logic for additional) the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.

Example

_stereo = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getCurrentSwStereo;

TFAR_fnc_getDefaultRadioClasses ^ɱ
^{Returns an array of default radio classes for player.}
_Parameters Nothing	_Returns `ARRAY` `defaultLR` `defaultPersonal` `defaultRifleman` `defaultAirborne`

Example

_classes = call TFAR_fnc_getDefaultRadioClasses;

TFAR_fnc_getLrChannel ^ɱ
^{Gets the channel for the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – channel.

Example

_channel = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getLrChannel;

TFAR_fnc_getLrFrequency ^ɠɱ
^{Gets the frequency for the active channel.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – frequency.

Example

_frequency = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getLrFrequency;

TFAR_fnc_getLrRadioCode ^ɠɱ
^{Returns the encryption code for the passed radio.}
_Parameters `OBJECT` – radio.	_Returns `STRING` – encryption code.

Example

(call TFAR_fnc_activeLrRadio) call TFAR_fnc_getLrRadioCode;

TFAR_fnc_getLrRadioProperty ^ɠ
_Parameters `OBJECT` – manpack/vehicle. `STRING` – property name.	_Returns `NUMBER` / `TEXT` – value of property.

Example

[(vehicle player), "TF_hasLRradio"] call TFAR_fnc_getLrRadioProperty;

TFAR_fnc_getLrSettings ^ɠɱ
^{Returns the current settings for the passed radio.}
_Parameters `OBJECT` – radio. `STRING` – radio qualifier.	_Returns `ARRAY` – settings.

Example

(call TFAR_fnc_activeLrRadio) call TFAR_fnc_getLrSettings;

TFAR_fnc_getLrSpeakers ^ɱ
^{Gets the speakers setting of the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `BOOLEAN` – speakers or headphones.

Example

_speakers = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getLrSpeakers;

TFAR_fnc_getLrStereo ^ɱ
^{Gets the stereo setting of the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.

Example

_stereo = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getLrStereo;

TFAR_fnc_getLrVolume ^ɱ
^{Gets the volume of the passed radio.}
_Parameters `ARRAY` – radio: 0.`OBJECT` – radio object. 1.`STRING` – radio ID.	_Returns `NUMBER` – volume; range: `0,10`.

Example

_volume = (call TFAR_fnc_ActiveLrRadio) call TFAR_fnc_getLrVolume;

TFAR_fnc_getRadioOwner ^ɠ
^{Gets the owner of a SW radio.}
_Parameters `STRING` – radio class name.	_Returns `STRING` – UID of owner of radio.

Example

_owner = (call TFAR_fnc_activeSwRadio) call TFAR_fnc_getRadioOwner;

TFAR_fnc_getSideRadio ^ɠ
^{Returns the default radio for the passed side.}
_Parameters `SIDE` – side. `NUMBER` – radio type: `0` – LR. `1` – SW. `2` – Rifleman.	_Returns `STRING` / `OBJECT` – default radio.

Example

_defaultLRRadio = [side player, 0] call TFAR_fnc_getSideRadio;
_defaultSWRadio = [side player, 1] call TFAR_fnc_getSideRadio;
_defaultRiflemanRadio = [side player, 2] call TFAR_fnc_getSideRadio;

TFAR_fnc_getSwChannel ^ɱ
^{Gets the channel for the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `NUMBER` – channel.

Example

_channel = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getSwChannel;

TFAR_fnc_getSwFrequency ^ɠɱ
^{Gets the frequency for the active channel.}
_Parameters `STRING` – radio class name.	_Returns `NUMBER` – frequency.

Example

_frequency = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getSwFrequency;

TFAR_fnc_getSwRadioCode ^ɠɱ
^{Returns the encryption code for the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `STRING` – encryption code.

Example

(call TFAR_fnc_activeSwRadio) call TFAR_fnc_getSwRadioCode;

TFAR_fnc_getSwSettings ^ɠɱ
^{Returns the current settings for the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `ARRAY` – settings.

Example

(call TFAR_fnc_activeSwRadio) call TFAR_fnc_getSwSettings;

TFAR_fnc_getSwSpeakers ^ɱ
^{Gets the speakers setting of the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `BOOLEAN` – speakers or headphones.

Example

_stereo = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getSwSpeakers;

TFAR_fnc_getSwStereo ^ɱ
^{Gets the stereo setting of the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.

Example

_stereo = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getSwStereo;

TFAR_fnc_getSwVolume ^ɱ
^{Gets the volume of the passed radio.}
_Parameters `STRING` – radio class name.	_Returns `NUMBER` – volume; range: `0,10`.

Example

_volume = (call TFAR_fnc_ActiveSwRadio) call TFAR_fnc_getSwVolume;

TFAR_fnc_getTeamSpeakChannelName ^ɱ
^{Returns TeamSpeak channel name.}
_Parameters Nothing	_Returns `STRING` – name of channel.

Example

call TFAR_fnc_getTeamSpeakChannelName;

TFAR_fnc_getTeamSpeakServerName ^ɱ
^{Returns TeamSpeak server name.}
_Parameters Nothing	_Returns `STRING` – name of server.

Example

call TFAR_fnc_getTeamSpeakServerName;

TFAR_fnc_getTransmittingDistanceMultiplicator ^ɱ
^{Returns multiplicator for sending distance of radio.}

Example

call TFAR_fnc_getTransmittingDistanceMultiplicator;

TFAR_fnc_getVehicleSide ^ɱ
^{Returns side of vehicle, based on its model and not who captured it; takes into account tf_side variable.}
_Parameters `OBJECT` – vehicle.	_Returns `SIDE` – side of vehicle.

Example

_vehicleSide = (vehicle player) call TFAR_fnc_getVehicleSide;

Hotel

TFAR_fnc_hasVehicleRadio ^ɱ
^{Checks _this for LR radio presence.}
_Parameters `OBJECT` – vehicle to check.	_Returns `BOOLEAN` – `true` / `false`.

Example

_present = (vehicle player) call TFAR_fnc_hasVehicleRadio;

TFAR_fnc_haveDDRadio ^ɱ
^{Checks whether the player has a DD radio.}
_Parameters Nothing	_Returns `BOOLEAN`

Example

_hasDD = call TFAR_fnc_haveDDRadio;

TFAR_fnc_haveLRRadio ^ɱ
^{Checks whether the player has a LR radio.}
_Parameters Nothing	_Returns `BOOLEAN`

Example

_hasLR = call TFAR_fnc_haveLRRadio;

TFAR_fnc_haveSWRadio ^ɱ
^{Checks whether the player has a SW radio.}
_Parameters Nothing	_Returns `BOOLEAN`

Example

_hasSW = call TFAR_fnc_haveSWRadio;

TFAR_fnc_HideHint ^ɠ
^{Removes the hint from the bottom right.}

Example

call TFAR_fnc_HideHint;

India

TFAR_fnc_initialiseBaseModule ^ɠ
^{Initialises variables based on module settings.}

TFAR_fnc_initialiseEnforceUsageModule ^ɠ
^{Initialises variables based on module settings.}

TFAR_fnc_initialiseFreqModule ^ɠ
^{Initialises variables based on module settings.}

TFAR_fnc_isForcedCurator ^ɱ
^{Checks whether certain unit is a forced curator.}
_Parameters `OBJECT` – unit to check.	_Returns `BOOLEAN` – is unit a forced curator.

Example

player call TFAR_fnc_isForcedCurator;

TFAR_fnc_isPrototypeRadio ^ɠ
^{Checks whether certain radio is a prototype radio.}
_Parameters `STRING` – radio class name.	_Returns `BOOLEAN` – `true` if prototype, `false` if actual radio.

Example

if ("tf_148jem" call TFAR_fnc_isPrototypeRadio) then {
hint "Prototype";
};

TFAR_fnc_isRadio ^ɠɱ
^{Checks whether the passed radio is a TFAR radio.}
_Parameters `STRING` – radio class name.	_Returns `BOOLEAN`

Example

_isRadio = "NotARadioClass" call TFAR_fnc_isRadio;

TFAR_fnc_isSameRadio ^ɠ
^{Checks whether the two passed radios have the same prototype radio.}
_Parameters `STRING` – radio class name. `STRING` – radio class name.	_Returns `BOOLEAN` – same parent radio.

Example

if([(call TFAR_fnc_activeSwRadio),"tf_fadak"] call TFAR_fnc_isSameRadio) then {
hint "same parent radio";
};

TFAR_fnc_isSpeaking ^ɠ
^{Check whether a unit is speaking.}
_Parameters `OBJECT` – unit.	_Returns `BOOLEAN` – if the unit is speaking.

Example

if (player call TFAR_fnc_isSpeaking) then {
hint "You are speaking";
};

TFAR_fnc_isTeamSpeakPluginEnabled ^ɱ
^{Checks whether TeamSpeak plugin is enabled on client.}
_Parameters Nothing	_Returns `BOOLEAN` – enabled or not.

Example

call TFAR_fnc_isTeamSpeakPluginEnabled;

TFAR_fnc_isVehicleIsolated ^ɱ
^{Checks whether the vehicle is isolated.}
_Parameters `OBJECT` – the vehicle.	_Returns `BOOLEAN`

Example

_isolated = (vehicle player) call TFAR_fnc_isVehicleIsolated;

Papa

TFAR_fnc_preparePositionCoordinates ^ɱ
^{Prepares the position coordinates of the passed unit.}
_Parameters `OBJECT` – unit. `BOOLEAN` – is near player. `STRING` – unit name.	_Returns `BOOLEAN`

TFAR_fnc_processGroupFrequencySettings ^ɱ
^{Sets frequency settings for groups.}

Example

call TFAR_fnc_processGroupFrequencySettings;

TFAR_fnc_processLRChannelKeys ^ɱ
^{Switches the active LR radio to the passed channel.}
_Parameters `NUMBER` – channel; range: `0,8`.	_Returns `BOOLEAN` – the event handled or not.

Example
Called by CBA.

TFAR_fnc_processLRCycleKeys ^ɱ
^{Allows rotating through the list of LR radios with keys.}
_Parameters `STRING` – direction to cycle; values: `next` / `prev`.	_Returns `BOOLEAN` – the event handled or not.

Example

Handled via "onKey" event handler of CBA.

TFAR_fnc_processLRStereoKeys ^ɱ
^{Switches the LR stereo setting on the active LR radio.}
_Parameters `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.	_Returns `BOOLEAN` – the event handled or not.

Example

Called via "onKey" event handler of CBA.

TFAR_fnc_processPlayerPositions ^ɱ
^{Processes positions of select players on each call and sends them to the plugin.}

Example

call TFAR_fnc_processPlayerPositions;

TFAR_fnc_processRespawn ^ɠɱ
^{Handles radio switching — whether a manpack must be added to the player or not.}

Example

call TFAR_fnc_processRespawn;

TFAR_fnc_processSWChannelKeys ^ɱ
^{Switches the active SW radio to the passed channel.}
_Parameters `NUMBER` – channel; range: `0,7`.	_Returns `BOOLEAN` – the event handled or not.

Example
Called by CBA.

TFAR_fnc_processSWCycleKeys ^ɱ
^{Allows rotating through the list of SW radios with keys.}
_Parameters `STRING` – direction to cycle; values: `next` / `prev`.	_Returns `BOOLEAN` – the event handled or not.

Example

Handled via "onKey" event handler of CBA.

TFAR_fnc_processSWStereoKeys ^ɱ
^{Switches the SW stereo setting on the active SW radio.}
_Parameters `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.	_Returns `BOOLEAN` – the event handled or not.

Example

Called via "onKey" event handler of CBA.

TFAR_fnc_ProcessTangent ^ɠɱ
^{Called when tangent is released.}
_Parameters `STRING` – hint text. `STRING` – request string. `NUMBER` – (optional) hint display time.	_Returns Nothing

Example

_hintText = format[localize "STR_transmit_end",format ["%1<img size='1.5' image='%2'/>",[_radio select 0, "displayName"] call TFAR_fnc_getLrRadioProperty, getText(configFile >> "CfgVehicles"
>> typeof (_radio select 0) >> "picture")],(_radio call TFAR_fnc_getLrChannel) + 1, call TFAR_fnc_currentLRFrequency];
_request = format["TANGENT_LR   RELEASED    %1%2    %3  %4", call TFAR_fnc_currentLRFrequency, (call TFAR_fnc_activeLrRadio) call TFAR_fnc_getLrRadioCode, ([_radio select 0, "tf_range"]
call TFAR_fnc_getLrRadioProperty) * (call TFAR_fnc_getTransmittingDistanceMultiplicator), [_radio select 0, "tf_subtype"] call TFAR_fnc_getLrRadioProperty];
[_hintText, _request] call TFAR_fnc_ProcessTangent;

Romeo

TFAR_fnc_radioReplaceProcess ^ɱ
^{Replaces player's radios if there are any prototype radios.}

Example

[] spawn TFAR_fnc_radioReplaceProcess;

TFAR_fnc_radiosList ^ɱ
^{List of all SW radios on current player.}
_Parameters `OBJECT` – unit.	_Returns `ARRAY` – list of player's SW radios.

Example

_radios = currentUnit call TFAR_fnc_radiosList;

TFAR_fnc_radiosListSorted ^ɱ
^{Sorts the SW radio list alphabetically.}
_Parameters `OBJECT` – unit.	_Returns `ARRAY` – radio list sorted.

Example

_radios = currentUnit call TFAR_fnc_radiosListSorted;

TFAR_fnc_radioToRequestCount ^ɠɱ
^{Searches through all the items assigned to and on the player and checks if it is a prototype radio, then creates an array of all the class names of the prototype radios and returns it.}
_Parameters `BOOLEAN` – regardless of whether the radio is prototype or not, return it as a radio to be replaced.	_Returns `ARRAY` – list of all radio classes to be replaced.

Example

_radios = false call TFAR_fnc_radioToRequestCount;

TFAR_fnc_removeEventHandler ^ɠ
^{Removes an event from unit / global.}
_Parameters `STRING` – custom handler ID. `STRING` – event ID. `OBJECT` – unit to add the event to; `ObjNull` to add globally.	_Returns Nothing.

Example

["MyID", "OnSpeak", player] call TFAR_fnc_removeEventHandler;

TFAR_fnc_requestRadios ^ɠɱ
^{Checks whether the player needs to have radios converted to "instanced" versions, handles waiting for response from server with radio class names and applying them to the player.}

Example

spawn TFAR_fnc_requestRadios;

Sierra

TFAR_fnc_sendFrequencyInfo ^ɱ
^{Notifies the plugin about the radios currently being used by the player and various settings active on the radio.}

Example

call TFAR_fnc_sendFrequencyInfo;

TFAR_fnc_sendPlayerInfo ^ɱ
^{Notifies the plugin about a player.}
_Parameters `OBJECT` – unit. `BOOLEAN` – is unit close to player. `STRING` – unit name.	_Returns Nothing.

Example

[player] call TFAR_fnc_sendPlayerInfo;

TFAR_fnc_sendPlayerKilled ^ɱ
^{Notifies the plugin that a unit has been killed.}
_Parameters `OBJECT` – unit that was killed.	_Returns Nothing.

Example

player call TFAR_fnc_sendPlayerKilled;

TFAR_fnc_sendVersionInfo ^ɱ
^{Sends information about the current TFAR version.}

Example

call TFAR_fnc_sendVersionInfo;

TFAR_fnc_ServerInit ^ɠɱ
^{Initialises the server and the server loop.}

Example

call TFAR_fnc_serverInit;

TFAR_fnc_sessionTracker ^ɱ
^{Collects statistical information to help make TFAR better.}

Example

call TFAR_fnc_sessionTracker

TFAR_fnc_setActiveLrRadio ^ɱ
^{Sets the active LR radio to the passed radio.}
_Parameters `ARRAY` – settings: 0.`OBJECT` – radio. 1.`BOOLEAN` – radio ID.	_Returns Nothing

Example

TF_lr_dialog_radio call TFAR_fnc_setActiveLrRadio;

TFAR_fnc_setActiveSwRadio ^ɱ
^{Sets the active SW radio.}
_Parameters `STRING` – radio ID.	_Returns Nothing

Example

"tf_anprc148jem_1" call TFAR_fnc_setActiveSwRadio;

TFAR_fnc_setAdditionalLrChannel ^ɱ
^{Sets the radio to the passed channel or disables it (if current additional is passed).}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – channel; range: `0,8`.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, 4] call TFAR_fnc_setAdditionalLrChannel;

TFAR_fnc_setAdditionalLrStereo ^ɱ
^{Sets the stereo setting for additional channel the passed radio.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, 1] call TFAR_fnc_setAdditionalLrStereo;

TFAR_fnc_setAdditionalSwChannel ^ɱ
^{Sets the additional channel for the passed radio or disables it (if additional channel in arguments).}
_Parameters `STRING` – radio class name. `NUMBER` – channel.	_Returns Nothing

Example

[(call TFAR_fnc_activeSwRadio), 2] call TFAR_fnc_setAdditionalSwChannel;

TFAR_fnc_setAdditionalSwStereo ^ɱ
^{Sets the stereo setting for additional channel of the SW radio.}
_Parameters `STRING` – radio. `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.	_Returns Nothing

Example

[(call TFAR_fnc_ActiveSWRadio), 2] call TFAR_fnc_setAdditionalSwStereo;

TFAR_fnc_setChannelFrequency ^ɠ
^{Sets the frequency for the channel on the passed radio.}
_Parameters `OBJECT` / `STRING` – radio. `NUMBER` – channel. `STRING` – frequency.	_Returns Nothing

Example

// LR radio - channel 1
[(call TFAR_fnc_activeLrRadio), 1, "56.2"] call TFAR_fnc_SetChannelFrequency;
// SW radio - channel 1
[(call TFAR_fnc_activeSwRadio), 1, "84.3"] call TFAR_fnc_SetChannelFrequency;

TFAR_fnc_setChannelViaDialog ^ɠ
^{Sets the channel of the current dialog radio.}
_Parameters `NUMBER` – mouse button pressed; range: `0,1`. `BOOLEAN` – LR radio. `STRING` – (optional) update formatting.	_Returns Nothing

Example

// LR radio
[_this select 1, true] call TFAR_fnc_setChannelViaDialog;
// SW radio
[_this select 1, false] call TFAR_fnc_setChannelViaDialog;

TFAR_fnc_setLongRangeRadioFrequency ^ɱ
^{Sets the frequency for the active channel on the active LR radio.}
_Parameters `STRING` – frequency.	_Returns Nothing

Example

"45.48" call TFAR_fnc_setLongRangeRadioFrequency;

TFAR_fnc_setLrChannel ^ɱ
^{Sets the radio to the passed channel.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – channel; range: `0,8`.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, 4] call TFAR_fnc_setLrChannel;

TFAR_fnc_setLrFrequency ^ɱ
^{Sets the frequency for the active channel.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – frequency.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, "45.48"] call TFAR_fnc_setLrFrequency;

TFAR_fnc_setLrRadioCode ^ɠ
^{Allows setting of the encryption code for individual radios.}

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, "NewEncryptionCode"] call TFAR_fnc_setLrRadioCode;

TFAR_fnc_setLrSettings ^ɠɱ
^{Saves the settings for the passed radio and broadcasts it to all clients and the server.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `ARRAY` – settings, usually acquired via `TFAR_fnc_getLrSettings` and then changed.	_Returns Nothing

Example

_settings = (call TFAR_fnc_activeLrRadio) call TFAR_fnc_getSwSettings;
_settings set [0, 2]; // sets the active channel to 2
[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, _settings] call TFAR_fnc_setLrSettings;

TFAR_fnc_setLrSpeakers ^ɱ
^{Configures the setting of speakers for the passed radio.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1] call TFAR_fnc_setLrSpeakers;

TFAR_fnc_setLrStereo ^ɱ
^{Sets the stereo setting for the passed radio.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, 1] call TFAR_fnc_setLrStereo;

TFAR_fnc_setLrVolume ^ɱ
^{Sets the volume for the passed radio.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – volume; range: `0,10`.	_Returns Nothing

Example

[(call TFAR_fnc_activeLrRadio) select 0, (call TFAR_fnc_activeLrRadio) select 1, 5] call TFAR_fnc_setLrVolume;

TFAR_fnc_setPersonalRadioFrequency ^ɱ
^{Sets the frequency for the active SW radio to passed frequency.}
_Parameters `STRING` – frequency.	_Returns Nothing

Example

"65.12" call TFAR_fnc_setPersonalRadioFrequency;

TFAR_fnc_setRadioOwner ^ɠ
^{Sets the owner of a SW radio.}
_Parameters `STRING` – radio class name. `STRING` – owner UID. `BOOLEAN` – local only.	_Returns Nothing

Example

[(call TFAR_fnc_activeSwRadio),player] call TFAR_fnc_setRadioOwner;

TFAR_fnc_setSwChannel ^ɠ
^{Sets the channel for the passed radio.}
_Parameters `STRING` – radio class name. `NUMBER` – channel.	_Returns Nothing

Example

[(call TFAR_fnc_activeSwRadio), 2] call TFAR_fnc_setSwChannel;

TFAR_fnc_setSwFrequency ^ɠɱ
^{Sets the frequency for the currently active channel.}
_Parameters `STRING` – radio class name. `STRING` – frequency.	_Returns Nothing

Example

[(call TFAR_fnc_activeSwRadio), "76.2"] call TFAR_fnc_setSwFrequency;

TFAR_fnc_setSwRadioCode ^ɠ
^{Allows setting of the encryption code for individual radios.}
_Parameters `STRING` – radio class name. `STRING` – encryption code.	_Returns Nothing

Example

[call TFAR_fnc_activeSwRadio, "NewEncryptionCode"] call TFAR_fnc_setSwRadioCode;

TFAR_fnc_setSwSettings ^ɱ
^{Saves the settings for the passed radio and broadcasts it to all clients and the server.}
_Parameters `STRING` – radio class name. `ARRAY` – settings; usually acquired via `TFAR_fnc_getSwSettings` and then changed. `BOOLEAN` – set local only.	_Returns Nothing

Example

_settings = (call TFAR_fnc_activeSwRadio) call TFAR_fnc_getSwSettings;
_settings set [0, 2]; // sets the active channel to 2
[(call TFAR_fnc_activeSwRadio), _settings] call TFAR_fnc_setSwSettings;

TFAR_fnc_setSwSpeakers ^ɱ
^{Sets the speakers setting for the SW radio.}
_Parameters `STRING` – radio.	_Returns Nothing

Example

[call TFAR_fnc_ActiveSWRadio] call TFAR_fnc_setSwSpeakers;

TFAR_fnc_setSwStereo ^ɱ
^{Sets the stereo setting for the SW radio.}
_Parameters `OBJECT` – radio object. `STRING` – radio ID. `NUMBER` – stereo settings: `0` – both. `1` – left. `2` – right.	_Returns Nothing

Example

[(call TFAR_fnc_ActiveSWRadio), 2] call TFAR_fnc_setSwStereo;

TFAR_fnc_setSwVolume ^ɱ
^{Sets the volume for the SW radio.}
_Parameters `STRING` – radio. `NUMBER` – volume; range: `0,10`.	_Returns Nothing

Example

[(call TFAR_fnc_ActiveSWRadio), 10] call TFAR_fnc_setSwVolume;

TFAR_fnc_setVoiceVolume ^ɱ
^{Sets the volume for the player's voice in game.}
_Parameters `NUMBER` – volume; range: `0,TF_max_voice_volume`.	_Returns Nothing

Example

30 call TFAR_fnc_setVoiceVolume;

TFAR_fnc_setVolumeViaDialog ^ɠ
^{Sets the volume of the current dialog radio.}
_Parameters `NUMBER` – mouse button pressed; range: `0,1`. `BOOLEAN` – LR radio.	_Returns Nothing

Example

// LR radio
[_this select 1, true] call TFAR_fnc_setVolumeViaDialog;
// SW radio
[_this select 1, false] call TFAR_fnc_setVolumeViaDialog;

TFAR_fnc_ShowHint ^ɠ
^{Displays a hint at the bottom right of the screen.}
_Parameters `STRING` – text to display. `NUMBER` – time to display; `-1` for infinite.	_Returns Nothing

Example

["Hello", 3] call TFAR_fnc_ShowHint;
["Hello", -1] call TFAR_fnc_ShowHint;

TFAR_fnc_ShowRadioInfo ^ɠ
^{Displays a hint at the bottom right of the screen.}
_Parameters `OBJECT` / `STRING` – radio. `BOOLEAN` – is LR radio.	_Returns Nothing

Example

// LR radio
[(call TFAR_fnc_activeLrRadio), true] call TFAR_fnc_ShowRadioInfo;
// SW radio
[(call TFAR_fnc_activeSwRadio), false] call TFAR_fnc_ShowRadioInfo;

TFAR_fnc_showRadioSpeakers ^ɠɱ
_Parameters `OBJECT` / `STRING` – radio. `BOOLEAN` – (optional) DD radio.	_Returns Nothing

Example

// LR radio
[(call TFAR_fnc_activeLrRadio)] call TFAR_fnc_ShowRadioSpeakers;
// SW radio
[(call TFAR_fnc_activeSwRadio)] call TFAR_fnc_ShowRadioSpeakers;
// DD radio
["", true] call TFAR_fnc_ShowRadioSpeakers;

TFAR_fnc_ShowRadioVolume ^ɠ
_Parameters `OBJECT` / `STRING` – radio. `BOOLEAN` – (optional) DD radio.	_Returns Nothing

Example

// LR radio
[(call TFAR_fnc_activeLrRadio)] call TFAR_fnc_ShowRadioVolume;
// SW radio
[(call TFAR_fnc_activeSwRadio)] call TFAR_fnc_ShowRadioVolume;
// DD radio
["", true] call TFAR_fnc_ShowRadioVolume;

TFAR_fnc_swRadioMenu ^ɠɱ
^{Returns a list of SW radios if more than one is on the player.}
_Parameters Nothing	_Returns `ARRAY`

Example

Called internally by CBA UI

TFAR_fnc_swRadioSubMenu ^ɠɱ
^{Returns a sub menu for a particular radio.}
_Parameters Nothing	_Returns `ARRAY` – CBA UI menu.

Example

Called internally by CBA UI

Tango

TFAR_fnc_TaskForceArrowheadRadioInit ^ɠɱ
^{Initialises TFAR, server and client.}

Example

Called by Arma via functions library.

Uniform

TFAR_fnc_updateDDDialog ^ɱ
^{Updates the DD dialog to the channel and depth if switched.}

Example

call TFAR_fnc_updateDDDialog;

TFAR_fnc_updateLRDialogToChannel ^ɠɱ
^{Updates the LR dialog to the channel if switched.}
_Parameters `STRING` – (optional) format to display channel with; requires `%1`.	_Returns Nothing

Example

// No custom format.
call TFAR_fnc_updateLRDialogToChannel;
// Custom format
["CH: %1"] call TFAR_fnc_updateLRDialogToChannel;

TFAR_fnc_updateSWDialogToChannel ^ɠɱ
^{Updates the SW dialog to the channel if switched.}
_Parameters `STRING` – (optional) format to display channel with; requires `%1`.	_Returns Nothing

Example

// No custom format.
call TFAR_fnc_updateSWDialogToChannel;
// Custom format
["CH: %1"] call TFAR_fnc_updateSWDialogToChannel;

Victor

TFAR_fnc_vehicleId ^ɱ
^{Returns a string with information about the player vehicle, used at the plugin side.}
_Parameters `OBJECT` – the unit to check.	_Returns `STRING` – NetworkID, turned out.

Example

_vehicleID = player call TFAR_fnc_vehicleID;

TFAR_fnc_vehicleIsIsolatedAndInside ^ɱ
^{Checks whether a unit is in an isolated vehicle and not turned out.}
_Parameters `OBJECT` – the unit to check.	_Returns `BOOLEAN` – `true` if isolated and not turned out, `false` if turned out or vehicle is not isolated.

Example

_isolated = player call TFAR_fnc_vehicleIsIsolatedAndInside;

TFAR_fnc_vehicleLr ^ɱ
^{Gets the LR radio of the vehicle and the settings for it depending on the player's position within the vehicle.}
_Parameters `OBJECT` – unit.	_Returns `ARRAY` 0.`OBJECT` – vehicle. 1.`STRING` – radio settings ID.

Example

_radio = player call TFAR_fnc_VehicleLR;

🔰 TFAR Вики / Wiki #####По-русски

README
API

#####In English

README
API
- Variables
- Classes
- Functions
- Events
- For developers

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API: Functions

Alpha

Bravo

Charlie

Delta

Foxtrot

Golf

Hotel

India

Papa

Romeo

Sierra

Tango

Uniform

Victor

Clone this wiki locally