getUserInfo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Note to return value) |
||
Line 27: | Line 27: | ||
* [avgPing, avgBandwidth, desync] : [[Array]] of [[Number]]s - user ping, bandwidth and desync info | * [avgPing, avgBandwidth, desync] : [[Array]] of [[Number]]s - user ping, bandwidth and desync info | ||
* playerObject : [[Object]] - user player entity (see [[player]], [[selectPlayer]]) | * playerObject : [[Object]] - user player entity (see [[player]], [[selectPlayer]]) | ||
{{Feature|informative|Returns empty array {{hl|[]}} if [[player]] does not exist.}} | |||
|x1= <sqf>private _randomUserInfo = getUserInfo selectRandom allUsers;</sqf> | |x1= <sqf>private _randomUserInfo = getUserInfo selectRandom allUsers;</sqf> |
Revision as of 16:14, 1 August 2023
Description
- Description:
- Returns extended information about given server user.
- Groups:
- MultiplayerObject Detection
Syntax
- Syntax:
- getUserInfo playerID
- Parameters:
- playerID : String - user DirectPlay ID (see getPlayerID, PlayerConnected)
- Return Value:
- Array in format: [playerID, owner, playerUID, soldierName, soldierNameInclSquad, steamProfileName, clientStateNumber, isHeadless, adminState, [avgPing, avgBandwidth, desync], playerObject], where:
- playerID : String - user DirectPlay ID (see getPlayerID, PlayerConnected)
- 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:
- Example 2:
- Example 3:
- private _myInfo = getUserInfo getPlayerID player; // this particular example only works if player is server host
Additional Information
- See also:
- allUsers getPlayerID getUnitFreefallInfo
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