Search
Preparing search index...
The search index is not available
voxelservercore
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"src/server"
Server
Class Server
Hierarchy
EventEmitter
Server
Implements
ICoreServer
Index
Constructors
constructor
Properties
config
console
entities
heartbeatID
log
name
overrides
permissions
player
Count
players
plugins
registry
status
version
worlds
default
Max
Listeners
Methods
add
Listener
connect
Player
emit
event
Names
get
Max
Listeners
heartbeat
Ping
init
Def
World
init
Defaults
listener
Count
listeners
load
Config
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
save
Config
set
Max
Listeners
start
Server
stop
Server
listener
Count
Constructors
constructor
new
Server
(
startServer
?:
boolean
)
:
Server
Parameters
Default value
startServer:
boolean
= true
Returns
Server
Properties
config
config
:
IServerConfig
console
console
:
Console
entities
entities
:
EntityManager
heartbeatID
heartbeatID
:
number
log
log
:
Logging
name
name
:
string
= "VoxelSrv Server"
overrides
overrides
:
{}
Type declaration
[
i:
string
]:
[
]
permissions
permissions
:
PermissionManager
player
Count
player
Count
:
number
= 0
players
players
:
PlayerManager
plugins
plugins
:
PluginManager
registry
registry
:
Registry
status
status
:
string
= "none"
version
version
:
string
= serverVersion
worlds
worlds
:
WorldManager
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
add
Listener
add
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
connect
Player
connect
Player
(
socket
:
BaseSocket
)
:
Promise
<
void
>
Parameters
socket:
BaseSocket
Returns
Promise
<
void
>
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
heartbeat
Ping
heartbeat
Ping
(
)
:
void
Returns
void
Private
init
Def
World
init
Def
World
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Private
init
Defaults
init
Defaults
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
load
Config
load
Config
(
namespace
:
string
, config
:
string
)
:
any
Parameters
namespace:
string
config:
string
Returns
any
off
off
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
on
on
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
once
once
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Listener
prepend
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
save
Config
save
Config
(
namespace
:
string
, config
:
string
, data
:
any
)
:
void
Parameters
namespace:
string
config:
string
data:
any
Returns
void
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
start
Server
start
Server
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
stop
Server
stop
Server
(
)
:
void
Returns
void
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
deprecated
since v4.0.0
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
"src/server"
Console
Plugin
Manager
Server
constructor
config
console
entities
heartbeatID
log
name
overrides
permissions
player
Count
players
plugins
registry
status
version
worlds
default
Max
Listeners
add
Listener
connect
Player
emit
event
Names
get
Max
Listeners
heartbeat
Ping
init
Def
World
init
Defaults
listener
Count
listeners
load
Config
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
save
Config
set
Max
Listeners
start
Server
stop
Server
listener
Count
verify
Login
Generated using
TypeDoc
since v4.0.0