addPublicVariableEventHandler

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Armed Assault version 1.09
  Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.09

Description

Description:
This event handler will detect if a missionNamespace variable (it is attached to) has been broadcast over network with publicVariable, publicVariableClient or publicVariableServer commands and will execute EH code upon detection. Arguments passed to the code in _this array are:

_this select 0: String - broadcast variable name (same variable name EH is attached to)
_this select 1: Anything - broadcast variable value
_this select 2: Object, Group - target the variable got set on with setVariable (see: alternative syntax)

Please note:
* EH works only in Multiplayer environment.
* EH will not fire on the machine that executed broadcast command, only on the machines that receive the broadcast.
* The value of broadcast variable can be exactly the same, it is the actual broadcast that triggers EH not the change in variable.
warning.png Alt syntax of this command doesn't work as intended

Syntax

Syntax:
varName addPublicVariableEventHandler code
Parameters:
varName: String - missionNamespace variable name
code: Code - By default, the code is executed in missionNamespace
Return Value:
Nothing

Alternative Syntax

Syntax:
varName addPublicVariableEventHandler [target, code] (since A3 1.46)
Parameters:
varName: String - name of the variable set on target with setVariable
[target, code]: Array
target: Object, Group or Team Member
code: Code
Return Value:
Nothing

Examples

Example 1:
"publicThis" addPublicVariableEventHandler { hint format [ "%1 has been updated to: %2", _this select 0, _this select 1 ] };
Example 2:
Client:"'^:)123BURP,+=lol" addPublicVariableEventHandler {hint ("NUTS are " + (_this select 1))}; Server:missionNamespace setVariable ["'^:)123BURP,+=lol", "craZZZZy"]; publicVariable "'^:)123BURP,+=lol";

Additional Information

Multiplayer:
-
See also:
publicVariablepublicVariableClientpublicVariableServer

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on 22 Dec, 2007
TeRp
Please note that varName indicates which variable you want to monitor with this eventhandler.
As a result, the example eventhandler on this page will only fire when the variable publicThis has been changed, but not if any other variable was changed by any other client via the publicVariable command.
Posted on 27 Feb, 2014 00:57
MulleDK13
Note on using addPublicVariableEventHandler during initialization: If you need a function to call addPublicVariableEventHandler during initialization, you must use postInit. addPublicVariableEventHandler does not work during preInit.
Posted on 27 Feb, 2014 08:40
Killzone_Kid
MulleDK13 note above needs some clarification. You don't "must" use postInit and you absolutely can use preInit function to initialise addPublicVariableEventHandler if you start scheduled script from it.
//script with preInit = 1; in CfgFunctions 0 = 0 spawn { "someVar" addPublicVariableEventHandler { //yourcode }; };

Bottom Section

Posted on November 23, 2015 - 21:36 (UTC)
SilentSpike
While it is true that the event handler will only fire on the machine receiving the broadcast value. Please note that this machine can actually be the same machine broadcasting it in the cases of publicVariableClient and publicVariableServer. Examples: if (isServer) then { "OnServer" addPublicVariableEventHandler { hint "This event handler still fired!"; }; publicVariableServer "OnServer"; }; // This example assumes the client knows their own client ID // It does also work on the server (when the server ID is used) irrespective of the command name "OnClient" addPublicVariableEventHandler { hint "This event handler still fired!"; }; <client ID> publicVariableClient "OnClient";