bukkit-openhab-client
NodeJs client for the Minecraft bukkit-openhab-plugin
Installation
npm install bukkit-openhab-client
Example
Receiving messages
const OH = ; let client = OH; client; client; client;
Sending commands
const connect CommandType = ; let client = ; client;
API
OH.connect(host, [options])
Connect to a server specified by the given url and returns the Client
The arguments are:
host
: bukkit server hostoptions
reconnect
: attempt reconnect, default =true
reconnectInterval
: the interval to try a reconnect, default =6000
maxReconnect
: maximum reconnection attempts
OH.Client(host, [options])
Accepts the same arguments as described in the connect function
'connect'
Event function () {}
Emitted on successful (re)connection
'close'
Event function (code) {}
Emitted after a disconnection.
code
disconnection status code
'reconnect'
Event function () {}
Emitted when a reconnect starts.
'message'
Event function (message) {}
Emitted when the client receives a message
message
messageType
number indicating the type of the messagemessage
the message content
'player'
Event function (message) {}
Emitted when the client receives a player message
example player message:
displayName: 'welteki' name: 'welteki' level: 0 totalExperience: 0 experience: 00 health: 13333335876464844 healthScale: 200 walkSpeed: 02 location: x: 37454182933731164 y: 740 z: 2628878343833861 pitch: 18899847 yaw: 14369923 gameMode: 'CREATIVE' ;
'sign'
Event function (message) {}
Emitted when the client receives a sign message
example sign message:
name: 'Foo' state: true location: x: 3720 y: 750 z: 2600 pitch: 00 yaw: 00 ;
'server'
Event function (message) {}
Emitted when the client receives a server message
example server message:
name: 'CraftBukkit' version: 'git-Spigot-549c1fa-2ee49b4 (MC: 1.12.2)' bukkitVersion: '1.12.2-R0.1-SNAPSHOT' maxPlayers: 20 players: 1
OH.Client#close()
Close websocket connection to the server
OH.Client#send(commandType, commandArgs)
Send a command to the server
Command type: CommandType.PLAYER_HEALTH
commandArgs
playerName
name of the player to execute the command onhealth
number indicating the desired health level
Command type: CommandType.PLAYER_WALKSPEED
commandArgs
playerName
name of the player to execute the command onwalkspeed
number indicating the desired walkspeed
Command type: CommandType.PLAYER_LEVEL
commandArgs
playerName
name of the player to execute the command onlevel
: number indicating the desired level
Command type: CommandType.PLAYER_GAMEMODE
commandArgs
playerName
name of the player to execute the command ongameMode
the desired game mode: CREATIVE, SURVIVAL, ADVENTURE, SPECTATOR
Command type: CommandType.PLAYER_LOCATION
commandArgs
playerName
name of the player to execute the command onlocation
location string
Command type: CommandType.SIGN_STATE
commandArgs
signName
name of the signstate
boolean indicating the desired state