Arbor 3: FSM & BT Graph Editor 3.7.8

公開メンバ関数 | 公開変数類 | 限定公開メンバ関数 | プロパティ | 全メンバ一覧
State クラス

ステートを表すクラス [詳解]

State の継承関係図

## 公開メンバ関数
| State (ArborFSMInternal stateMachine, int nodeID, bool resident)
| Stateのコンストラクタ [詳解]
void | AddBehaviour (StateBehaviour behaviour)
| StateBehaviourを追加。 [詳解]
StateBehaviour | AddBehaviour (System.Type type)
| StateBehaviourを追加。 [詳解]
T | AddBehaviour< T > ()
| StateBehaviourを追加。 [詳解]
void | InsertBehaviour (int index, StateBehaviour behaviour)
| StateBehaviourを挿入。 [詳解]
StateBehaviour | InsertBehaviour (int index, System.Type type)
| StateBehaviourを挿入。 [詳解]
T | InsertBehaviour< T > (int index)
| StateBehaviourを追加。 [詳解]
StateBehaviour | GetBehaviourFromIndex (int index)
| StateBehaviourをindexから取得。 [詳解]
Object | GetBehaviourObjectFromIndex (int index)
| StateBehaviourのObjectをindexから取得。 [詳解]
StateBehaviour | GetBehaviour (System.Type type)
| StateBehaviourを取得。 [詳解]
T | GetBehaviour< T > ()
| StateBehaviourを取得。 [詳解]
StateBehaviour[] | GetBehaviours (System.Type type)
| StateBehaviourを取得。 [詳解]
T[] | GetBehaviours< T > ()
| StateBehaviourを取得。 [詳解]
bool | Contains (StateBehaviour behaviour)
| StateBehaviourが含まれているかどうか。 [詳解]
int | IndexOfBehaviour (Object behaviourObj)
| StateBehaviourのインデックスを返す。 [詳解]
void | RemoveBehaviour (Object behaviourObj)
| StateBehaviourを削除する。インスタンスは削除されないため、StateBehaviour.Destroyを使用すること。 [詳解]
void | RemoveBehaviourAt (int behaviourIndex)
| StateBehaviourを削除する。インスタンスは削除されないため、StateBehaviour.Destroyを使用すること。 [詳解]
void | SwapBehaviour (int fromIndex, int toIndex)
| StateBehaviourの順番を入れ替える。 [詳解]
void | MoveBehaviour (int fromIndex, State toState, int toIndex)
| StateBehaviourの順番を移動する。 [詳解]
void | SetBehaviour (int index, StateBehaviour behaviour)
| StateBehaviourを設定する。 [詳解]
override bool | IsContainsBehaviour (NodeBehaviour behaviour)
| NodeBehaviourを含んでいるかをチェックする。 [詳解]
void | DisconnectState (int stateID)
| 内部処理用。 [詳解]
void | DestroyBehaviour (Object behaviourObj)
| StateBehaviourを破棄する。 [詳解]
void | DestroyBehaviourAt (int behaviourIndex)
| StateBehaviourを破棄する。 [詳解]
void | DestroyBehaviours ()
| 内部処理用。 [詳解]
void | UpdateBehaviours ()
| 内部処理用。 [詳解]
void | LateUpdateBehaviours ()
| 内部処理用。 [詳解]
void | SendTrigger (string message)
| トリガーメッセージを送信する。StateBehaviour.OnStateTriggerが呼び出される。 [詳解]
override string | GetName ()
| ノードの名前を取得 [詳解]
基底クラス Node に属する継承公開メンバ関数
| Node (NodeGraph nodeGraph, int nodeID)
| Nodeのコンストラクタ [詳解]
virtual bool | IsDeletable ()
| 削除できるかどうかを返す。 [詳解]
override string | ToString ()
| ノードを文字列に変換（デバッグ用）。 [詳解]

## 公開変数類
string | name = "New State"
| ステートの名前。 [詳解]
基底クラス Node に属する継承公開変数類
Rect | position
| Arbor Editor上での位置。 [詳解]
bool | showComment
| コメントを表示するかどうか [詳解]
string | nodeComment
| コメント [詳解]

## 限定公開メンバ関数
override void | OnGraphChanged ()
| Nodeが所属するNodeGraphが変わった際に呼ばれる。 [詳解]

## プロパティ
ArborFSMInternal | stateMachine`[get]`
| FSMを取得。 [詳解]
StateBehaviour[] | behaviours`[get]`
| 非推奨。behaviourCountとGetBehaviourFromIndexを使用して下さい。 [詳解]
int | behaviourCount`[get]`
| Behaviourの数を取得。 [詳解]
int | stateID`[get]`
| ステートIDを取得。 [詳解]
bool | resident`[get]`
| 常駐するStateかどうかを取得。 [詳解]
bool | breakPoint`[get, set]`
| Break point. [詳解]
uint | transitionCount`[get, set]`
| 遷移回数。 [詳解]
基底クラス Node に属する継承プロパティ
NodeGraph | nodeGraph`[get]`
| NodeGraphを取得。 [詳解]
int | nodeID`[get]`
| ノードIDを取得。 [詳解]

## 詳解

ステートを表すクラス

## 構築子と解体子

## ◆ State()

State | ( | ArborFSMInternal | stateMachine,
|  | int | nodeID,
|  | bool | resident
| ) |  |

Stateのコンストラクタ

引数

  stateMachine | このノードを持つステートマシン
  nodeID | ノードID
  resident | 常駐ステート

ステートの生成はArborFSMInternal.CreateState(bool)を使用してください。

## メソッド詳解

## ◆ AddBehaviour() [1/2]

void AddBehaviour | ( | StateBehaviour | behaviour | ) |

StateBehaviourを追加。

引数

  behaviour | 追加するStateBehaviour

## ◆ AddBehaviour() [2/2]

StateBehaviour AddBehaviour | ( | System.Type | type | ) |

StateBehaviourを追加。

引数

  type | 追加するStateBehaviourの型

戻り値
  追加したStateBehaviour

## ◆ AddBehaviour< T >()

T AddBehaviour< T > | ( |  | ) |

StateBehaviourを追加。

テンプレート引数

  T | 追加するStateBehaviourの型

戻り値
  追加したStateBehaviour

型制約

  T | : | StateBehaviour |

## ◆ Contains()

bool Contains | ( | StateBehaviour | behaviour | ) |

StateBehaviourが含まれているかどうか。

引数

  behaviour | 判定するStateBehaviour。

戻り値
  含まれているかどうか。

## ◆ DestroyBehaviour()

void DestroyBehaviour | ( | Object | behaviourObj | ) |

StateBehaviourを破棄する。

引数

  behaviourObj | 破棄したいStateBehaviour.

## ◆ DestroyBehaviourAt()

void DestroyBehaviourAt | ( | int | behaviourIndex | ) |

StateBehaviourを破棄する。

引数

  behaviourIndex | 破棄したいStateBehaviourのインデックス。

## ◆ DestroyBehaviours()

void DestroyBehaviours | ( |  | ) |

内部処理用。

## ◆ DisconnectState()

void DisconnectState | ( | int | stateID | ) |

内部処理用。

## ◆ GetBehaviour()

StateBehaviour GetBehaviour | ( | System.Type | type | ) |

StateBehaviourを取得。

引数

  type | 取得したいStateBehaviourの型。

戻り値
  見つかったStateBehaviour。ない場合はnull。

## ◆ GetBehaviour< T >()

T GetBehaviour< T > | ( |  | ) |

StateBehaviourを取得。

テンプレート引数

  T | 取得したいStateBehaviourの型。

戻り値
  見つかったStateBehaviour。ない場合はnull。

型制約

  T | : | StateBehaviour |

## ◆ GetBehaviourFromIndex()

StateBehaviour GetBehaviourFromIndex | ( | int | index | ) |

StateBehaviourをindexから取得。

引数

  index | インデックス

戻り値
  StateBehaviour

## ◆ GetBehaviourObjectFromIndex()

Object GetBehaviourObjectFromIndex | ( | int | index | ) |

StateBehaviourのObjectをindexから取得。

引数

  index | インデックス

戻り値
  Object

## ◆ GetBehaviours()

StateBehaviour [] GetBehaviours | ( | System.Type | type | ) |

StateBehaviourを取得。

引数

  type | 取得したいStateBehaviourの型。

戻り値
  見つかったStateBehaviourの配列。

## ◆ GetBehaviours< T >()

T [] GetBehaviours< T > | ( |  | ) |

StateBehaviourを取得。

テンプレート引数

  T | 取得したいStateBehaviourの型。

戻り値
  見つかったStateBehaviourの配列。

型制約

  T | : | StateBehaviour |

## ◆ GetName()

override string GetName | ( |  | ) |
| virtual

ノードの名前を取得

戻り値
  ノードの名前

Nodeを再実装しています。

## ◆ IndexOfBehaviour()

int IndexOfBehaviour | ( | Object | behaviourObj | ) |

StateBehaviourのインデックスを返す。

引数

  behaviourObj | 検索するStateBehaviour

戻り値
  見つかった場合はインデックス、ない場合は-1を返す。

## ◆ InsertBehaviour() [1/2]

void InsertBehaviour | ( | int | index,
|  | StateBehaviour | behaviour
| ) |  |

StateBehaviourを挿入。

引数

  index | 挿入先インデックス
  behaviour | 挿入するStateBehaviour

## ◆ InsertBehaviour() [2/2]

StateBehaviour InsertBehaviour | ( | int | index,
|  | System.Type | type
| ) |  |

StateBehaviourを挿入。

引数

  index | 挿入先インデックス
  type | 追加するStateBehaviourの型

戻り値
  挿入したStateBehaviour

## ◆ InsertBehaviour< T >()

T InsertBehaviour< T > | ( | int | index | ) |

StateBehaviourを追加。

テンプレート引数

  T | 挿入するStateBehaviourの型

引数

  index | 挿入先インデックス

戻り値
  挿入したStateBehaviour

型制約

  T | : | StateBehaviour |

## ◆ IsContainsBehaviour()

override bool IsContainsBehaviour | ( | NodeBehaviour | behaviour | ) |
| virtual

NodeBehaviourを含んでいるかをチェックする。

引数

  behaviour | チェックするNodeBehaviour

戻り値
  NodeBehaviourを含んでいる場合にtrueを返す。

Nodeを再実装しています。

## ◆ LateUpdateBehaviours()

void LateUpdateBehaviours | ( |  | ) |

内部処理用。

## ◆ MoveBehaviour()

void MoveBehaviour | ( | int | fromIndex,
|  | State | toState,
|  | int | toIndex
| ) |  |

StateBehaviourの順番を移動する。

引数

  fromIndex | 移動させたいインデックス。
  toState | 移動先のState。
  toIndex | 移動先のインデックス。

## ◆ OnGraphChanged()

override void OnGraphChanged | ( |  | ) |
| protected virtual

Nodeが所属するNodeGraphが変わった際に呼ばれる。

Nodeを再実装しています。

## ◆ RemoveBehaviour()

void RemoveBehaviour | ( | Object | behaviourObj | ) |

StateBehaviourを削除する。インスタンスは削除されないため、StateBehaviour.Destroyを使用すること。

引数

  behaviourObj | 削除するStateBehaviour。

## ◆ RemoveBehaviourAt()

void RemoveBehaviourAt | ( | int | behaviourIndex | ) |

StateBehaviourを削除する。インスタンスは削除されないため、StateBehaviour.Destroyを使用すること。

引数

  behaviourIndex | 削除するStateBehaviourのインデックス。

## ◆ SendTrigger()

void SendTrigger | ( | string | message | ) |

トリガーメッセージを送信する。StateBehaviour.OnStateTriggerが呼び出される。

引数

  message | 送信するメッセージ

## ◆ SetBehaviour()

void SetBehaviour | ( | int | index,
|  | StateBehaviour | behaviour
| ) |  |

StateBehaviourを設定する。

引数

  index | インデックス
  behaviour | StateBehaviour

元のStateBehaviourは破棄しないため注意。 StateBehaviourを追加したい場合はAddBehaviourを使用して下さい。 また、破棄したい場合はDestroyBehaviourを使用して下さい。

## ◆ SwapBehaviour()

void SwapBehaviour | ( | int | fromIndex,
|  | int | toIndex
| ) |  |

StateBehaviourの順番を入れ替える。

引数

  fromIndex | 入れ替えたいインデックス。
  toIndex | 入れ替え先インデックス。

## ◆ UpdateBehaviours()

void UpdateBehaviours | ( |  | ) |

内部処理用。

## メンバ詳解

## ◆ name

string name = "New State"

ステートの名前。

## プロパティ詳解

## ◆ behaviourCount

int behaviourCount
| get

Behaviourの数を取得。

## ◆ behaviours

StateBehaviour [] behaviours
| get

非推奨。behaviourCountとGetBehaviourFromIndexを使用して下さい。

## ◆ breakPoint

bool breakPoint
| get set

Break point.

When this property is true, the editor is in a pause state at the timing of entering the state.

## ◆ resident

bool resident
| get

常駐するStateかどうかを取得。

## ◆ stateID

int stateID
| get

ステートIDを取得。

## ◆ stateMachine

ArborFSMInternal stateMachine
| get

FSMを取得。

## ◆ transitionCount

uint transitionCount
| get set

遷移回数。