getClientState: Difference between revisions

Latest revision as of 14:00, 8 November 2023

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.08
-|1.06|= Game version
+|gr1= Multiplayer
-____________________________________________________________________________________________
-| Returns client state in network game. Works on both, client and dedicated server. |= Description
+|descr= Returns client state in network game. Works on both, client and dedicated server. The following states are possible:
-____________________________________________________________________________________________
-| '''getClientState''' |= Syntax
+{{{!}} class="wikitable"
+! [[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
+{{!}}}
-| [[String]] - Client state. Possible values are:
+|s1= [[getClientState]]
-* NONE - no client (or singleplayer)
+|r1= [[String]] - client state (see table above)
-* CREATED - client is create
-* CONNECTED - client is connected to server, message formats are registered
-* LOGGED IN - identity is created
-* MISSION SELECTED - mission is selected
-* MISSION ASKED - server was asked to send / not send mission
-* ROLE ASSIGNED - role was assigned (and confirmed)
-* MISSION RECEIVED - mission received
-* GAME LOADED - island loaded, vehicles received
-* BRIEFING SHOWN - briefing was displayed
-* BRIEFING READ - ready to play mission
-* GAME FINISHED - game was finished
-* DEBRIEFING READ - debriefing read, ready to continue with next mission
-|= RETURNVALUE
+|x1= <sqf>_state = getClientState;</sqf>
-|x1= <code>_state = [[getClientState]];</code>|= EXAMPLE1
+|x2= <sqf>if (getClientState == "BRIEFING READ") then { hint "Let the show begin!" };</sqf>
-____________________________________________________________________________________________
-| [[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:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]