使い方

Tweet

MouseClient APIガイド

MouseClientのAPI一覧です。

_init_

[説明]
コンストラクタ。APIキーを指定します。
[書式]
def _init(self, apikey, url="https://www.osumoi-stdio.com/maze/v1"):

[引数]
apikey
ダッシュボードから取得したAPIKEYを文字列で指定します。

url
デバッグ用。通常は指定しません。

[戻り値]
なし。

[例外]
なし。

start

[説明]
ゲームを開始します。startを実行することで実行結果が生成されます。
[書式]
def start(self, map_id):

[引数]
map_id
ダッシュボードに表示される迷路のIDを指定します。

[戻り値]
正常時、次のデータを辞書形式で返します。

[例外]
以下の場合にMouseErrorを例外で返します。

• APIキーに誤りがある
• map_idに誤りがある

ネットワークのエラーなどはExceptionで拾ってください。

sensor

[説明]
センサー情報を取得します。
[書式]
def sensor(self):

[引数]
なし

[戻り値]
3個のリストを返します。進行方向に対して[左の壁の有無,前の壁の有無,右の壁の有無]を返します。
壁がある場合は1,ない場合は0です。

[例外]
なし。ネットワークのエラーなどはExceptionで拾ってください。

turn_left

[説明]
左に90°回転します。
[書式]
def turn_left(self):

[引数]
なし

[戻り値]
正常時、次のデータを辞書形式で返します。

[例外]
以下の場合にMouseErrorを例外で返します。

• ステップオーバーした
• ターンオーバーした
• ゲームオーバー
• token不正
• すでにゴールしている

ネットワークのエラーなどはExceptionで拾ってください。

turn_right

[説明]
右に90°回転します。
[書式]
def turn_right(self):

[引数]
なし

[戻り値]
正常時、次のデータを辞書形式で返します。

[例外]
以下の場合にMouseErrorを例外で返します。

• ステップオーバーした
• ターンオーバーした
• ゲームオーバー
• token不正
• すでにゴールしている

ネットワークのエラーなどはExceptionで拾ってください。

go_straight

[説明]
2マス直進します。
[書式]
def go_straight(self):

[引数]
なし

[戻り値]
正常時、次のデータを辞書形式で返します。

[例外]
以下の場合にMouseErrorを例外で返します。

• ステップオーバーした
• ターンオーバーした
• ゲームオーバー
• token不正
• すでにゴールしている

ネットワークのエラーなどはExceptionで拾ってください。

is_goal

[説明]
ゴールのマスにいるかどうかを返します。
[書式]
def is_goal(self):

[引数]
なし

[戻り値]
ゴールのマスにいる場合、1を返します。
ゴールのマスにいない場合、0を返します。

[例外]
なし。

ネットワークのエラーなどはExceptionで拾ってください。

例外一覧