BIS fnc getServerVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (pf)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *V([a-z ])" to "$1 - v$2")
 
(34 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma 3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Variables
____________________________________________________________________________________________


| Fetch a variable saved on server. Used when you want to share variables only to specific clients to prevent large traffic. Must be [[spawn|spawned]] because communication with server takes some time. |= Description
|descr= Fetch a variable saved on server.
____________________________________________________________________________________________
Used when you want to share variables only to specific clients to prevent large traffic.
Must be run in [[Scheduler#Scheduled_Environment|scheduled environment]] because communication with server takes some time.


| [target, varName, default] spawn [[BIS_fnc_getServerVariable]] |= Syntax
|s1= [target, varName, default] call [[BIS_fnc_getServerVariable]]
____________________________________________________________________________________________


|p1= target: [[Namespace]], [[Object]] or [[Group]] - Variable name space|= Parameter 1
|p1= target: [[Namespace]], [[Object]] or [[Group]] - variable name space
|p2= varName: [[String]] - Variable name|= Parameter 2
|p3= varName: [[Anything]] - Default value returned when variable is [[nil]]|= Parameter 3
____________________________________________________________________________________________
|exec= spawn |= Execution
____________________________________________________________________________________________


| [[Anything]] - Default value or saved variable|= Return value
|p2= varName: [[String]] - variable name
____________________________________________________________________________________________


|x1= <code>[ [[missionNamespace]], "BIS_someVar", "defaultValue"] [[spawn]] [[BIS_fnc_getServerVariable]];</code> |=
|p3= default: [[Anything]] - default value returned when variable is [[nil]]
____________________________________________________________________________________________


| [[getVariable]], [[setVariable]], [[allVariables]]|= See also }}
|r1= [[Anything]] - default value or saved variable


|x1= <sqf>[missionNamespace, "BIS_someVar", "defaultValue"] call BIS_fnc_getServerVariable;</sqf>


 
|seealso= [[getVariable]] [[setVariable]] [[allVariables]]
<h3 style="display:none">Notes</h3>
}}
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Variables|{{uc:getServerVariable}}]]
[[Category:Functions|{{uc:getServerVariable}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getServerVariable}}]]

Latest revision as of 15:53, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Fetch a variable saved on server. Used when you want to share variables only to specific clients to prevent large traffic. Must be run in scheduled environment because communication with server takes some time.
Execution:
call
Groups:
Variables

Syntax

Syntax:
[target, varName, default] call BIS_fnc_getServerVariable
Parameters:
target: Namespace, Object or Group - variable name space
varName: String - variable name
default: Anything - default value returned when variable is nil
Return Value:
Anything - default value or saved variable

Examples

Example 1:
[missionNamespace, "BIS_someVar", "defaultValue"] call BIS_fnc_getServerVariable;

Additional Information

See also:
getVariable setVariable allVariables

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getServerVariable&oldid=349343"