Crab (API)

From 8x9craft
Jump to: navigation, search

CrabAPIを使えば、はっくんをマインクラフトの世界で移動させたり石を置いたりすることができます。

Crabオブジェクトは、グローバル空間に定義してあり、crabプロパティを使ってアクセスできます。

次はCrabAPIの使用例です。

// はっくんを前に移動させる
crab.forward();

// はっくんに石を置いてもらう
crab.place(1)

プロパティ

表示の意味: プロパティーの名前 : プロパティーの型


プロパティ名/返り値 説明
name: string はっくんの名前をつかうことができます。
facing: Facing crabの向きを取得します。
position: BlockPos crabの位置を取得します。

メソッド

表示の意味: メソッドの名前 : メソッドの戻り値の型


はっくんの移動

メソッド名/返り値 説明
forward(): boolean crabが前に移動します。
back(): boolean crabが後ろに移動します。
up(): boolean crabが上に移動します。
down(): boolean crabが下に移動します。
turnLeft(): boolean crabが左を向きます。
turnRight(): boolean crabが右を向きます。
stepLeft(): boolean crabが左に移動します。
stepRight(): boolean crabが右に移動します。
teleport(name: string): boolean crabがマークした場所に戻ります。
mark(name: string): boolean 新しくマークを設定します。
delMark(name: string): boolean マークを削除します

ワールドとの対話

メソッド名/返り値 説明
isBlocked(): boolean crabが前に移動できるか確認します。
isBlockedUp(): boolean crabが上に移動できるか確認します。
isBlockedDown(): boolean crabが下に移動できるか確認します。
place(

item: string or number or ItemInfo, meta?: number): boolean

crabの前にブロックを置きます。
placeUp(item: string or number or ItemInfo, meta?: number): boolean crabの上にブロックを置きます。
placeDown(item: string or number or ItemInfo, meta?: number): boolean crabの下にブロックを置きます。
dig(): Item crabの前のブロックを掘ったり/壊したりします。
digUp(): Item crabの上のブロックを掘ったり/壊したりします。
digDown(): Item crabの下のブロックを掘ったり/壊したりします。
use(): boolean crabの前のブロックにプレイヤーが右クリックしたのと同じ動作をします。
useUp(): boolean crabの上のブロックにプレイヤーが右クリックしたのと同じ動作をします。
useDown(): boolean crabの下のブロックにプレイヤーが右クリックしたのと同じ動作をします。
useOffHand(): boolean crabの前のブロックにプレイヤーが右クリックしたのと同じ動作をすぐにします。
useOffHandUp(): boolean crabの上のブロックにプレイヤーが右クリックしたのと同じ動作をすぐにします。
useOffHandDown(): boolean crabの下のブロックにプレイヤーが右クリックしたのと同じ動作をすぐにします。
attack(): boolean crabの前にいるmobに攻撃します。
attackUp(): boolean crabの上にいるmobに攻撃します。
attackDown(): boolean crabの下にいるmobに攻撃します。
attackOffHand(): boolean crabの前にいるmobにすぐ攻撃します。
attackOffHandUp(): boolean crabの上にいるmobにすぐ攻撃します。
attackOffHandDown(): boolean crabの下にいるmobにすぐ攻撃します。
sweep(): boolean crabの周りにあるアイテムを拾います。
take(item: string or number or ItemInfo, meta?: number, count?: number): boolean crabの前にあるチェストからアイテムを取ります。
takeUp(item: string or number or ItemInfo, meta?: number, count?: number): boolean crabの上にあるチェストからアイテムを取ります。
takeDown(item: string or number or ItemInfo, meta?: number, count?: number): boolean crabの下にあるチェストからアイテムを取ります。
put(item: string or number or ItemInfo, meta?: number, count?: number): boolean crabの持ち物にあるアイテムを前の地面に置くか、チェストに入れます。
putUp(item: string or number or ItemInfo, meta?: number, count?: number): boolean crabの持ち物にあるアイテムを上に置くか、チェストに入れます。
putDown(item: string or number or ItemInfo, meta?: number, count?: number): boolean crabの持ち物にあるアイテムを下に置くか、チェストに入れます。
setRedStoneOutput(side: string, level: number): boolean 指定された強さでレッドストーン信号をセットするかリセットします。(強さは正数で指定)
getRedStoneInput(side: string): number レッドストーン信号の強さを取得します。
flick(): boolean 目の前のブロックをくるっと回転させる。
flickUp(): boolean 上のブロックをくるっと回転させる。
flickDown(): boolean 下のブロックをくるっと回転させる。

ワールドの情報を取得する

メソッド名/返り値 説明
inspect(): BlockState crabの前のブロックについて調べる。そしてそのブロックの情報を取得します。
inspectUp(): BlockState crabの上のブロックについての情報を取得します。
inspectDown(): BlockState crabの下のブロックについての情報を取得します。
scan(): BlockState[] crabの前の9ブロックについて調べる。そしてそのブロックの情報を取得します。
scanUp(): BlockState[] crabの上の9ブロックについての情報を取得します。
scanDown(): BlockState[] crabの下の9ブロックについての情報を取得します。

クラフト / インベントリ

メソッド名/返り値 説明
grabLeft(item: string or number or ItemStack, meta?: number): boolean crabの持ち物からアイテムを選んで、crabの左手に持たせます。
grabRight(item: string or number or ItemStack, meta?: number): boolean crabの持ち物からアイテムを選んで、crabの右手に持たせます。
swap(firstSlot: number, secondSlot: number): boolean crabの持ち物を入れ替えます。
craft(item: string or number, meta: number): ItemInfo 新しいアイテムを作ります。
itemAt(slot: number): ItemInfo 持ち物スロットのアイテムについて情報を取得します。
itemCount(item: string or number, meta: number): number crabの持ち物の全てのアイテムの数を取得します。
itemSlotCount(slot: number): number crabの持ち物スロットにあるアイテムの数を取得します。
eat(itemId: Number, meta: Number): boolean 持っているものを食べます。食べることで別のはっくんに変わることができます。
summon(entityName: string): void 指定された名前のモブを召喚します

その他

メソッド名/返り値 説明
say(message: string): boolean はっくんにしゃべらせます
sleep(sec: Number): boolean crabをsec秒だけスリープさせます。(プログラムの実行を止めます)
setCreative(b: boolean): boolean はっくんのモードを設定します。
getOwner(): Player はっくんの持ち主を返します

イベント / プログラムの実行

メソッド名/返り値 説明
onChat(callback: Function): void 近くのプレイヤーからのチャットメッセージを受けるたびにcallbackが実行されます。
onBlock(callback: Function): void crabの近くのブロックが変化するたびにcallbackが実行されます。
onRedstone(callback: Function): void レッドストーン信号のパワーレベルが変化するたびにcallbackが実行されます。
on(msgType: string, callback: Function): void callbackが実行されます。
emit(msgType: string, ...args: any[]): void crabにカスタムメッセージを送信します。
broadcast(msgType: string, ...args: any[]): void プログラムを実行している全てのcrabにカスタムメッセージを送信します。
waitForChat(): ChatLog crabはプログラムの実行を一時停止して、プレイヤーからのチャットメッセージを待ちます。
受信したメッセージを返します。
waitForChat(player: Player): ChatLog crabはプログラムの実行を一時停止して、プレイヤーからのチャットメッセージを待ちます。
受信したメッセージを返します。
waitForBlock(): BlockState crabはブロックの変化を待ちます。
変化のあったブロックの場所を返します。
waitForBlock(side: string): BlockState crabはブロックの変化を待ちます。
変化のあったブロックの場所を返します。
waitForRedstone(): RedstoneChanged crabはレッドストーン信号の強さが変わるのを待ちます。
新しいレッドストーン信号の強さを返します。
waitForRedstone(side: string): RedstoneChanged crabはレッドストーン信号の強さが変わるのを待ちます。
新しいレッドストーン信号の強さを返します。
waitFor(msgType: string, ...args: any[]): object crabは指定されたイベントタイプのメッセージを待ちます。
指定されたイベントタイプに適したデータを持つオブジェクトを返します。