[This is preliminary documentation and is subject to change.]
The Player type exposes the following properties.
Properties
| Member | Description | |
|---|---|---|
| BandwidthUseMode | ||
| Brush | ||
| BytesReceived | Total bytes received (from the client) this session. | |
| BytesReceivedRate | Bytes received (from the client) per second, averaged over the last several seconds. | |
| BytesSent | Total bytes sent (to the client) this session. | |
| BytesSentRate | Bytes sent (to the client) per second, averaged over the last several seconds. | |
| ClassyName | Name formatted for display in chat. | |
| ConfirmCallback | Callback to be called when player types in "/ok" to confirm an action.
Use Player.Confirm(...) methods to set this. | |
| ConfirmParameter | Custom parameter to be passed to Player.ConfirmCallback. | |
| ConfirmRequestTime | Time when the confirmation was requested. UTC. | |
| CopySlot | Gets or sets the currently selected copy slot number. Should be between 0 and (MaxCopySlots-1).
Note that fCraft adds 1 to CopySlot number when presenting it to players.
So 0th slot is shown as "1st" by /CopySlot and related commands; 1st is shown as "2nd", etc. | |
| CopyStates | Returns a list of all CopyStates, indexed by slot. | |
| DisableClickToMark | Whether clicks should be registered towards selection marks. | |
| HasFullyConnected | Whether the player registered and then finished loading the world. | |
| HasRegistered | Whether the player has completed the login sequence. | |
| IdleTime | Time since the player was last active (moved, talked, or clicked). | |
| IgnoreList | Returns a list of all currently-ignored players. | |
| Info | Persistent information record associated with this player. | |
| IP | Remote IP address of this player. | |
| IsDeaf | Whether player has blocked all incoming chat.
Deaf players can't hear anything. | |
| IsMakingSelection | Whether player is currently making a selection. | |
| IsOnline | Whether the client is currently connected. | |
| IsPainting | Whether the player is in paint mode (deleting blocks replaces them). Used by /Paint. | |
| IsRepeatingSelection | Whether player is repeating a selection (/static) | |
| IsSpectating | Whether this player is currently spectating someone. | |
| IsUsingWoM | Whether the client supports advanced WoM client functionality. | |
| IsVerified | Whether the player name was verified at login. | |
| LastActiveTime | Last time when the player was active (moving/messaging). UTC. | |
| LastCommand | Last command called by the player. | |
| LastDrawOp | ||
| LastPatrolTime | Last time when this player was patrolled by someone. | |
| LastSpectatedPlayer | While spectating, currently-specated player.
When not spectating, most-recently-spectated player. | |
| LastUsedBlockType | Last blocktype used by the player.
Make sure to use in conjunction with Player.GetBind() to ensure that bindings are properly applied. | |
| LastUsedPlayerName | ||
| LastUsedWorldName | ||
| LeaveReason | Reason that this player is about to leave / has left the server. Set by Kick.
This value is undefined until the player is about to disconnect. | |
| ListName | Name formatted for display in the player list. | |
| LoginTime | Time when the session connected. | |
| MaxBlockPlacementRange | Max distance that player may be from a block to reach it (hack detection). | |
| MaxCopySlots | Gets or sets the maximum number of copy slots allocated to this player.
Should be nonnegative. CopyStates are preserved when increasing the maximum.
When decreasing the value, any CopyStates in slots that fall outside the new maximum are lost. | |
| Metadata | Metadata associated with the session/player. | |
| Name | Plain version of the name (no formatting). | |
| RelayAllUpdates | ||
| SelectionMarkCount | Number of selection marks so far. | |
| SelectionMarksExpected | Number of marks expected to complete the selection. | |
| SocketTimeout | ||
| SpectatedPlayer | Player currently being spectated. Use Spectate/StopSpectate methods to set. | |
| State | Whether the player has completed the login sequence. | |
| World | The world that the player is currently on. May be null.
Use .JoinWorld() to make players teleport to another world. | |
| WorldMap | Map from the world that the player is on.
Throws PlayerOpException if player does not have a world.
Loads the map if it's not loaded. Guaranteed to not return null. |