API: Events

Use the following calls:

• TFAR_fnc_AddEventHandler – to add an event handler
• TFAR_fnc_removeEventHandler – to remove it.

Examples

[MyID, EventName, Code, Object] call TFAR_fnc_addEventHandler;
// binding to the player object:
["MyID", "OnSpeak", {
hint format ["%1 %2 speaking", _this select 0, if(_this select 1)then{"is"}else{"isn't"}];
}, Player] call TFAR_fnc_addEventHandler;
// binding to the mission namespace and not the player object in particular:
["MyID", "OnSpeak", {
hint format ["%1 %2 speaking", _this select 0, if(_this select 1)then{"is"}else{"isn't"}];
}, ObjNull] call TFAR_fnc_addEventHandler;
// removing event handler that was bound to the player:
["MyID", "OnSpeak", player] call TFAR_fnc_removeEventHandler
// removing event handler that was bound to the mission namespace:
["MyID", "OnSpeak", objNull] call TFAR_fnc_removeEventHandler

Current list of all available events within TFAR

Event	Parameters
OnSpeak Whenever the local player is detected as speaking by TFAR.	OBJECT – unit. BOOLEAN – is speaking.
OnTangent When the local player uses a radio.	OBJECT – unit. STRING / ARRAY – former if SW radio class, latter if LR. NUMBER – 0 for SW, 1 for LR, 2 for underwater transceiver. BOOLEAN – additional channel key. BOOLEAN – button down.
OnBeforeTangent Before the local player uses a radio.	OBJECT – unit. STRING / ARRAY – former if SW radio class, latter if LR. NUMBER – 0 for SW, 1 for LR, 2 for underwater transceiver. BOOLEAN – additional channel key. BOOLEAN – button down.
OnSpeakVolume When the local player changes their speaking volume.	OBJECT – unit. NUMBER – speaking distance in meters.
OnRadiosReceived When the local player receives new radios.	OBJECT – unit. ARRAY – all of the radios received by this unit.
OnRadioOwnerSet When the local player gets assigned as SW radio owner.	OBJECT – unit. STRING – ID of SW radio.
OnLRChange When the local player switches their LR radio.	OBJECT – unit. ARRAY – new LR radio. ARRAY – old LR radio.
OnSWChange When the local player switches their SW radio.	OBJECT – unit. STRING – new SW radio. STRING – old SW radio.
OnLRchannelSet When the local player changes the LR channel.	OBJECT – unit. OBJECT – LR radio object. STRING – LR radio qualifier. NUMBER – channel. BOOLEAN – additional channel.
OnSWchannelSet When the local player changes the SW channel.	OBJECT – unit. STRING – SW radio. NUMBER – channel. BOOLEAN – additional channel.
OnLRstereoSet When the local player changes the LR stereo setting.	OBJECT – unit. OBJECT – LR radio object. STRING – LR radio qualifier. NUMBER – stereo setting. BOOLEAN – additional channel.
OnSWstereoSet When the local player changes the SW stereo setting.	OBJECT – unit. STRING – SW radio. NUMBER – stereo setting. BOOLEAN – additional channel.
OnLRvolumeSet When the local player sets the radio volume for LR radio.	OBJECT – unit. OBJECT – LR radio. STRING – radio qualifier. NUMBER – volume.
OnSWvolumeSet When the local player sets the radio volume for SW radio.	OBJECT – unit. STRING – SW radio. NUMBER – volume.