getUserInfo: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Killzone Kid (talk | contribs) No edit summary |
||
Line 16: | Line 16: | ||
|r1= [[Array]] in format [playerID, owner, playerUID, soldierName, displayName, steamProfileName, clientStateNumber, isHeadless, adminState, networkInfo, playerObject], where: | |r1= [[Array]] in format [playerID, owner, playerUID, soldierName, displayName, steamProfileName, clientStateNumber, isHeadless, adminState, networkInfo, playerObject], where: | ||
* playerID: [[String]] - user DirectPlay ID (see [[getPlayerID]], [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]]) | * 0 - playerID: [[String]] - user DirectPlay ID (see [[getPlayerID]], [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]]) | ||
* owner: [[Number]] - user owner (see [[owner]]) | * 1 - owner: [[Number]] - user owner (see [[owner]]) | ||
* playerUID: [[String]] - player UID (see [[getPlayerUID]]) | * 2 - playerUID: [[String]] - player UID (see [[getPlayerUID]]) | ||
* soldierName: [[String]] - player name (see [[profileName]]) | * 3 - soldierName: [[String]] - player name (see [[profileName]]) | ||
* displayName: [[String]] - player name including squad (see [[name]], [[squadParams]]) | * 4 - displayName: [[String]] - player name including squad (see [[name]], [[squadParams]]) | ||
* steamProfileName: [[String]] - steam profile name (see [[profileNameSteam]]) | * 5 - steamProfileName: [[String]] - steam profile name (see [[profileNameSteam]]) | ||
* clientStateNumber: [[String]] user client state (see [[getClientStateNumber]]) | * 6 - clientStateNumber: [[String]] user client state (see [[getClientStateNumber]]) | ||
* isHeadless: [[Boolean]] - whether or not this is a headless client (see [[hasInterface]], [[isServer]]) | * 7 - isHeadless: [[Boolean]] - whether or not this is a headless client (see [[hasInterface]], [[isServer]]) | ||
* adminState: [[Number]] - admin status of the user (see [[admin]]) | * 8 - adminState: [[Number]] - admin status of the user (see [[admin]]) | ||
* networkInfo: [[Array]] of [[Number]]s - format [ping, bandwidth desync] | * 9 - networkInfo: [[Array]] of [[Number]]s - format [ping, bandwidth desync] | ||
* playerObject: [[Object]] - user player entity (see [[player]], [[selectPlayer]]) | * 10 - playerObject: [[Object]] - user player entity (see [[player]], [[selectPlayer]]) | ||
{{Feature|informative|Returns an empty array if said player is not found.}} | {{Feature|informative|Returns an empty array if said player is not found.}} |
Revision as of 01:04, 14 February 2024
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, displayName, steamProfileName, clientStateNumber, isHeadless, adminState, networkInfo, playerObject], where:
- 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)
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