getClientStateNumber: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


|arma3|Game name=
|arma3|Game name=
Line 9: Line 8:




____________________________________________________________________________________________


| 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:
Line 45: Line 43:
{{!}}}
{{!}}}
|DESCRIPTION=
|DESCRIPTION=
____________________________________________________________________________________________


| [[getClientStateNumber]] |SYNTAX=
| [[getClientStateNumber]] |SYNTAX=
Line 54: Line 51:


|x2= <code>_inGame = [[getClientStateNumber]] > 8;</code>|EXAMPLE2=
|x2= <code>_inGame = [[getClientStateNumber]] > 8;</code>|EXAMPLE2=
____________________________________________________________________________________________


| [[getClientState]], [[getPlayerUID]] |SEEALSO=  
| [[getClientState]], [[getPlayerUID]] |SEEALSO=  


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
}}
}}



Revision as of 02:12, 17 January 2021

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:
getClientStateNumber
Return Value:
Number - Client state (see table above)

Examples

Example 1:
_state = getClientStateNumber;
Example 2:
_inGame = getClientStateNumber > 8;

Additional Information

See also:
getClientStategetPlayerUID

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

Notes

Bottom Section