getClientState: Difference between revisions

Latest revision as of 14:00, 8 November 2023

Hover & click on the images for 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

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

: 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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.08
-|1.08
+|gr1= Multiplayer
-|gr1 = Multiplayer
+|descr= Returns client state in network game. Works on both, client and dedicated server. The following states are possible:
-| Returns client state in network game. Works on both, client and dedicated server. The following states are possible:
+{{{!}} class="wikitable"
-{{{!}} class{{=}}"wikitable"
 ! [[getClientStateNumber]]
 ! [[getClientState]]
@@ Line 41: / Line 40: @@
 {{!}}}
-| [[getClientState]]
+|s1= [[getClientState]]
-| [[String]] - Client state (see table above)
-|x1= <code>_state = [[getClientState]];</code>
+|r1= [[String]] - client state (see table above)
-|x2= <code>[[if]] ([[getClientState]] == "BRIEFING READ") [[then]] {[[hint]] "Let the show begin!"};</code>
+|x1= <sqf>_state = getClientState;</sqf>
-| [[getClientStateNumber]], [[getPlayerUID]]
+|x2= <sqf>if (getClientState == "BRIEFING READ") then { hint "Let the show begin!" };</sqf>
+|seealso= [[getClientStateNumber]] [[getPlayerUID]]
 }}
-{{GameCategory|arma3|Scripting Commands}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]