code/api関数 - bloxd.io atwiki

このページについて

このページではapi関数をgithubに乗っている順番通り載せていきます

値の種類について

• 数値:number

-1,0,1,2,3といった整数、1.3,1.44といった小数などの数字

• 文字列:string

"Hello World!!"のように""で括られた文字列

• 真偽値:boolean

true(はい) または false(いいえ) の2択
if文(もし〜なら文)でよく使われる

• 配列:array

[1,"hoge",true]のようにデータがまとめてある形式
プログラミングでは0番目,1番目...と数えていくルールがある
(この場合0番目が1というデータになり1番目が"hoge"というデータになる)

• オブジェクト:object

{"田中":23,"中田":54}のようにデータにラベルをつけてまとめたセット
配列では0番目を呼ぶとその要素が取れたが、この場合"田中"を呼ぶと23という要素が取れる

• null

何も無いことを明示するもの
プレゼント交換で空き箱を渡されたのがnull

• undefined

無ということ
プレゼント交換で手ぶらで来た人みたいな感じ

凡例

api.hoge()
引	引数の説明
返	返り値の説明
機	機能の説明
使	使い方の説明

一覧

api.getPosition(eId)
引	eId : 位置を取得したいエンティティのID
返	エンティティの座標が[x,y,z]の配列で返される
機	エンティティの座標の取得
使	範囲内にいるかを特定するなど使い方は多岐に及ぶ

api.setPosition(eId,x,y,z)
引	eId : 位置を設定したいエンティティのID x,y,z : 移動先の位置　これは[x,y,z]のように配列の状態で渡すこともできる
返	なし
機	エンティティの座標を設定 エンティティを特定の座標に移動させる
使	"ランダムTP"などはこれを使って作られている

api.getPlayerIds()
引	なし
返	ロビーに居るプレイヤー全員のpIdの入った配列
機	ロビーにいる全員のpIdの取得
使	for..of文を使えばロビー全員に対して処理ができる

api.playerIsInGame(pId)
引	pId : 調べたいプレイヤーのID
返	真偽値
機	そのpIdを持つプレイヤーが今ロビーに居るかどうかを調べる
使	あるプレイヤーに対して処理を行う際 これで退出していないかどうか調べられる

api.playerIsLoggedIn(pId)
引	pId : 調べたいプレイヤーのID
返	真偽値
機	そのpIdを持つプレイヤーがログインしているか調べる
使	特になし

api.getPlayerPartyWhenJoined(pId)
引	pId : 調べたいプレイヤーのID
返	そのプレイヤーが入室時にパーティに属していなければNull 属していれば、{"playerDbIds":[]}というオブジェクトが返ってくる 配列の中身はパーティのメンバーのDbId、配列の最初の要素がパーティ主のDbIdである
機	入室時のパーティの情報を調べる 入室後に別の人がパーティに参加してもそれは反映されない
使	特になし

api.getNumPlayers()
引	なし
返	ロビーにいる人の人数(Number)
機	現在ロビーにいる人数を取得
使	ロビーの人数を伝える

api.getBlockCoordinatesPlayerStandingOn(pId)
引	pId : 調べたいプレイヤーのID
返	プレイヤーが立っているブロックの座標の配列 [[x,y,z],[x,y,z],[x,y,z],[x,y,z]]という形式で渡される 空中にいる場合、空の配列が渡される マグマや水などの流体ブロックは含まない
機	足元のブロックの座標を取得
使	プレイヤーの足元を調べる

api.getBlockTypesPlayerStandingOn(pId)
引	pId : 調べたいプレイヤーのID
返	プレイヤーが立っているブロックの名前の配列 ["Dirt","Dirt"]という形式で渡される 空中にいる場合、空の配列が渡される マグマや水などの流体ブロックは含まない
機	足元のブロックの種類を取得
使	プレイヤーの足元を調べる

api.getUnitCoordinatesLifeformWithin(lId)
引	lId : 調べたい生物のID
返	生物の当たり判定を配列にしたもの。 基本的にプレイヤーや豚などの多くの生物では8個の座標配列が ゴーレムなどの大型生物では12個の座標配列が返される。
機	当たり判定を取得
使	特になし

api.showShopTutorial(pId)
引	pId : チュートリアルを表示させたいプレイヤーのID
返	なし
機	対象のプレイヤーにショップチュートリアル(ショップのボタンを指差すマーク)を表示する ただし、そのプレイヤーが過去にショップを開いていると表示されない
使	特になし

api.getShieldAmount(eId)
引	eId :調べたいエンティティのID
返	そのエンティティが持つシールドの量(Number)
機	対象のエンティティが持つシールドの量を取得する
使	シールド量を調べる

api.setShieldAmount(lId, newShieldAmount)
引	lId : シールドを設定したい生物のID(HPの存在しないクリエイティブのプレイヤーなどは不可) newShieldAmount : 設定するシールドの量
返	なし
機	対象の生物にシールドを設定する
使	シールドを与えたり剥がしたりする

api.getHealth(eId)
引	eId : 調べたいエンティティのID ボートなどのエンティティを指定するとApiErrorが出るので注意
返	エンティティの体力(Number) クリエイティブのプレイヤーなどのHPが存在しないエンティティはnullと出る
機	対象のエンティティの体力を調べる
使	体力を調べてそれに応じた処理を行うことなどが可能

api.applyHealthChange(lId, changeAmount, who, broadcast)
引	lId : 体力を変更させたい生物のID changeAmount : 変化量(Number) -以下はオプション who : 誰がその変更を行ったか、また、その時の道具は何か -誰かだけを指定する場合 : その生物のID(lId) -両方指定する場合 : {lifeformId: 生物のID, withItem: アイテム名(String)} broadcast : その変化を対象に伝えるかどうか(真偽値) -具体的に言うと負の変化の際にダメージモーションを与えるか否か -指定しないと勝手にtrueになる
返	体力を変更したエンティティが死んだか否か(真偽値)
機	対象の生物の体力を変化させる
使	プレイヤーにダメージを与えたり回復させたりできる

api.setHealth(eId,nHp,whoDid,incMax)
引	eId : 設定したいエンティティのID nHp：設定するHPの量 -以下はオプション whoDid：誰によって行われたか、 -lId単体または{lifeformId:lId,withItem:"アイテム名"}のようにすることで、誰が何でHPを設定したか決められる incMax：HPが最大HPを超える場合、最大値も上げるかどうか(真偽値)
返	その生物が死んだか(真偽値)
機	対象のエンティティの体力を設定する
使	ゲームの開始時などで、体力を調整できる