Stage3D API
version 0.12

Stage3D
クラス Acting

java.lang.Object
  拡張Stage3D.Acting
直系の既知のサブクラス:
ActAddActor, ActEnQueue, ActingList, ActInterrupt, ActMove, ActSay, ActSetAngle, ActSetPosition, ActThrowEvent, ActTurn, ActWait, SimpleCamActing

public abstract class Acting
extends java.lang.Object

このクラスはActorクラスが使用するActingの雛形である。 すべてのActingはこのクラスを継承して作成される。


フィールドの概要
static int KILL
          割り込みのシグナルである。
 
コンストラクタの概要
Acting()
          Actingクラスのインスタンスを作成する。
 
メソッドの概要
abstract  boolean doActing()
          Actingの実行を行うメソッドである。
 DataPack.DataPack getCommandDataPack()
          Actngの状態を意味するDataPackを返す。
 int getInterruptedFlag()
          割り込みフラグを取得する。
 boolean getIsActive()
          このActingがActiveかInactiveかを調べる。
 java.lang.String getName()
          このActingのインスタンスの名前を取得する。
 Stage getStage()
          所属するStageを取得する。
 DataPack.DataPack getStatus()
          Actingの状態を表すDataPackを返すためのメソッド 標準ではgetCommandDataPackメソッドで得られる物が そのまま返される。
 Actor getTargetActor()
          対象となっているActorを取得する。
 void setInterruptedFlag(int signal)
          割り込みフラグを設定する。
protected  void setIsActive(boolean arg)
          このActingがactiveかどうかを設定する。
 void setName(java.lang.String name)
          このActingのインスタンスの名前を設定する。
abstract  boolean setOption(DataPack.DataPack[] datapacks)
          ActingのインスタンスはコマンドとなるDataPackから 作成される。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

KILL

public static final int KILL
割り込みのシグナルである。この値をsetInterruptedFlag メソッドに引数として渡すとそのメソッドは強制的に Inactiveとなる。

関連項目:
setInterruptedFlag(int signal), 定数フィールド値
コンストラクタの詳細

Acting

public Acting()
Actingクラスのインスタンスを作成する。 Actingは基本的にActorのgetActingメソッドによって 生成されるため、引数を持つコンストラクタを オーバーライドしても使用することはできない。

メソッドの詳細

setIsActive

protected void setIsActive(boolean arg)
このActingがactiveかどうかを設定する。基本的に このメソッドはdoActing()メソッド内で呼び出され るようにする。

パラメータ:
arg - trueなら実行中、falseならそうではない。

doActing

public abstract boolean doActing()
Actingの実行を行うメソッドである。 このメソッドはこのActingがActorのActingListに存在し、 ActiveになったときにInactiveになるまで毎ターン実行 される。InactiveになるにはsetIsActiveメソッドによって 自身をInactiveにする必要がある。 また、この戻り値はターンを終了するかを 意味しており、trueで終了、falseは終了しない。 割り込みを判断するためには

戻り値:
ターンを終了するか、しないかを意味する。 trueで終了、falseは終了しない。

setOption

public abstract boolean setOption(DataPack.DataPack[] datapacks)
ActingのインスタンスはコマンドとなるDataPackから 作成される。そのDataPackのオプション部分が インスタンス作成時にオプションとしてこのメソッドの 引数として渡される。

パラメータ:
datapacks - このActingのオプション。
戻り値:
このメソッドの成功、失敗を意味する。 成功ならtrue、失敗ならfalseが返される。

getIsActive

public boolean getIsActive()
このActingがActiveかInactiveかを調べる。

戻り値:
Activeならtrueを返す。そうでなければFalse。

setName

public void setName(java.lang.String name)
このActingのインスタンスの名前を設定する。 通常はActorクラスのsetActingTypeメソッドで 使用された名前が使用される。

パラメータ:
name - 設定する名前。

getName

public java.lang.String getName()
このActingのインスタンスの名前を取得する。

戻り値:
このActingのインスタンスの名前。

getStage

public Stage getStage()
所属するStageを取得する。それはこのActingの対象と なっているActorの所属するStageのことである。

戻り値:
対象となっているActorが所属するStage。

getTargetActor

public Actor getTargetActor()
対象となっているActorを取得する。

戻り値:
このActingの対象となっているActor。

getInterruptedFlag

public int getInterruptedFlag()
割り込みフラグを取得する。 割り込まれていない場合は0を返す。

戻り値:
割り込みフラグ。

setInterruptedFlag

public void setInterruptedFlag(int signal)
割り込みフラグを設定する。このメソッドは 割り込みのフラグを設定するだけでそれ以外の 処理は行わない。もし割り込まれたことに対して 動作を行いたいのであればdoActingメソッド内で 割り込みに対する動作を記述しておく必要がある。 ただし、KILLを与えられたときのみこのActingは 強制的にInactiveとなる。

パラメータ:
signal - 割り込みシグナル。
戻り値:
割り込みフラグ。
関連項目:
KILL

getStatus

public DataPack.DataPack getStatus()
Actingの状態を表すDataPackを返すためのメソッド 標準ではgetCommandDataPackメソッドで得られる物が そのまま返される。ただし、オーバーライドする場合 かならずnull以外を返すこと。

戻り値:
このActingの状態を表すDataPack。

getCommandDataPack

public DataPack.DataPack getCommandDataPack()
Actngの状態を意味するDataPackを返す。通常Actingは ActorクラスのcreateActingメソッドによって作成されるため、 そのメソッドによってActing生成のコマンドが 返されるようになっている。

戻り値:
このActing作成に使用されたコマンド。

author Takao Sumitomo