# 空間エージェント関数（移動）

## forward

前方へ進む。<br>正常終了のときは-1、空間がループしていないときで指定した距離を進めなかったときは、進めなかった距離を返す。

**forward**(distance)

- **distance** - 進む距離

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる<br>
※連続空間でのみ使用可能。

```
# 前方に2進む（空間エージェントのルールエディタ内に記述）
self.forward(2)
```

<!--

| 例外処理               | 引数の型チェック：ArtisocCloudTypeError   空間チェック：ArtisocCloudIllegalUseOfFunctionErrorr   →エージェントの属する空間が四角格子空間・六角格子空間だったときエラーを返す |
| ---------------------- | ------------------------------------------------------------ |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | Forward                                                      |
| artisoc4との差異       | 連続空間でのみ使用できる   （四角格子空間・六角格子空間で使用できない） |
| 動作条件               |                                                              |
| 備考                   | 四角格子空間で使えるようにすることは容易だが、ユーザのミスをなくすため使用不可とする  六角格子空間で違和感なく使えるようにするのは少したいへん（座標と表示位置が異なるため）   引数が負の場合は逆方向に進む（artisoc4でもそう） |

-->

## forward_direction_sqgrid

四角格子上を指定した方向へ移動する。<br>四角格子空間または連続空間で使用可能。

**forward_direction_sqgrid**(direction, distance)

- **direction** - 進む方向。
  - 原点が左下のとき　0:右、1:右上、2:上、3:左上、4:左、5:左下、6:下、7:右下 
  - 原点が左上のとき　0:右、1:右下、2:下、3:左下、4:左、5:左上、6:上、7:右上 
- **distance** - 進む距離。チェビシェフ距離で定義し、整数で指定する。

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる

```
# 右上に2進む（左下原点のとき、空間エージェントのルールエディタ内に記述）
self.forward_direction_sqgrid(1, 2)
```



<!--

| 例外処理               | 引数の型チェック：ArtisocCloudTypeError   →ただしfloat型の場合は小数点切り捨てたintの値を用いる   引数の値チェック：ArtisocCloudValueError   →値の範囲をチェックし、指定の範囲外ならエラー   空間チェック：ArtisocCloudSpaceFunctionError   →エージェントの属する空間が六角格子空間だったとき、エラーを返す |
| ---------------------- | ------------------------------------------------------------ |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | ForwardDirectionCell                                         |
| artisoc4との差異       | ForwardDirectionCellは四角格子・六角格子共用だったが、そこから四角格子空間の機能のみ取り出している  連続空間・四角格子空間でのみ使用できる  連続空間で使用された場合は内部で座標値を整数にキャストする   六角格子空間では使用できない   artisoc4では引数が不正なとき戻り値-2を返すが、エラーを返す（そのほうが親切だと思うので） |
| 動作条件               | 連続空間または四角格子空間                                   |
| 備考                   |                                                              |

-->

<!--

（六角格子は未実装）

| 関数名                 | forward_direction_hexgrid                                    |
| ---------------------- | ------------------------------------------------------------ |
| 引数                   | direction: 方向（int）   distance: 距離（int）               |
| 戻り値                 | 終了値 （正常終了時は-1、指定した距離を進めなかったときは進めなかった距離）（float） |
| 説明                   | 格子上を指定した方向へ移動する   方向    ＜原点が左下の場合＞   0:右、1:右上、2:左上、3:左、4:左下、5:右下    ＜原点が左上の場合＞    0:右、1:右下、2:左下、3:左、4:左上、5:右上 |
| 使用例                 |                                                              |
| 例外処理               | 引数の型チェック：ArtisocCloudTypeError   →ただしfloat型の場合は小数点切り捨てたintの値を用いる   引数の値チェック：ArtisocCloudValueError   →値の範囲をチェックし、指定の範囲外ならエラー   空間チェック：ArtisocCloudSpaceFunctionError   →エージェントの属する空間が連続空間や四角格子空間だったとき、エラーを返す |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | ForwardDirectionCell                                         |
| artisoc4との差異       | ForwardDirectionCellは四角格子・六角格子共用だったが、そこから四角格子空間の機能のみ取り出している  六角格子空間でのみ使用できる   （連続空間・四角格子空間では使用できない）   artisoc4では引数が不正なとき戻り値-2を返すが、エラーを返す（そのほうが親切だと思うので） |
| 動作条件               | 六角格子空間                                                 |
| 備考                   |                                                              |

-->

## move_center

エージェント自身が乗っている空間（Layer）の中央に移動する。<br>※格子空間で空間の幅（高さ）が偶数の場合、小数点切り捨て

**move_center**()

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる
```
# エージェント自身が50×50の空間に乗っている時(25,25)に移動
self.move_center()
```

<!--

| 例外処理               | なし                                                         |
| ---------------------- | ------------------------------------------------------------ |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | MoveToCenter                                                 |
| artisoc4との差異       | なし                                                         |
| 動作条件               |                                                              |
| 備考                   | 格子空間で空間の幅（高さ）が偶数の場合、小数点切り捨て  4×4の空間（                                                                      ）の中心は(1, 1)   toはいらないかなと（関数名長くなるし） |

-->

## move_space_around_own_sqgrid

四角格子空間で、指定した視野の範囲で空き地（格子）を探し、移動する。<br>検索された領域に複数の空き地が存在するときは、ランダムに移動位置を決定する。

**move_space_around_own_sqgrid**(view, avoid=None, manhattan=False)

- **view** - 視野。整数で指定する。
- **avoid** -  重ならないエージェント集合。初期値はNoneで、このときは全てのエージェントと重ならない。
- **manhattan**: Falseのときは視野をチェビシェフ距離で、Trueのときはマンハッタン距離で定義する。初期値はFalse。

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる

```
# （以下、空間エージェントのルールエディタ内に記述）

# チェビシェフ距離で視野2の範囲の格子のうち、エージェントが誰もいない場所へランダムに移動する
self.move_space_around_own_sqgrid(2)

# チェビシェフ距離で視野3の範囲の格子のうち、集合enemiesに含まれるエージェントが誰もいない場所へランダムに移動する
self.move_space_around_own_sqgrid(3, avoid=enemies)

# マンハッタン距離で視野3の範囲の格子のうち、集合enemiesに含まれるエージェントが誰もいない場所へランダムに移動する
self.move_space_around_own_sqgrid(3, avoid=enemies, manhattan=True)
```



<!--

| 例外処理               | なし（move_space_around_position_cellに委譲する）   ※その際、関数名と引数の番号についての情報を渡し、この関数のエラーメッセージとして出力するようにする工夫が必要） |
| ---------------------- | ------------------------------------------------------------ |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | MoveToSpaceOwnCell                                           |
| artisoc4との差異       | 重ならないエージェント集合を指定できる  関数名  四角格子専用にする |
| 動作条件               | 連続空間または四角格子空間上にいるagt  連続空間で使用された場合は内部で座標値を整数にキャストする   （六角格子空間では使えない） |
| 備考                   | toはいらないかなと（関数名長くなるし）   内部ではmove_space_around_position_sqgridに委譲する |

-->



<!--

| 関数名                 | move_space_around_own_hexgrid                                |
| ---------------------- | ------------------------------------------------------------ |
| 引数                   | view:視野(int)   avoid=None:重ならないエージェント集合型(AgtSet) |
| 戻り値                 | 移動エラー値 (移動できなかったときはTrue、できたときはFalse)（boolean） |
| 説明                   | エージェント自身の周りの空き地（格子）を探し、移動する。（検索された領域に複数の空き地が存在するときは、ランダムに移動位置を決定）  avoid引数がデフォルト値のときは全てのエージェントを避け、avoid引数にエージェント集合型変数が指定されたときはそのエージェントのみを避ける。 |
| 使用例                 |                                                              |
| 例外処理               | なし（move_space_around_position_hexgridに委譲する）   ※その際、関数名と引数の番号についての情報を渡し、この関数のエラーメッセージとして出力するようにする工夫が必要） |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | MoveToSpaceOwnCell                                           |
| artisoc4との差異       | 重ならないエージェント集合を指定できる  関数名  四角格子専用にする |
| 動作条件               | 六角格子空間上にいるagt   （連続空間・四角格子空間では使えない） |
| 備考                   | toはいらないかなと（関数名長くなるし）   内部ではmove_space_around_position_hexgridに委譲する |

-->

## move_space_around_position_sqgrid

四角格子空間で、指定された位置を中心に周りの空き地を探し、移動する。検索された領域に複数の空き地が存在するときは、ランダムに移動位置を決定する。

**move_space_around_position_sqgrid**(view, x, y, layer, avoid=None, manhattan=False)

- **view** - 指定する座標の周囲を探索する視野。
- **x** - 指定する位置のx座標。
- **y** - 指定する位置のy座標。
- **layer** - 指定するレイヤ。
- **avoid** - 重ならないエージェント集合。初期値はNoneで、このとき全てのエージェントと重ならない。
- **manhattan** -  Falseのときは視野をチェビシェフ距離で、Trueのときはマンハッタン距離で定義する。初期値はFalse。

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる

```
# （以下、空間エージェントのルールエディタ内に記述）

# レイヤ0の座標(25,30)からチェビシェフ距離で視野2の範囲の格子のうち、エージェントが誰もいない場所へランダムに移動する
self.move_space_around_position_sqgrid(2, 25, 30, 0)

# レイヤ0の座標(25,30)からチェビシェフ距離で視野3の範囲の格子のうち、集合enemiesに含まれるエージェントが誰もいない場所へランダムに移動する
self.move_space_around_position_sqgrid(3, 25, 30, 0, avoid=enemies)

# レイヤ0の座標(25,30)からマンハッタン距離で視野3の範囲の格子のうち、集合enemiesに含まれるエージェントが誰もいない場所へランダムに移動する
self.move_space_around_position_sqgrid(3, 25, 30, 0, avoid=enemies, manhattan=True)
```



<!--

| 関数名                 | move_space_around_position_hexgrid                           |
| ---------------------- | ------------------------------------------------------------ |
| 引数                   | view:視野(int)   X:指定のX座標（int)   Y:指定のY座標(int)   Layer:指定のレイヤ(integer)   avoid=None:重ならないエージェント集合型(AgtSet) |
| 戻り値                 | 移動エラー値 (移動できなかったときはTrue、できたときはFalse)（boolean） |
| 説明                   | 指定された座標を中心に、周りの空き地（格子）を探し、移動する。（検索された領域に複数の空き地が存在するときは、ランダムに移動位置を決定）  avoid引数がデフォルト値のときは全てのエージェントを避け、avoid引数にエージェント集合型変数が指定されたときはそのエージェントのみを避ける。 |
| 使用例                 |                                                              |
| 例外処理               | 空間チェック：ArtisocCloudIllegalUseOfFunctionError   →エージェントの属する空間が六角格子空間でない場合エラーを返す      引数の型チェック：ArtisocCloudTypeError   →avoid引数のset内にAgtでないものが含まれていた場合もこれを返す      エージェントの種別チェック：ArtisocCloudNotSpaceAgtError   →avoid引数のset内に空間エージェントでないUniverse直下のAgt型を指定したときエラー      エージェントの空間チェック：ArtisocCloudDifferentSpaceAgtError   avoid引数のset内に自分と同じ同じ空間にないエージェントを指定したらエラー |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | MoveToSpaceAgtSetCell   MoveToSpacePositionCell              |
| artisoc4との差異       | 2つの関数を統合している   （重ならないエージェント集合を指定する場合はキーワード引数で指定）  連続空間・四角格子空間では使えない  六角格子専用にする |
| 動作条件               | 六角格子空間                                                 |
| 備考                   | toはいらないかなと（関数名長くなるし）                       |

-->

## pursue

目標のエージェントへ向かって移動する。<br>正常終了時は-1、進めなかったときは進めなかった距離を返す。

**pursue**(agt, distance)

- **agt** - 目標とするエージェント。
- **distance** - 移動する距離。

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる<br>※連続空間でのみ使用可能。

```
# エージェントtaroに向かって距離3移動する
self.pursue(taro, 3)

# エージェントtaroに向かって距離0.1進み、進めなかったとき（taroまで距離0.1未満まで接近したとき）自分の色を赤くする
if self.pursue(taro, 0.1) > 0:
	self.color = COLOR_RED
```

<!--

| 例外処理               | 空間チェック：ArtisocCloudIllegalUseOfFunctionError   →エージェントの属する空間が連続空間でない場合エラーを返す   引数の型チェック：ArtisocCloudTypeError |
| ---------------------- | ------------------------------------------------------------ |
| 実装箇所               | SpaceAgt                                                     |
| artisoc4で対応する関数 | Pursue                                                       |
| artisoc4との差異       | なし                                                         |
| 動作条件               | 連続空間上のエージェント                                     |
| 備考                   |                                                              |

-->



## turn

向きを変える。

**turn**(degree)

- **degree** - 向きを変える角度。度数法で指定。左下原点のとき、引数が正の値のときは左回り、負の値のときは右回りに向きを変える。左上原点のときは逆。

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる

```
# 左回りに30度向きを変える（左下原点のとき）
self.turn(30)
```

## turn_agt

指定したエージェントの方向を向く。

**turn_agt**(agt)

- **agt** - 指定するエージェント。

※基本的に、空間エージェントのルールエディタ内で「self.[関数名]」の形で用いる

```
# エージェントtaroの方向を向く
self.turn_agt(taro)
```