getUserInfo: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Add Example) |
||
Line 3: | Line 3: | ||
|game1= arma3 | |game1= arma3 | ||
|version1= 2.06 | |version1= 2.06 | ||
|gr1= Multiplayer | |gr1= Multiplayer | ||
|gr2= Object Detection | |gr2= Object Detection | ||
|serverExec= server | |serverExec= server | ||
Line 25: | Line 28: | ||
* playerObject : [[Object]] - user player entity (see [[player]], [[selectPlayer]]) | * playerObject : [[Object]] - user player entity (see [[player]], [[selectPlayer]]) | ||
|x1= | |x1= <sqf>private _randomUserInfo = getUserInfo selectRandom allUsers;</sqf> | ||
|x2= <sqf> | |||
_userInfo params ["_playerId", "_ownerId", "_playerUID", "_profileName", "_displayName", "_steamName", "_clientState", "_isHC", "_adminState", "_networkInfo", "_unit"]; | |||
_networkInfo params ["_avgPing", "_avgBandwidth", "_desync"]; | |||
</sqf> | |||
|seealso= [[allUsers]] [[getPlayerID]] [[getUnitFreefallInfo]] | |seealso= [[allUsers]] [[getPlayerID]] [[getUnitFreefallInfo]] | ||
}} | }} |
Revision as of 13:09, 27 March 2022
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:
- Example 2:
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