BIS fnc getServerVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|SEEALSO= }" to " }")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Variables
|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 run in [[Scheduler#Scheduled_Environment|scheduled environment]] because communication with server takes some time.
|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.


|s1=[target, varName, default] call [[BIS_fnc_getServerVariable]]
|s1= [target, varName, default] call [[BIS_fnc_getServerVariable]]


|p1= target: [[Namespace]], [[Object]] or [[Group]] - Variable name space
|p1= target: [[Namespace]], [[Object]] or [[Group]] - Variable name space
|p2= varName: [[String]] - Variable name
|p2= varName: [[String]] - Variable name
|p3= default: [[Anything]] - Default value returned when variable is [[nil]]
|p3= default: [[Anything]] - Default value returned when variable is [[nil]]
|r1=[[Anything]] - Default value or saved variable


|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "BIS_someVar", "defaultValue"] [[call]] [[BIS_fnc_getServerVariable]];</code>
|r1= [[Anything]] - Default value or saved variable
 
|x1= <code>[<nowiki/>[[missionNamespace]], "BIS_someVar", "defaultValue"] [[call]] [[BIS_fnc_getServerVariable]];</code>


| [[getVariable]], [[setVariable]], [[allVariables]]
|seealso= [[getVariable]], [[setVariable]], [[allVariables]]
}}
}}

Revision as of 19:48, 13 June 2021

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:
getVariablesetVariableallVariables

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