flying-squid/doc/api.md

Table of Contents generated with DocToc

• API
  • Classes
    • CraftyJS.Entity
      • entity.id
      • entity.type
      • entity.username
      • entity.mobType
      • entity.displayName
      • entity.entityType
      • entity.kind
      • entity.name
      • entity.objectType
      • entity.count
      • entity.position
      • entity.velocity
      • entity.yaw
      • entity.pitch
      • entity.height
      • entity.onGround
      • entity.equipment[5]
      • entity.heldItem
      • entity.metadata
      • entity.health
      • entity.food
      • entity.player
  • MCServer
    • CraftyJS.createMCServer(options)
    • Properties
      • serv.entityMaxId
      • serv.players
      • serv.uuidToPlayer
      • serv.world
      • serv.entities
    • Events
      • "error" (error)
      • "listening" (port)
      • "newPlayer" (player)
    • Methods
      • serv.createLog()
      • serv.log(message)
      • serv.broadcast(message[,color])
  • Player
    • Properties
      • player.entity
      • player.username
    • Events
      • "connected"
      • "spawned"
      • "disconnected"
      • "error" (error)
      • "chat" (message)
    • Methods
      • player.login()
      • player.others()
      • player.chat(message)
      • player.changeBlock(position,blockType)
      • player.sendInitialPosition()
      • player.spawn()
      • player.setGameMode(gameMode)
      • player.handleCommand(command)
      • player.updateHealth(health)
    • Low level properties
      • player._client
    • Low level methods
      • player._writeOthers(packetName, packetFields)

API

Classes

CraftyJS.Entity

Entities represent players, mobs, and objects. They are emitted in many events, and you can access your own entity with bot.entity.

entity.id

entity.type

Choices:

• player
• mob
• object
• global - lightning
• orb - experience orb.
• other - introduced with a recent Minecraft update and not yet recognized or used by a third-party mod

entity.username

If the entity type is player, this field will be set.

entity.mobType

If the entity type is mob, this field will be set.

entity.displayName

Field set for mob and object. A long name in multiple words.

entity.entityType

Field set for mob and object. The numerical type of the entity (1,2,...)

entity.kind

Field set for mob and object. The kind of entity (for example Hostile mobs, Passive mobs, NPCs).

entity.name

Field set for mob and object. A short name for the entity.

entity.objectType

If the entity type is object, this field will be set.

entity.count

If the entity type is orb, this field will be how much experience you get from collecting the orb.

entity.position

entity.velocity

entity.yaw

entity.pitch

entity.height

entity.onGround

entity.equipment[5]

• 0 - held item
• 1 - shoes
• 2 - legging
• 3 - torso
• 4 - head

entity.heldItem

Equivalent to entity.equipment[0].

entity.metadata

See http://wiki.vg/Entities#Entity_Metadata_Format for more details.

entity.health

The health of the player, default: 20

entity.food

The food of the player, default: 20

entity.player

The player

MCServer

CraftyJS.createMCServer(options)

Create and return an instance of the class MCServer.

options is an object containing the settings

Properties

serv.entityMaxId

Current maximum entity id

serv.players

Array of connected players

serv.uuidToPlayer

Object uuid to players

serv.world

The map

serv.entities

All of the entities

Events

"error" (error)

Fires when there is an error.

"listening" (port)

Fires when the server is listening.

"newPlayer" (player)

Fires when player login, allow external player plugins.

Methods

serv.createLog()

creates the log file

serv.log(message)

logs a message

serv.broadcast(message[,color])

broadcasts message to all the players with the optional color.

Player

Properties

player.entity

The entity of the player, of type CraftyJS.Entity

player.username

The username of the player

Events

"connected"

Fires when the player is connected

"spawned"

Fires when the player is spawned

"disconnected"

Fires when the player disconnected

"error" (error)

Fires when there is an error.

"chat" (message)

Fires when the player says message.

Methods

player.login()

login

player.others()

return the other players than player

player.chat(message)

sends message to the player

player.changeBlock(position,blockType)

change the block at position position to blockType

player.sendInitialPosition()

send its initial position to the player

player.spawn()

tell everybody else that the player spawned

player.setGameMode(gameMode)

set player gameMode to gameMode

player.handleCommand(command)

handle command

player.updateHealth(health)

update the player health.

Low level properties

player._client

The internal implementation to communicate with a client

Low level methods

player._writeOthers(packetName, packetFields)

write to other players than player the packet packetName with fields packetFields