publicVariableClient: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(New command missing from the wiki.)
 
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(73 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2oa |= Game name
|game1= arma2oa
|version1= 1.62


|1.62|= Game version
|game2= tkoh
____________________________________________________________________________________________
|version2= 1.00


| Send the variable value to the client computer.  Only type [[Number]] is supported in version 1.33 and before.  The following types are supported since 1.34:  [[Number]], [[Boolean]], [[Object]] and [[Group]].  
|game3= arma3
|version3= 0.50


The Client ID is the temporary ID given to a connected client for that session. You can find out this ID with the [[owner]] command (using it on a player's character, for example, will give you that players client ID). |= Description 
|gr1= Multiplayer


____________________________________________________________________________________________
|gr2= Variables


| clientID '''publicVariableClient''' varName |= Syntax
|descr= Send the variable value to the client computer - same limitations regarding variable type as [[publicVariable#Description|publicVariable]].


|p1= clientID: [[Number]] |= Parameter 1
The Client ID is the temporary ID given to a connected client for that session. You can find out this ID with the [[owner]] command (using it on a player's character, for example, will give you that players client ID).<br><br>


|p2= varName: [[String]] |= Parameter 2
{{Feature|arma3|In Arma 3 it is possible to broadcast [[nil]] value}}


| [[Nothing]] |= Return value
|s1= clientID [[publicVariableClient]] varName
____________________________________________________________________________________________
 
|x1= <code>3 '''publicVariableClient''' "CTFscoreOne";</code> |= Example 1
____________________________________________________________________________________________


| [[publicVariable]], [[publicVariableServer]] |= See also
|p1= clientID: [[Number]]


|p2= varName: [[String]]
|r1= [[Nothing]]
|x1= <sqf>3 publicVariableClient "CTFscoreOne";</sqf>
|seealso= [[clientOwner]] [[owner]] [[publicVariable]] [[publicVariableServer]] [[addPublicVariableEventHandler]] [[remoteExecutedOwner]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<dt><dt>
<dd class="notedate">Posted on 24 Aug, 2012</dd>
<dt class="note">[[User:Kylania|Kylania]]</dt>
<dd class="note">
publicVariableServer (run on client)<BR>
publicVariableServer (run on client)<BR>
publicVariableClient (run on server)<BR>
publicVariableClient (run on server)<BR>
Line 38: Line 44:
Publishes a variable (name as STRING) to a specific client, from the server. This is useful where you want to synchronize a variable with only a specific client.<BR>
Publishes a variable (name as STRING) to a specific client, from the server. This is useful where you want to synchronize a variable with only a specific client.<BR>


This is a useful way to cut down on network traffic, as publicVariable commands are issued as a priority message. So use publicVariable sparingly, and these commands where they apply. - [http://forums.bistudio.com/showthread.php?136494-ARMA-2-OA-beta-build-94209-(1-60-MP-compatible-build-post-1-60-release)&p=2179795&viewfull=1#post2179795 Rocket]
This is a useful way to cut down on network traffic, as publicVariable commands are issued as a priority message. So use publicVariable sparingly, and these commands where they apply. - {{Link|link= http://forums.bistudio.com/showthread.php?136494-ARMA-2-OA-beta-build-94209-(1-60-MP-compatible-build-post-1-60-release)&p=2179795&viewfull=1#post2179795|text= Rocket}}
<dt><dt>
<dd class="notedate">Posted on 21 Sep, 2013</dd>
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dd class="note">
While [[publicVariable]] is JIP compatible and persistent, [[publicVariableClient]] is not. If you log out then log in with the same owner id the public variable sent to your client prior will be [[nil]].
<sqf>
//server
pv = 123;
3 publicVariableClient "pv";
//connected client with id 3
hint str pv; //123
//
//client log out/log in
//
//client id is still 3
hint str pv; //error, undefined variable pv
</sqf>


<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
<dt></dt>
<dd class="notedate">Posted on 2015-04-12 - 09:27 (UTC)</dd>
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dd class="note">
Tested in Arma 3 v1.43, [[publicVariableClient]] works client-to-client if [[owner]] id of the targeted client is known.
</dd>


[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
</dl>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 September 2024

A2 OA Logo.png1.62tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Send the variable value to the client computer - same limitations regarding variable type as publicVariable. The Client ID is the temporary ID given to a connected client for that session. You can find out this ID with the owner command (using it on a player's character, for example, will give you that players client ID).

Arma 3
In Arma 3 it is possible to broadcast nil value
Groups:
MultiplayerVariables

Syntax

Syntax:
clientID publicVariableClient varName
Parameters:
clientID: Number
varName: String
Return Value:
Nothing

Examples

Example 1:
3 publicVariableClient "CTFscoreOne";

Additional Information

See also:
clientOwner owner publicVariable publicVariableServer addPublicVariableEventHandler remoteExecutedOwner

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Posted on 24 Aug, 2012
Kylania
publicVariableServer (run on client)
publicVariableClient (run on server)
Publishes a variable (name as STRING) to a specific client, from the server. This is useful where you want to synchronize a variable with only a specific client.
This is a useful way to cut down on network traffic, as publicVariable commands are issued as a priority message. So use publicVariable sparingly, and these commands where they apply. - Rocket
Posted on 21 Sep, 2013
Killzone_Kid
While publicVariable is JIP compatible and persistent, publicVariableClient is not. If you log out then log in with the same owner id the public variable sent to your client prior will be nil.
//server pv = 123; 3 publicVariableClient "pv"; //connected client with id 3 hint str pv; //123 // //client log out/log in // //client id is still 3 hint str pv; //error, undefined variable pv
Posted on 2015-04-12 - 09:27 (UTC)
Killzone_Kid
Tested in Arma 3 v1.43, publicVariableClient works client-to-client if owner id of the targeted client is known.
Retrieved from "https://community.bistudio.com/wiki?title=publicVariableClient&oldid=369283"