Interface FullServer

interface FullServer {
    _server: Server;
    ban: ((uuid, reason?) => Promise<boolean>);
    banUsername: ((username, reason) => Promise<boolean>);
    bannedPlayers: {};
    behavior: ((eventName, data?, func?, cancelFunc?) => Promise<any>);
    broadcast: ((message, opt?) => void);
    commands: Command.default;
    createLog: (() => void);
    doDaylightCycle: boolean;
    emitParticle: ((particle, world, position, __namedParameters?) => void);
    entities: Record<string, Entity>;
    entityMaxId: number;
    err: ((message) => void);
    getNearby: ((params) => Player[]);
    getNote: ((note) => number);
    getPlayer: ((username) => any);
    getUUIDFromUsername: ((username) => Promise<string>);
    info: ((message) => void);
    levelData?: LevelDatFull;
    log: ((message) => void);
    mcData: IndexedData;
    netherworld: CustomWorld;
    notifyNeighborsOfStateChange: ((world, pos, fromTick, tick, forceNotify?, data?) => void);
    notifyNeighborsOfStateChangeDirectional: ((world, pos, dir, fromTick, tick, forceNotify?, data?) => void);
    onBlockInteraction: ((name, handler) => void);
    onBlockUpdate: ((name, handler) => void);
    onItemPlace: ((name, handler, warn?) => void);
    overworld: CustomWorld;
    pardonUsername: ((username) => Promise<boolean>);
    playNoteBlock: ((pitch, world, position, __namedParameters?) => void);
    playSound: ((sound, world, position, __namedParameters?) => void);
    players: Player[];
    plugins: {};
    pluginsReady: boolean;
    selectorString: ((str, pos?, world?, allowUser?, ctxEntityId?) => Entity[]);
    setBlock: ((world, position, stateId) => Promise<void>);
    setBlockAction: ((world, position, actionId, actionParam) => Promise<void>);
    setTickInterval: ((ticksPerSecond) => void);
    setTime: ((time) => void);
    spawnPoint?: Vec3;
    supportFeature: ((feature) => boolean);
    tabComplete: {
        add: ((id, cb) => void);
        types: any[];
        use: ((id, otherData?, existingContent?) => void);
    };
    tickCount: number;
    time: number;
    updateBlock: ((world, pos, fromTick, tick, forceNotify?, data?) => void);
    uuidToPlayer: {};
    warn: ((message) => void);
    addListener<E>(event, listener): this;
    emit<E>(event, ...args): boolean;
    eventNames(): (string | symbol)[];
    formatMessage(message): any;
    getMaxListeners(): number;
    listenerCount<E>(event): number;
    listeners<E>(event): Function[];
    off<E>(event, listener): this;
    on<E>(event, listener): this;
    once<E>(event, listener): this;
    prependListener<E>(event, listener): this;
    prependOnceListener<E>(event, listener): this;
    rawListeners<E>(event): Function[];
    removeAllListeners<E>(event?): this;
    removeListener<E>(event, listener): this;
    setMaxListeners(maxListeners): this;
}

Hierarchy

Server
- FullServer

Properties

_server

_server: Server

ban

ban: ((uuid, reason?) => Promise<boolean>)

Ban player given a uuid. If the player is online, using player.ban(). Bans with reason or You are banned!.

Type declaration

- (uuid, reason?): Promise<boolean>
- Ban player given a uuid. If the player is online, using player.ban(). Bans with reason or You are banned!.
  Parameters
  - uuid: string
  - Optional reason: string
  Returns Promise<boolean>

banUsername

banUsername: ((username, reason) => Promise<boolean>)

Bans players given a username. Mainly used if player is not online, otherwise use player.ban().

Type declaration

- (username, reason): Promise<boolean>
- Bans players given a username. Mainly used if player is not online, otherwise use player.ban().
  Parameters
  - username: string
  - reason: string
  Returns Promise<boolean>

bannedPlayers

bannedPlayers: {}

Object of players that are banned, key is their uuid. Use () getUUIDFromUsername() if you only have their username.

Example player:

{
    time: <time in epoch>,
    reason: <reason given>
}

Type declaration

behavior

behavior: ((eventName, data?, func?, cancelFunc?) => Promise<any>)

Type declaration

- (eventName, data?, func?, cancelFunc?): Promise<any>
- Parameters
  - eventName: string
  - Optional data: any
  - Optional func: Function
  - Optional cancelFunc: Function
  Returns Promise<any>

broadcast

broadcast: ((message, opt?) => void)

Broadcasts message to all the players with the optional color.

Type declaration

- (message, opt?): void
- Broadcasts message to all the players with the optional color.
  Parameters
  - message: any
  - Optional opt: {
        blacklist?: any[];
        system?: boolean;
        whitelist?: any;
    }
    - Optional blacklist?: any[]
    - Optional system?: boolean
    - Optional whitelist?: any
  Returns void

commands

commands: Command.default

createLog

createLog: (() => void)

Creates the log file

Type declaration

- (): void
- Creates the log file
  
  Returns void

doDaylightCycle

doDaylightCycle: boolean

Default true. If false, time will not automatically pass.

emitParticle

emitParticle: ((particle, world, position, __namedParameters?) => void)

Emits particle (see id list) at position in world.

Opt:

whitelist: Array of players that can see the particle (can be a player object)
blacklist: Array of players who cannot see the particle
radius: Radius that the particle can be seen from
longDistance: I don't know what this is. I think this is pointless with our implenetation of radius, not sure though...
size: vec3 of the size. (0,0,0) will be at an exact position, (10,10,10) will be very spread out (particles less dense)
count: Number of particles. 100,000,000+ will crash the client. Try not to go over 100,000 (sincerely, minecraft clients)

Type declaration

- (particle, world, position, __namedParameters?): void
- Emits particle (see id list) at position in world.
  
  Opt:
  - whitelist: Array of players that can see the particle (can be a player object)
  - blacklist: Array of players who cannot see the particle
  - radius: Radius that the particle can be seen from
  - longDistance: I don't know what this is. I think this is pointless with our implenetation of radius, not sure though...
  - size: vec3 of the size. (0,0,0) will be at an exact position, (10,10,10) will be very spread out (particles less dense)
  - count: Number of particles. 100,000,000+ will crash the client. Try not to go over 100,000 (sincerely, minecraft clients)
  Parameters
  - particle: any
  - world: any
  - position: any
  - Optional __namedParameters: {
        blacklist?: any[];
        count?: number;
        longDistance?: boolean;
        radius?: number;
        size?: any;
        whitelist?: any;
    }
    - Optional blacklist?: any[]
    - Optional count?: number
    - Optional longDistance?: boolean
    - Optional radius?: number
    - Optional size?: any
    - Optional whitelist?: any
  Returns void

entities

entities: Record<string, Entity>

All of the entities

entityMaxId

entityMaxId: number

The current maximum ID (i.e. the last entity that was spawned has that id)

err

err: ((message) => void)

Logs a message as error

Type declaration

- (message): void
- Logs a message as error
  Parameters
  - message: any
  Returns void

getNearby

getNearby: ((params) => Player[])

Returns array of players within loc. loc is a required paramater. The object contains:

world: World position is in
position: Center position
radius: Distance from position

Type declaration

- (params): Player[]
- Returns array of players within loc. loc is a required paramater. The object contains:
  - world: World position is in
  - position: Center position
  - radius: Distance from position
  Parameters
  - params: {
        position: Vec3;
        radius?: number;
        world: CustomWorld;
    }
    - position: Vec3
    - Optional radius?: number
    - world: CustomWorld
  Returns Player[]

getNote

getNote: ((note) => number)

Get pitch. note should be between 0-24 and your output is from 0.5 to 2.0

Type declaration

- (note): number
- Get pitch. note should be between 0-24 and your output is from 0.5 to 2.0
  Parameters
  - note: any
  Returns number

getPlayer

getPlayer: ((username) => any)

Returns player object with that username or, if no such player is on the server, null.

Type declaration

- (username): any
- Returns player object with that username or, if no such player is on the server, null.
  Parameters
  - username: any
  Returns any

getUUIDFromUsername

getUUIDFromUsername: ((username) => Promise<string>)

Gets UUID from username. Since it needs to fetch from mojang servers, it is not immediate.

Arguments in format: callback(uuid). uuid is null if no such username exists.

Type declaration

- (username): Promise<string>
- Gets UUID from username. Since it needs to fetch from mojang servers, it is not immediate.
  
  Arguments in format: callback(uuid). uuid is null if no such username exists.
  Parameters
  - username: string
  Returns Promise<string>

info

info: ((message) => void)

Logs a message as info

Type declaration

- (message): void
- Logs a message as info
  Parameters
  - message: any
  Returns void

`Optional` levelData

levelData?: LevelDatFull

Parsed level.dat of the loaded world (only if worldFolder is specificed)

log

log: ((message) => void)

Logs a message

Type declaration

- (message): void
- Logs a message
  Parameters
  - message: any
  Returns void

mcData

mcData: IndexedData

netherworld

netherworld: CustomWorld

Contains the nether world. This WILL be used when a player travels through a portal if they are in the overworld!

notifyNeighborsOfStateChange

notifyNeighborsOfStateChange: ((world, pos, fromTick, tick, forceNotify?, data?) => void)

Similar to serv.updateBlock but will trigger an update on the 6 direct neighbors of pos but not on the block itself.

Type declaration

- (world, pos, fromTick, tick, forceNotify?, data?): void
- Similar to serv.updateBlock but will trigger an update on the 6 direct neighbors of pos but not on the block itself.
  Parameters
  - world: any
  - pos: any
  - fromTick: any
  - tick: any
  - Optional forceNotify: boolean
  - Optional data: null
  Returns void

notifyNeighborsOfStateChangeDirectional

notifyNeighborsOfStateChangeDirectional: ((world, pos, dir, fromTick, tick, forceNotify?, data?) => void)

Similar to serv.updateBlock but will trigger an update on 5 of the direct neighbors of pos.plus(dir), but not on the block at pos or pos.plus(dir).

Type declaration

- (world, pos, dir, fromTick, tick, forceNotify?, data?): void
- Similar to serv.updateBlock but will trigger an update on 5 of the direct neighbors of pos.plus(dir), but not on the block at pos or pos.plus(dir).
  Parameters
  - world: any
  - pos: any
  - dir: any
  - fromTick: any
  - tick: any
  - Optional forceNotify: boolean
  - Optional data: null
  Returns void

onBlockInteraction

onBlockInteraction: ((name, handler) => void)

The argument given to the handler is an object containing the clicked block and the player. It should return true if the block interaction occurred and the block placement should be cancelled.

Type declaration

- (name, handler): void
- Register a handler that will be called when a player interact with a block of type name.
  
  The argument given to the handler is an object containing the clicked block and the player. It should return true if the block interaction occurred and the block placement should be cancelled.
  Parameters
  - name: any
  - handler: any
  Returns void

onBlockUpdate

onBlockUpdate: ((name, handler) => void)

Register a handler that will be called when a block of the type name is updated. It should verify that the block state is still correct according to the game's rules. It is triggered when a neighboring block has been modified.

The arguments of the handler are the world in which the update occurred, the block, fromTick the tick at which the update was triggered, the tick the update was scheduled to (current tick), and optional data (null most of the time) that can be used to transmit data between block updates. The handler should return true if the block was changed so the update manager can send a multiBlockChange packet for all the changes that occurred within the tick. The state of the block should be modified by using the world's setBlockXXX functions instead of serv.setBlock (that would send redundant updates to players).

Type declaration

- (name, handler): void
- Register a handler that will be called when a block of the type name is updated. It should verify that the block state is still correct according to the game's rules. It is triggered when a neighboring block has been modified.
  
  The arguments of the handler are the world in which the update occurred, the block, fromTick the tick at which the update was triggered, the tick the update was scheduled to (current tick), and optional data (null most of the time) that can be used to transmit data between block updates. The handler should return true if the block was changed so the update manager can send a multiBlockChange packet for all the changes that occurred within the tick. The state of the block should be modified by using the world's setBlockXXX functions instead of serv.setBlock (that would send redundant updates to players).
  Parameters
  - name: any
  - handler: any
  Returns void

onItemPlace

onItemPlace: ((name, handler, warn?) => void)

The argument given to the handler is an object containing the held item that triggered the event, the direction (face) on which the player clicked, the angle of the player around the placed block. It should return an object containing the id and data of the block to place.

Type declaration

- (name, handler, warn?): void
- Register a handler that will be called when an item of type name is called to place a block.
  
  The argument given to the handler is an object containing the held item that triggered the event, the direction (face) on which the player clicked, the angle of the player around the placed block. It should return an object containing the id and data of the block to place.
  Parameters
  - name: any
  - handler: any
  - Optional warn: boolean
  Returns void

overworld

overworld: CustomWorld

Contains the overworld world. This is where the default spawn point is

pardonUsername

pardonUsername: ((username) => Promise<boolean>)

Pardons a player given a username.

Type declaration

- (username): Promise<boolean>
- Pardons a player given a username.
  Parameters
  - username: string
  Returns Promise<boolean>

playNoteBlock

playNoteBlock: ((pitch, world, position, __namedParameters?) => void)

Plays noteblock in world at position. pitch is from 0-24

Type declaration

- (pitch, world, position, __namedParameters?): void
- Plays noteblock in world at position. pitch is from 0-24
  Parameters
  - pitch: any
  - world: any
  - position: any
  - Optional __namedParameters: {
    instrument?: string;
    particle?: boolean;
    }
    - Optional instrument?: string
    - Optional particle?: boolean
  Returns void

playSound

playSound: ((sound, world, position, __namedParameters?) => void)

Plays sound (string, google "minecraft sound list") to all players in opt.radius. If position is null, will play at the location of every player (taking into account whitelist and blacklist).

Opt:

whitelist: Array of players that can hear the sound (can be a player object)
blacklist: Array of players who cannot hear the sound
radius: Radius that sound can be heard (in fixed position so remember to multiply by 32, default 32*32)
volume: float from 0-1 (default 1.0)
pitch: float from 0.5 to 2 (default 1.0)

Type declaration

- (sound, world, position, __namedParameters?): void
- Plays sound (string, google "minecraft sound list") to all players in opt.radius. If position is null, will play at the location of every player (taking into account whitelist and blacklist).
  
  Opt:
  - whitelist: Array of players that can hear the sound (can be a player object)
  - blacklist: Array of players who cannot hear the sound
  - radius: Radius that sound can be heard (in fixed position so remember to multiply by 32, default 32*32)
  - volume: float from 0-1 (default 1.0)
  - pitch: float from 0.5 to 2 (default 1.0)
  Parameters
  - sound: any
  - world: any
  - position: any
  - Optional __namedParameters: {
        blacklist?: any[];
        pitch?: number;
        radius?: number;
        soundCategory?: number;
        volume?: number;
        whitelist?: any;
    }
    - Optional blacklist?: any[]
    - Optional pitch?: number
    - Optional radius?: number
    - Optional soundCategory?: number
    - Optional volume?: number
    - Optional whitelist?: any
  Returns void

players

players: Player[]

An array of players currently logged in

plugins

plugins: {}

List of all plugins. Use serv.plugins[pluginName] to get a plugin's object and data.

Type declaration

pluginsReady

pluginsReady: boolean

selectorString

selectorString: ((str, pos?, world?, allowUser?, ctxEntityId?) => Entity[])

Returns an array of entities that satisfies the given command selector string str, execution position pos, execution world world, and the ID of the entity that initiated the execution ctxEntityId.

Valid selector string values are names of online players and valid target selector variables.

Setting allowUser to true (default value) enables players to be included in the returned array, disables otherwise.

Type declaration

- (str, pos?, world?, allowUser?, ctxEntityId?): Entity[]
- Returns an array of entities that satisfies the given command selector string str, execution position pos, execution world world, and the ID of the entity that initiated the execution ctxEntityId.
  
  Valid selector string values are names of online players and valid target selector variables.
  
  Setting allowUser to true (default value) enables players to be included in the returned array, disables otherwise.
  Parameters
  - str: string
  - Optional pos: Vec3
  - Optional world: any
  - Optional allowUser: boolean
  - Optional ctxEntityId: any
  Returns Entity[]

setBlock

setBlock: ((world, position, stateId) => Promise<void>)

Saves block in world and sends block update to all players of the same world.

Type declaration

- (world, position, stateId): Promise<void>
- Saves block in world and sends block update to all players of the same world.
  Parameters
  - world: CustomWorld
  - position: Vec3
  - stateId: number
  Returns Promise<void>

setBlockAction

setBlockAction: ((world, position, actionId, actionParam) => Promise<void>)

Sends a block action to all players of the same world.

Type declaration

- (world, position, actionId, actionParam): Promise<void>
- Sends a block action to all players of the same world.
  Parameters
  - world: CustomWorld
  - position: Vec3
  - actionId: number
  - actionParam: any
  Returns Promise<void>

setTickInterval

setTickInterval: ((ticksPerSecond) => void)

Resets tick interval to occur ticksPerSecond times per second.

Use stopTickInterval server.stopTickInterval() if you want but this method already calls that and you can use serv.doDaylightCycle to stop it anyway.

Type declaration

- (ticksPerSecond): void
- Resets tick interval to occur ticksPerSecond times per second.
  
  Use stopTickInterval server.stopTickInterval() if you want but this method already calls that and you can use serv.doDaylightCycle to stop it anyway.
  Parameters
  - ticksPerSecond: any
  Returns void

setTime

setTime: ((time) => void)

Set daylight cycle time in ticks. See serv.time for more info.

Type declaration

- (time): void
- Set daylight cycle time in ticks. See serv.time for more info.
  Parameters
  - time: any
  Returns void

`Optional` spawnPoint

spawnPoint?: Vec3

Global spawn and respawn point for every player

supportFeature

supportFeature: ((feature) => boolean)

Type declaration

- (feature): boolean
- Parameters
  - feature: string
  Returns boolean

tabComplete

tabComplete: {
    add: ((id, cb) => void);
    types: any[];
    use: ((id, otherData?, existingContent?) => void);
}

serv.tabComplete has types and tab completition function

You can provide your types:

serv.tabComplete.add('tabId', () => {
  return ['some', 'values', 'in array', 'ONLY STRINGS!']
})

Type declaration

add: ((id, cb) => void)
- - (id, cb): void
  - Parameters
    - id: any
    - cb: any
    Returns void
types: any[]
use: ((id, otherData?, existingContent?) => void)
- - (id, otherData?, existingContent?): void
  - Parameters
    - id: any
    - Optional otherData: null
    - Optional existingContent: string
    Returns void

tickCount

tickCount: number

Total number of ticks that have passed since the start of the world. Best to use with modulo (e.g. Something every 10 seconds is serv.tickCount % 20*10 === 0)

time

time: number

Current daylight cycle time in ticks. Morning is 0, noon is 6000, evening is 12000, and night is 18000. Resets to 0 at 24000. Use serv.setTime(time) to set the time.

updateBlock

updateBlock: ((world, pos, fromTick, tick, forceNotify?, data?) => void)

Trigger a block update for the block in world at pos. fromTick is the current server tick serv.tickCount, tick is the future server tick when the update should be executed. When forceNotify is true, the block update will always trigger an update on the 6 direct neighbors, even when no handler is registered for this block type. data is an optional object that will be given to the handler.

Type declaration

- (world, pos, fromTick, tick, forceNotify?, data?): void
- Trigger a block update for the block in world at pos. fromTick is the current server tick serv.tickCount, tick is the future server tick when the update should be executed. When forceNotify is true, the block update will always trigger an update on the 6 direct neighbors, even when no handler is registered for this block type. data is an optional object that will be given to the handler.
  Parameters
  - world: any
  - pos: any
  - fromTick: any
  - tick: any
  - Optional forceNotify: boolean
  - Optional data: null
  Returns void

uuidToPlayer

uuidToPlayer: {}

Object for converting UUIDs to players

Type declaration

warn

warn: ((message) => void)

Logs a message as warning

Type declaration

- (message): void
- Logs a message as warning
  Parameters
  - message: any
  Returns void

Methods

addListener

addListener<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.addListener
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:24

emit

emit<E>(event, ...args): boolean
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- Rest ...args: Arguments<ServerEvents[E]>
Returns boolean
Inherited from Server.emit
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:34

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from Server.eventNames
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:35

formatMessage

formatMessage(message): any
You can override this function so you can process the message before sending it to the console.
Parameters
- message: any
Returns any
Inherited from Server.formatMessage
- Defined in Documents/repos/space-squid-2/src/lib/modules/log.ts:123

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Server.getMaxListeners
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:40

listenerCount

listenerCount<E>(event): number
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
Returns number
Inherited from Server.listenerCount
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:38

listeners

listeners<E>(event): Function[]
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
Returns Function[]
Inherited from Server.listeners
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:37

off

off<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.off
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:30

on

on<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.on
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:25

once

once<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.once
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:26

prependListener

prependListener<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.prependListener
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:27

prependOnceListener

prependOnceListener<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.prependOnceListener
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:28

rawListeners

rawListeners<E>(event): Function[]
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
Returns Function[]
Inherited from Server.rawListeners
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:36

removeAllListeners

removeAllListeners<E>(event?): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- Optional event: E
Returns this
Inherited from Server.removeAllListeners
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:31

removeListener

removeListener<E>(event, listener): this
Type Parameters
- E extends keyof ServerEvents
Parameters
- event: E
- listener: ServerEvents[E]
Returns this
Inherited from Server.removeListener
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:32

setMaxListeners

setMaxListeners(maxListeners): this
Parameters
- maxListeners: number
Returns this
Inherited from Server.setMaxListeners
- Defined in Documents/repos/space-squid-2/node_modules/typed-emitter/index.d.ts:41

Interface FullServer

Hierarchy

Index

Properties

Methods

Properties

_server

ban

Type declaration

Parameters

uuid: string

Optional reason: string

Returns Promise<boolean>

banUsername

Type declaration

Parameters

username: string

reason: string

Returns Promise<boolean>

bannedPlayers

Type declaration

behavior

Type declaration

Parameters

eventName: string

Optional data: any

Optional func: Function

Optional cancelFunc: Function

Returns Promise<any>

broadcast

Type declaration

Parameters

message: any

Optional opt: { blacklist?: any[]; system?: boolean; whitelist?: any; }

Optional blacklist?: any[]

Optional system?: boolean

Optional whitelist?: any

Returns void

commands

createLog

Type declaration

Returns void

doDaylightCycle

emitParticle

Type declaration

Parameters

particle: any

world: any

position: any

Optional __namedParameters: { blacklist?: any[]; count?: number; longDistance?: boolean; radius?: number; size?: any; whitelist?: any; }

Optional blacklist?: any[]

Optional count?: number

Optional longDistance?: boolean

Optional radius?: number

Optional size?: any

Optional whitelist?: any

Returns void

entities

entityMaxId

err

Type declaration

Parameters

message: any

Returns void

getNearby

Type declaration

Parameters

params: { position: Vec3; radius?: number; world: CustomWorld; }

position: Vec3

Optional radius?: number

world: CustomWorld

Returns Player[]

getNote

Type declaration

Parameters

note: any

Returns number

getPlayer

Type declaration

Parameters

`Optional` reason: string

`Optional` data: any

`Optional` func: Function

`Optional` cancelFunc: Function

`Optional` opt: {
blacklist?: any[];
system?: boolean;
whitelist?: any;
}

`Optional` blacklist?: any[]

`Optional` system?: boolean

`Optional` whitelist?: any

`Optional` __namedParameters: {
blacklist?: any[];
count?: number;
longDistance?: boolean;
radius?: number;
size?: any;
whitelist?: any;
}

`Optional` blacklist?: any[]

`Optional` count?: number

`Optional` longDistance?: boolean

`Optional` radius?: number

`Optional` size?: any

`Optional` whitelist?: any

params: {
position: Vec3;
radius?: number;
world: CustomWorld;
}

`Optional` radius?: number

`Optional` levelData

`Optional` forceNotify: boolean

`Optional` data: null

`Optional` forceNotify: boolean

`Optional` data: null

`Optional` warn: boolean