getUserInfo: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " |game1= arma3 |version1= 2.06 |branch = dev" to " |game1= arma3 |version1= 2.06") |
m (Specify type of clientStateNumber) |
||
Line 19: | Line 19: | ||
* soldierNameInclSquad : [[String]] - player name including squad (see [[name]], [[squadParams]]) | * soldierNameInclSquad : [[String]] - player name including squad (see [[name]], [[squadParams]]) | ||
* steamProfileName : [[String]] steam profile name (see [[profileNameSteam]]) | * steamProfileName : [[String]] steam profile name (see [[profileNameSteam]]) | ||
* clientStateNumber : user client state (see [[getClientStateNumber]]) | * clientStateNumber : [[String]] user client state (see [[getClientStateNumber]]) | ||
* isHeadless : [[Boolean]] - whether or not this is a headless client (see [[hasInterface]], [[isServer]]) | * isHeadless : [[Boolean]] - whether or not this is a headless client (see [[hasInterface]], [[isServer]]) | ||
* adminState : [[Number]] - admin status of the user (see [[admin]]) | * adminState : [[Number]] - admin status of the user (see [[admin]]) |
Revision as of 17:40, 11 October 2021
Description
- Description:
- Returns extended information about given server user.
- Groups:
- MultiplayerObject Detection
Syntax
- Syntax:
- getUserInfo networkID
- Parameters:
- networkID : String - user network id (see getPlayerID, allUsers)
- Return Value:
- Array in format: [networkId, owner, playerUID, soldierName, soldierNameInclSquad, steamProfileName, clientStateNumber, isHeadless, adminState, [avgPing, avgBandwidth, desync], playerObject], where:
- networkId : String - user network id (see getPlayerID, allUsers)
- owner : Number - user owner (see owner)
- playerUID : String - player UID (see getPlayerUID)
- soldierName : String - player name (see profileName)
- soldierNameInclSquad : String - player name including squad (see name, squadParams)
- steamProfileName : String steam profile name (see profileNameSteam)
- clientStateNumber : String user client state (see getClientStateNumber)
- isHeadless : Boolean - whether or not this is a headless client (see hasInterface, isServer)
- adminState : Number - admin status of the user (see admin)
- [avgPing, avgBandwidth, desync] : Array of Numbers - user ping, bandwidth and desync info
- playerObject : Object - user player entity (see player, selectPlayer)
Examples
- Example 1:
- Execute on server:
private _randomUserInfo = getUserInfo selectRandom allUsers;
Additional Information
- See also:
- allUsersgetPlayerID
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