Search
Preparing search index...
The search index is not available
voxelservercore
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"src/lib/player/player"
Player
Class Player
Hierarchy
Player
Implements
ICorePlayer
Index
Constructors
constructor
Properties
_chunks
Interval
_chunks
ToSend
_players
_server
chunks
display
Name
entity
hook
Inventory
id
inventory
ip
Address
movement
nickname
permissions
socket
world
Accessors
getID
Methods
action_
blockbreak
action_
blockpick
action_
blockplace
action_
chatmessage
action_
click
action_
entityclick
action_
invclick
action_
move
apply
Force
ban
banIP
get
Object
kick
move
remove
rotate
send
send
Chunk
send
Packet
set
Fog
set
Sky
set
Tab
teleport
update
Chunks
update
Movement
update
Physics
Object literals
cache
crafting
Constructors
constructor
new
Player
(
id
:
string
, name
:
string
, socket
:
BaseSocket
, players
:
PlayerManager
)
:
Player
Parameters
id:
string
name:
string
socket:
BaseSocket
players:
PlayerManager
Returns
Player
Properties
_chunks
Interval
_chunks
Interval
:
any
_chunks
ToSend
_chunks
ToSend
:
any
[]
= []
_players
_players
:
PlayerManager
_server
_server
:
Server
chunks
chunks
:
types.anyobject
display
Name
display
Name
:
string
entity
entity
:
Entity
hook
Inventory
hook
Inventory
:
any
Readonly
id
id
:
string
inventory
inventory
:
PlayerInventory
Readonly
ip
Address
ip
Address
:
string
= "0.0.0.0"
movement
movement
:
PlayerMovement
Readonly
nickname
nickname
:
string
permissions
permissions
:
PlayerPermissionHolder
Readonly
socket
socket
:
BaseSocket
world
world
:
World
Accessors
getID
get
getID
(
)
:
string
Returns
string
Methods
action_
blockbreak
action_
blockbreak
(
data
:
IActionBlockBreak
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionBlockBreak
&
{
cancel
:
boolean
}
Returns
void
action_
blockpick
action_
blockpick
(
data
:
IActionInventoryPick
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionInventoryPick
&
{
cancel
:
boolean
}
Returns
void
action_
blockplace
action_
blockplace
(
data
:
IActionBlockPlace
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionBlockPlace
&
{
cancel
:
boolean
}
Returns
void
action_
chatmessage
action_
chatmessage
(
data
:
IActionMessage
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionMessage
&
{
cancel
:
boolean
}
Returns
void
action_
click
action_
click
(
data
:
IActionClick
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionClick
&
{
cancel
:
boolean
}
Returns
void
action_
entityclick
action_
entityclick
(
data
:
IActionClickEntity
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionClickEntity
&
{
cancel
:
boolean
}
Returns
void
action_
invclick
action_
invclick
(
data
:
IActionInventoryClick
&
{
cancel
:
boolean
}
)
:
void
Parameters
data:
IActionInventoryClick
&
{
cancel
:
boolean
}
Returns
void
action_
move
action_
move
(
data
:
IActionMove
&
{
cancel
:
boolean
}
)
:
Promise
<
void
>
Parameters
data:
IActionMove
&
{
cancel
:
boolean
}
Returns
Promise
<
void
>
apply
Force
apply
Force
(
x
:
number
, y
:
number
, z
:
number
)
:
void
Parameters
x:
number
y:
number
z:
number
Returns
void
ban
ban
(
reason
?:
string
)
:
void
Parameters
Default value
reason:
string
= "Unknown reason"
Returns
void
banIP
banIP
(
reason
?:
string
)
:
void
Parameters
Default value
reason:
string
= "Unknown reason"
Returns
void
get
Object
get
Object
(
)
:
{
entity
:
IEntityObject
;
id
:
string
;
inventory
:
InventoryObject
;
ipAddress
:
string
;
movement
:
PlayerMovement
;
nickname
:
string
;
permissionparents
:
string
[]
;
permissions
:
{}
;
world
:
string
}
Returns
{
entity
:
IEntityObject
;
id
:
string
;
inventory
:
InventoryObject
;
ipAddress
:
string
;
movement
:
PlayerMovement
;
nickname
:
string
;
permissionparents
:
string
[]
;
permissions
:
{}
;
world
:
string
}
entity
:
IEntityObject
id
:
string
inventory
:
InventoryObject
ip
Address
:
string
movement
:
PlayerMovement
nickname
:
string
permissionparents
:
string
[]
permissions
:
{}
[
index:
string
]:
boolean
|
null
world
:
string
kick
kick
(
reason
?:
string
)
:
void
Parameters
Default value
reason:
string
= ""
Returns
void
move
move
(
pos
:
types.XYZ
)
:
void
Parameters
pos:
types.XYZ
Returns
void
remove
remove
(
)
:
void
Returns
void
rotate
rotate
(
rot
:
number
|
null
, pitch
:
number
|
null
)
:
void
Parameters
rot:
number
|
null
pitch:
number
|
null
Returns
void
send
send
(
msg
:
string
|
chat.ChatMessage
|
CoreMessage
|
MessageBuilder
)
:
void
Parameters
msg:
string
|
chat.ChatMessage
|
CoreMessage
|
MessageBuilder
Returns
void
send
Chunk
send
Chunk
(
id
:
types.XZ
)
:
void
Parameters
id:
types.XZ
Returns
void
send
Packet
send
Packet
(
type
:
string
, data
:
Object
)
:
void
Parameters
type:
string
data:
Object
Returns
void
set
Fog
set
Fog
(
mode
:
number
, density
?:
number
, color
?:
[
]
, start
?:
number
, stop
?:
number
)
:
void
Parameters
mode:
number
Optional
density:
number
Optional
color:
[
]
Optional
start:
number
Optional
stop:
number
Returns
void
set
Sky
set
Sky
(
color
:
[
]
, colorTop
:
[
]
, clouds
?:
boolean
)
:
void
Parameters
color:
[
]
colorTop:
[
]
Optional
clouds:
boolean
Returns
void
set
Tab
set
Tab
(
msg
:
chat.ChatMessage
)
:
void
Parameters
msg:
chat.ChatMessage
Returns
void
teleport
teleport
(
pos
:
types.XYZ
, eworld
:
string
|
World
)
:
void
Parameters
pos:
types.XYZ
eworld:
string
|
World
Returns
void
update
Chunks
update
Chunks
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
update
Movement
update
Movement
(
key
:
string
, value
:
number
)
:
void
Parameters
key:
string
value:
number
Returns
void
update
Physics
update
Physics
(
key
:
string
, value
:
number
)
:
void
Parameters
key:
string
value:
number
Returns
void
Object literals
cache
cache
:
object
last
Block
Check
last
Block
Check
:
object
status
status
:
boolean
= false
x
x
:
number
= 0
y
y
:
number
= 0
z
z
:
number
= 0
crafting
crafting
:
object
result
result
:
null
= null
size
size
:
number
= 5
items
items
:
object
0
0
:
null
= null
1
1
:
null
= null
2
2
:
null
= null
3
3
:
null
= null
Globals
"src/lib/player/player"
Player
constructor
_chunks
Interval
_chunks
ToSend
_players
_server
chunks
display
Name
entity
hook
Inventory
id
inventory
ip
Address
movement
nickname
permissions
socket
world
getID
action_
blockbreak
action_
blockpick
action_
blockplace
action_
chatmessage
action_
click
action_
entityclick
action_
invclick
action_
move
apply
Force
ban
banIP
get
Object
kick
move
remove
rotate
send
send
Chunk
send
Packet
set
Fog
set
Sky
set
Tab
teleport
update
Chunks
update
Movement
update
Physics
cache
crafting
Player
Manager
Player
Movement
default
Player
Movement
Generated using
TypeDoc