getClientState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.08


|1.08|Game version=
|gr1= Multiplayer
____________________________________________________________________________________________


| Returns client state in network game. Works on both, client and dedicated server. The following states are possible:
|descr= Returns client state in network game. Works on both, client and dedicated server. The following states are possible:


{{{!}} class{{=}}"bikitable"
{{{!}} class="wikitable"
! [[getClientStateNumber]]
! [[getClientStateNumber]]
! [[getClientState]]
! [[getClientState]]
Line 40: Line 39:
{{!}} 12 {{!}}{{!}} "DEBRIEFING READ" {{!}}{{!}} Debriefing read, ready to continue with next mission
{{!}} 12 {{!}}{{!}} "DEBRIEFING READ" {{!}}{{!}} Debriefing read, ready to continue with next mission
{{!}}}
{{!}}}
|DESCRIPTION=
____________________________________________________________________________________________


| [[getClientState]] |SYNTAX=
|s1= [[getClientState]]


| [[String]] - Client state (see table above) |RETURNVALUE=
|r1= [[String]] - client state (see table above)


|x1= <code>_state = [[getClientState]];</code>|EXAMPLE1=
|x1= <sqf>_state = getClientState;</sqf>


|x2= <code>[[if]] ([[getClientState]] == "BRIEFING READ") [[then]] {[[hint]] "Let the show begin!"};</code>|EXAMPLE2=
|x2= <sqf>if (getClientState == "BRIEFING READ") then { hint "Let the show begin!" };</sqf>
____________________________________________________________________________________________


| [[getClientStateNumber]], [[getPlayerUID]] |SEEALSO=
|seealso= [[getClientStateNumber]] [[getPlayerUID]]
 
|  |MPBEHAVIOUR=
}}
}}
<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:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:00, 8 November 2023

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

Description

Description:
Returns client state in network game. Works on both, client and dedicated server. The following states are possible:
getClientStateNumber getClientState Description
0 "NONE" No client (or singleplayer)
1 "CREATED" Client is created
2 "CONNECTED" Client is connected to server, message formats are registered
3 "LOGGED IN" Identity is created
4 "MISSION SELECTED" Mission is selected
5 "MISSION ASKED" Server was asked to send / not send mission
6 "ROLE ASSIGNED" Role was assigned (and confirmed)
7 "MISSION RECEIVED" Mission received
8 "GAME LOADED" Island loaded, vehicles received
9 "BRIEFING SHOWN" Briefing was displayed
10 "BRIEFING READ" Ready to play mission
11 "GAME FINISHED" Game was finished
12 "DEBRIEFING READ" Debriefing read, ready to continue with next mission
Groups:
Multiplayer

Syntax

Syntax:
getClientState
Return Value:
String - client state (see table above)

Examples

Example 1:
_state = getClientState;
Example 2:
if (getClientState == "BRIEFING READ") then { hint "Let the show begin!" };

Additional Information

See also:
getClientStateNumber getPlayerUID

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=getClientState&oldid=348401"