getUserInfo: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Add Example) |
m (Fixed incorrect info, added example) |
||
Line 12: | Line 12: | ||
|descr= Returns extended information about given server user. | |descr= Returns extended information about given server user. | ||
|s1= [[getUserInfo]] | |s1= [[getUserInfo]] playerID | ||
|p1= | |p1= playerID : [[String]] - user DirectPlay ID (see [[getPlayerID]], [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]]) | ||
|r1= [[Array]] in format: [networkId, owner, playerUID, soldierName, soldierNameInclSquad, steamProfileName, clientStateNumber, isHeadless, adminState, [avgPing, avgBandwidth, desync], playerObject], where: | |r1= [[Array]] in format: [networkId, owner, playerUID, soldierName, soldierNameInclSquad, steamProfileName, clientStateNumber, isHeadless, adminState, [avgPing, avgBandwidth, desync], playerObject], where: | ||
* | * playerID : [[String]] - user DirectPlay ID (see [[getPlayerID]], [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]]) | ||
* owner : [[Number]] - user owner (see [[owner]]) | * owner : [[Number]] - user owner (see [[owner]]) | ||
* playerUID : [[String]] - player UID (see [[getPlayerUID]]) | * playerUID : [[String]] - player UID (see [[getPlayerUID]]) | ||
Line 31: | Line 31: | ||
|x2= <sqf> | |x2= <sqf> | ||
_userInfo params [" | _userInfo params ["_playerID", "_ownerId", "_playerUID", "_profileName", "_displayName", "_steamName", "_clientState", "_isHC", "_adminState", "_networkInfo", "_unit"]; | ||
_networkInfo params ["_avgPing", "_avgBandwidth", "_desync"]; | _networkInfo params ["_avgPing", "_avgBandwidth", "_desync"]; | ||
</sqf> | </sqf> | ||
|x3= <sqf>private _myInfo = getUserInfo getPlayerID player;</sqf> | |||
|seealso= [[allUsers]] [[getPlayerID]] [[getUnitFreefallInfo]] | |seealso= [[allUsers]] [[getPlayerID]] [[getUnitFreefallInfo]] | ||
}} | }} |
Revision as of 23:51, 27 March 2022
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: [networkId, 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:
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