getUserInfo

2.06

SEServer

Hover & click on the images for description

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 with [playerID, owner, playerUID, soldierName, displayName, steamProfileName, clientStateNumber, isHeadless, adminState, networkInfo, playerObject]:

• 0 - playerID: String - user DirectPlay ID (see getPlayerID, PlayerConnected)
• 1 - owner: Number - user owner (see owner)
• 2 - playerUID: String - player UID (see getPlayerUID)
• 3 - soldierName: String - player name (see profileName)
• 4 - displayName: String - player name including squad (see name, squadParams)
• 5 - steamProfileName: String - steam profile name (see profileNameSteam)
• 6 - clientStateNumber: String user client state (see getClientStateNumber)
• 7 - isHeadless: Boolean - whether or not this is a headless client (see hasInterface, isServer)
• 8 - adminState: Number - admin status of the user (see admin)
• 9 - networkInfo: Array of Numbers - format [ping, bandwidth, desync]
• 10 - playerObject: Object - user player entity (see player, selectPlayer)

ⓘ

Returns an empty array if said player is not found.

2.18

Alternative Syntax

Syntax:

playerID getUserInfo infoIndex

Parameters:

playerID: String - user DirectPlay ID (see getPlayerID, PlayerConnected)

infoIndex: Number - the index of the data in the return array (see main syntax)

Return Value:

Anything - depends on the requested index (see main syntax) or Nothing

Examples

Example 1:

private _randomUserInfo = getUserInfo selectRandom allUsers;

Example 2:

_userInfo params ["_playerID", "_ownerId", "_playerUID", "_profileName", "_displayName", "_steamName", "_clientState", "_isHC", "_adminState", "_networkInfo", "_unit"]; _networkInfo params ["_avgPing", "_avgBandwidth", "_desync"];

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.
Only post proven facts here! Add Note