jp.progression.scenes.SceneObject

	Property	Defined by
		className : String [read-only] インスタンスのクラス名を取得します。 Indicates the instance className of the SceneObject.	SceneObject
		container : Sprite [read-only] 関連付けられている Sprite インスタンスを取得します。	SceneObject
		dataHolder : DataHolder [read-only] 関連付けられている DataHolder インスタンスを取得します。	SceneObject
		executor : ExecutorObject [read-only] 関連付けられている ExecutorObject インスタンスを取得します。	SceneObject
		group : String インスタンスのグループ名を取得または設定します。 Indicates the instance group of the SceneObject.	SceneObject
		id : String インスタンスを表すユニークな識別子を取得または設定します。	SceneObject
		manager : Progression [read-only] 関連付けられている Progression インスタンスを取得します。	SceneObject
		name : String インスタンスの名前を取得または設定します。 Indicates the instance name of the SceneObject.	SceneObject
		next : SceneObject [read-only] このシーンが関連付けられている親の SceneObject インスタンス内で、次に位置する SceneObject インスタンスを取得します。	SceneObject
		numScenes : int [read-only] 子として登録されているシーン数を取得します。 Returns the number of children of this SceneObject.	SceneObject
		onSceneAscend : Function シーンオブジェクトが SceneEvent.SCENE_ASCEND イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		onSceneDescend : Function シーンオブジェクトが SceneEvent.SCENE_DESCEND イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		onSceneGoto : Function シーンオブジェクトが SceneEvent.SCENE_GOTO イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		onSceneInit : Function シーンオブジェクトが SceneEvent.SCENE_INIT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		onSceneLoad : Function シーンオブジェクトが SceneEvent.SCENE_LOAD イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		onSceneUnload : Function シーンオブジェクトが SceneEvent.SCENE_UNLOAD イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		parent : SceneObject [read-only] この SceneObject オブジェクトを含む SceneObject オブジェクトを示します。 Indicates the SceneObject object that contains this SceneObject object.	SceneObject
		previous : SceneObject [read-only] このシーンが関連付けられている親の SceneObject インスタンス内で、一つ前に位置する SceneObject インスタンスを取得します。	SceneObject
		root : SceneObject [read-only] シーンツリー構造の一番上に位置する SceneObject インスタンスを取得します。	SceneObject
		sceneId : SceneId [read-only] シーン識別子を取得します。	SceneObject
		sceneInfo : SceneInfo [read-only] 関連付けられている SceneInfo インスタンスを取得します。	SceneObject
		scenes : Array [read-only] 子シーンインスタンスが保存されている配列です。この配列を操作することで元の配列を変更することはできません。	SceneObject
		self : SceneObject [read-only] 自身の参照を取得します。	SceneObject
		stage : Stage [read-only] 関連付けられている Stage インスタンスを取得します。	SceneObject
		title : String シーンのタイトルを取得または設定します。	SceneObject
		visited : Boolean [read-only] 一度でもシーンに移動してきた時があるかどうかを取得します。	SceneObject

	Method	Defined by
		SceneObject(name:String = null, initObject:Object = null) 新しい SceneObject インスタンスを作成します。 Creates a new SceneObject object.	SceneObject
		addCommand(... commands):void 特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。	SceneObject
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventDispatcher instance to get the event notification.	SceneObject
		addScene(scene:SceneObject):SceneObject この SceneObject インスタンスに子 SceneObject インスタンスを追加します。 Adds a child SceneObject instance to this SceneObject instance.	SceneObject
		addSceneAt(scene:SceneObject, index:int):SceneObject この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a child SceneObject instance to this SceneObject instance.	SceneObject
		addSceneAtAbove(scene:SceneObject, index:int):SceneObject この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a child SceneObject instance to this SceneObject instance.	SceneObject
		addSceneFromXML(prml:XML):void この SceneObject インスタンスの子を PRML 形式の XML データから追加します。	SceneObject
		clearCommand(completely:Boolean = false):void 登録されている Command インスタンスを削除します。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。	SceneObject
		contains(scene:SceneObject):Boolean 指定されたシーンオブジェクトが SceneObject インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified SceneObject is a scene of the SceneObject instance or the instance itself.	SceneObject
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。 Dispatches an event into the event flow.	SceneObject
		dispose():void 保持しているデータを解放します。	SceneObject
		getSceneAt(index:int):SceneObject 指定のインデックス位置にある子シーンオブジェクトオブジェクトを返します。 Returns the child SceneObject instance that exists at the specified index.	SceneObject
		getSceneByName(name:String):SceneObject 指定された名前に一致する子シーンオブジェクトを返します。 Returns the child SceneObject that exists with the specified name.	SceneObject
		getSceneIndex(scene:SceneObject):int 子 SceneObject インスタンスのインデックス位置を返します。 Returns the index position of a child SceneObject instance.	SceneObject
		globalToLocal(sceneId:SceneId):SceneId シーン識別子をルートシーン（グローバル）パスからローダーシーンの（ローカル）パスに変換します。	SceneObject
		hasEventListener(type:String):Boolean EventDispatcher インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	SceneObject
		insertCommand(... commands):void 特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。	SceneObject
		localToGlobal(sceneId:SceneId):SceneId シーン識別子をローダーシーンの（ローカル）パスからルートシーン（グローバル）パスに変換します。	SceneObject
		removeAllScenes():void SceneObject に追加されている全ての子 SceneObject インスタンスを削除します。	SceneObject
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher インスタンスからリスナーを削除します。このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventDispatcher instance.	SceneObject
		removeScene(scene:SceneObject):SceneObject SceneObject インスタンスの子リストから指定の SceneObject インスタンスを削除します。 Removes the specified child SceneObject instance from the scene list of the SceneObject instance.	SceneObject
		removeSceneAt(index:int):SceneObject SceneObject の子リストの指定されたインデックス位置から子 SceneObject インスタンスを削除します。 Removes a child SceneObject from the specified index position in the child list of the SceneObject.	SceneObject
		setProperties(parameters:Object):SceneObject インスタンスに対して、複数のプロパティを一括設定します。	SceneObject
		setSceneIndex(scene:SceneObject, index:int):void シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.	SceneObject
		setSceneIndexAbove(scene:SceneObject, index:int):void シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.	SceneObject
		swapScenes(scene1:SceneObject, scene2:SceneObject):void 指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the two specified scene objects.	SceneObject
		swapScenesAt(index1:int, index2:int):void 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the scene objects at the two specified index positions in the scene list.	SceneObject
		toString():String 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.	SceneObject
		toXMLString():String 指定されたオブジェクトの XML ストリング表現を返します。 Returns a XML string representation of the XML object.	SceneObject
		updateManager():Boolean マネージャーオブジェクトとの関連付けを更新します。	SceneObject
		validate(prml:XML):Boolean [static] XML データが PRML フォーマットに準拠しているかどうかを返します。	SceneObject
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	SceneObject

	Method	Defined by
		atSceneAscend():void シーンオブジェクトが SceneEvent.SCENE_ASCEND イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		atSceneDescend():void シーンオブジェクトが SceneEvent.SCENE_DESCEND イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		atSceneGoto():void シーンオブジェクトが SceneEvent.SCENE_GOTO イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		atSceneInit():void シーンオブジェクトが SceneEvent.SCENE_INIT イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		atSceneLoad():void シーンオブジェクトが SceneEvent.SCENE_LOAD イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
		atSceneUnload():void シーンオブジェクトが SceneEvent.SCENE_UNLOAD イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject

Summary	Defined by
executeError	非同期処理中にエラーが発生した場合に送出されます。	SceneObject
managerActivate	Progression インスタンスとの関連付けがアクティブになったときに送出されます。	SceneObject
managerDeactivate	Progression インスタンスとの関連付けが非アクティブになったときに送出されます。	SceneObject
sceneAdded	シーンオブジェクトがシーンリストに追加された場合に送出されます。	SceneObject
sceneAddedToRoot	シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの追加により、ルートシーン上のシーンリストに追加されたときに送出されます。	SceneObject
sceneAscend	シーン移動時に目的地がシーンオブジェクトの親階層であり、かつ出発地ではない場合に、自身が移動を中継した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
sceneDescend	シーン移動時に目的地がシーンオブジェクトの子階層であり、かつ出発地ではない場合に、自身が移動を中継した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
sceneGoto	シーンオブジェクト自身が出発地だった場合に、移動を開始した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
sceneInit	シーンオブジェクト自身が目的地だった場合に、到達した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
sceneInitComplete	シーンオブジェクト自身が目的地だった場合に、イベント sceneInit の非同期処理が完了した瞬間に送出されます。	SceneObject
sceneLoad	シーン移動時に目的地がシーンオブジェクト自身もしくは子階層だった場合に、階層が変更された直後に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject
sceneRemoved	シーンオブジェクトがシーンリストから削除された場合に送出されます。	SceneObject
sceneRemovedFromRoot	シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの削除により、ルートシーン上のシーンリストから削除されようとしているときに送出されます。	SceneObject
sceneTitleChange	シーンオブジェクトの title プロパティが変更された場合に送出されます。	SceneObject
sceneUnload	シーン移動時に目的地がシーンオブジェクト自身もしくは親階層だった場合に、階層が変更される直前に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	SceneObject

Property detail

className

property

className:String [read-only]

インスタンスのクラス名を取得します。 Indicates the instance className of the SceneObject.

Implementation
public function get className():String

container

property

container:Sprite [read-only]

関連付けられている Sprite インスタンスを取得します。

Implementation
public function get container():Sprite

dataHolder

property

dataHolder:DataHolder [read-only]

関連付けられている DataHolder インスタンスを取得します。

Implementation
public function get dataHolder():DataHolder

See also

jp.progression.data

executor

property

executor:ExecutorObject [read-only]

関連付けられている ExecutorObject インスタンスを取得します。

Implementation
public function get executor():ExecutorObject

group

property

group:String [read-write]

インスタンスのグループ名を取得または設定します。 Indicates the instance group of the SceneObject.

Implementation
public function get group():String
public function set group(value:String):void

property

id:String [read-write]

インスタンスを表すユニークな識別子を取得または設定します。

Implementation
public function get id():String
public function set id(value:String):void

See also

jp.progression.scenes.getSceneById()

manager

property

manager:Progression [read-only]

関連付けられている Progression インスタンスを取得します。

Implementation
public function get manager():Progression

name

property

name:String [read-write]

インスタンスの名前を取得または設定します。 Indicates the instance name of the SceneObject.

Implementation
public function get name():String
public function set name(value:String):void

See also

sceneId
getSceneByName()

property

next:SceneObject [read-only]

このシーンが関連付けられている親の SceneObject インスタンス内で、次に位置する SceneObject インスタンスを取得します。

Implementation
public function get next():SceneObject

See also

parent
root
previous

numScenes

property

numScenes:int [read-only]

子として登録されているシーン数を取得します。 Returns the number of children of this SceneObject.

Implementation
public function get numScenes():int

onSceneAscend

property

onSceneAscend:Function [read-write]

シーンオブジェクトが SceneEvent.SCENE_ASCEND イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onSceneAscend():Function
public function set onSceneAscend(value:Function):void

onSceneDescend

property

onSceneDescend:Function [read-write]

シーンオブジェクトが SceneEvent.SCENE_DESCEND イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onSceneDescend():Function
public function set onSceneDescend(value:Function):void

onSceneGoto

property

onSceneGoto:Function [read-write]

シーンオブジェクトが SceneEvent.SCENE_GOTO イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onSceneGoto():Function
public function set onSceneGoto(value:Function):void

onSceneInit

property

onSceneInit:Function [read-write]

シーンオブジェクトが SceneEvent.SCENE_INIT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onSceneInit():Function
public function set onSceneInit(value:Function):void

onSceneLoad

property

onSceneLoad:Function [read-write]

シーンオブジェクトが SceneEvent.SCENE_LOAD イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onSceneLoad():Function
public function set onSceneLoad(value:Function):void

onSceneUnload

property

onSceneUnload:Function [read-write]

シーンオブジェクトが SceneEvent.SCENE_UNLOAD イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onSceneUnload():Function
public function set onSceneUnload(value:Function):void

parent

property

parent:SceneObject [read-only]

この SceneObject オブジェクトを含む SceneObject オブジェクトを示します。 Indicates the SceneObject object that contains this SceneObject object.

Implementation
public function get parent():SceneObject

See also

root
next
previous

property

previous:SceneObject [read-only]

このシーンが関連付けられている親の SceneObject インスタンス内で、一つ前に位置する SceneObject インスタンスを取得します。

Implementation
public function get previous():SceneObject

See also

parent
root
next

root

property

root:SceneObject [read-only]

シーンツリー構造の一番上に位置する SceneObject インスタンスを取得します。

Implementation
public function get root():SceneObject

See also

parent
next
previous

sceneId

property

sceneId:SceneId [read-only]

シーン識別子を取得します。

Implementation
public function get sceneId():SceneId

See also

name

sceneInfo

property

sceneInfo:SceneInfo [read-only]

関連付けられている SceneInfo インスタンスを取得します。

Implementation
public function get sceneInfo():SceneInfo

See also

jp.progression.scenes.SceneLoader

scenes

property

scenes:Array [read-only]

子シーンインスタンスが保存されている配列です。この配列を操作することで元の配列を変更することはできません。

Implementation
public function get scenes():Array

self

property

self:SceneObject [read-only]

自身の参照を取得します。

Implementation
public function get self():SceneObject

stage

property

stage:Stage [read-only]

関連付けられている Stage インスタンスを取得します。

Implementation
public function get stage():Stage

title

property

title:String [read-write]

シーンのタイトルを取得または設定します。

Implementation
public function get title():String
public function set title(value:String):void

visited

property

visited:Boolean [read-only]

一度でもシーンに移動してきた時があるかどうかを取得します。

Implementation
public function get visited():Boolean

Constructor detail

SceneObject

()

constructor

public function SceneObject(name:String = null, initObject:Object = null)

新しい SceneObject インスタンスを作成します。 Creates a new SceneObject object.

Parameters

	`name:String` (default = `null`) — シーンの名前です。

	`initObject:Object` (default = `null`) — 設定したいプロパティを含んだオブジェクトです。

Method detail

addCommand

()

method

public function addCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

Parameters

... commands — 登録したいコマンドを含む配列です。

addEventListener

()

method

public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

イベントリスナーオブジェクトを EventDispatcher インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventDispatcher instance to get the event notification. If the registered listener by this method removed by using removeEventListener() method, it can re-register using restoreRemovedListeners() method.

Parameters

	`type:String` — イベントのタイプです。 The type of event.

	`listener:Function` — イベントを処理するリスナー関数です。この関数は Event インスタンスを唯一のパラメータとして受け取り、何も返さないものである必要があります。関数は任意の名前を持つことができます。 The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing. The function can have any name.

	`useCapture:Boolean` (default = `false`) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。useCapture を true に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。useCapture を false に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、addEventListener を 2 回呼び出します。useCapture を true に設定して 1 度呼び出し、useCapture を false に設定してもう一度呼び出します。 Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.

	`priority:int` (default = `0`) — イベントリスナーの優先度レベルです。優先度は、符号付き 32 ビット整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n -1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。 The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`useWeakReference:Boolean` (default = `false`) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。 Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

addScene

()

method

public function addScene(scene:SceneObject):SceneObject

この SceneObject インスタンスに子 SceneObject インスタンスを追加します。 Adds a child SceneObject instance to this SceneObject instance.

Parameters

scene:SceneObject — 対象の SceneObject インスタンスの子として追加する SceneObject インスタンスです。 The SceneObject instance to add as a scene of this SceneObject instance.

Returns

SceneObject — scene パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.

addSceneAt

()

method

public function addSceneAt(scene:SceneObject, index:int):SceneObject

この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a child SceneObject instance to this SceneObject instance.

Parameters

	`scene:SceneObject` — 対象の SceneObject インスタンスの子として追加する SceneObject インスタンスです。 The SceneObject instance to add as a scene of this SceneObject instance.

	`index:int` — 子を追加するインデックス位置です。 The index position to which the scene is added. If you specify a currently occupied index position, the scene object that exists at that position and all higher positions are moved up one position in the scene list.

Returns

SceneObject — scene パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.

addSceneAtAbove

()

method

public function addSceneAtAbove(scene:SceneObject, index:int):SceneObject

Parameters

	`scene:SceneObject` — 対象の SceneObject インスタンスの子として追加する SceneObject インスタンスです。 The SceneObject instance to add as a scene of this SceneObject instance.

	`index:int` — 子を追加するインデックス位置です。 The index position to which the scene is added. If you specify a currently occupied index position, the scene object that exists at that position and all higher positions are moved up one position in the scene list.

Returns

SceneObject — scene パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.

addSceneFromXML

()

method

public function addSceneFromXML(prml:XML):void

この SceneObject インスタンスの子を PRML 形式の XML データから追加します。

Parameters

prml:XML — PRML 形式の XML データです。

atSceneAscend

()

method

protected function atSceneAscend():void

シーンオブジェクトが SceneEvent.SCENE_ASCEND イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atSceneDescend

()

method

protected function atSceneDescend():void

シーンオブジェクトが SceneEvent.SCENE_DESCEND イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atSceneGoto

()

method

protected function atSceneGoto():void

シーンオブジェクトが SceneEvent.SCENE_GOTO イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atSceneInit

()

method

protected function atSceneInit():void

シーンオブジェクトが SceneEvent.SCENE_INIT イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atSceneLoad

()

method

protected function atSceneLoad():void

シーンオブジェクトが SceneEvent.SCENE_LOAD イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atSceneUnload

()

method

protected function atSceneUnload():void

シーンオブジェクトが SceneEvent.SCENE_UNLOAD イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

clearCommand

()

method

public function clearCommand(completely:Boolean = false):void

登録されている Command インスタンスを削除します。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

Parameters

completely:Boolean (default = false) — 登録されている全てのコマンド登録を解除したい場合には true を、現在処理中のコマンド以降の登録を解除したい場合には false です。

contains

()

method

public function contains(scene:SceneObject):Boolean

指定されたシーンオブジェクトが SceneObject インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified SceneObject is a scene of the SceneObject instance or the instance itself.

Parameters

scene:SceneObject — テストする子 SceneObject インスタンスです。 The scene object to test.

Returns

Boolean — scene インスタンスが SceneObject の子であるか、コンテナ自体である場合は true となります。そうでない場合は false となります。 true if the scene object is a scene of the SceneObject or the container itself; otherwise false.

dispatchEvent

()

method

public override function dispatchEvent(event:Event):Boolean

イベントをイベントフローに送出します。 Dispatches an event into the event flow.

Parameters

event:Event — イベントフローに送出されるイベントオブジェクトです。イベントが再度送出されると、イベントのクローンが自動的に作成されます。イベントが送出された後にそのイベントの target プロパティは変更できないため、再送出処理のためにはイベントの新しいコピーを作成する必要があります。 The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns

Boolean — 値が true の場合、イベントは正常に送出されました。値が false の場合、イベントの送出に失敗したか、イベントで preventDefault() が呼び出されたことを示しています。 A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.

dispose

()

method

public function dispose():void

保持しているデータを解放します。

getSceneAt

()

method

public function getSceneAt(index:int):SceneObject

指定のインデックス位置にある子シーンオブジェクトオブジェクトを返します。 Returns the child SceneObject instance that exists at the specified index.

Parameters

index:int — 子 SceneObject インスタンスのインデックス位置です。 The index position of the scene object.

Returns

SceneObject — 指定されたインデックス位置にある子 SceneObject インスタンスです。 The child SceneObject at the specified index position.

getSceneByName

()

method

public function getSceneByName(name:String):SceneObject

指定された名前に一致する子シーンオブジェクトを返します。 Returns the child SceneObject that exists with the specified name.

Parameters

name:String — 返される子 SceneObject インスタンスの名前です。 The name of the scene to return.

Returns

SceneObject — 指定された名前を持つ子 SceneObject インスタンスです。 The child SceneObject with the specified name.

getSceneIndex

()

method

public function getSceneIndex(scene:SceneObject):int

子 SceneObject インスタンスのインデックス位置を返します。 Returns the index position of a child SceneObject instance.

Parameters

scene:SceneObject — 特定する子 SceneObject インスタンスです。 The SceneObject instance to identify.

Returns

int — 特定する子 SceneObject インスタンスのインデックス位置です。 The index position of the child SceneObject to identify.

globalToLocal

()

method

public function globalToLocal(sceneId:SceneId):SceneId

シーン識別子をルートシーン（グローバル）パスからローダーシーンの（ローカル）パスに変換します。

Parameters

sceneId:SceneId — 変換したいシーン識別子オブジェクトです。

Returns

SceneId — ローカルパスに変換されたシーン識別子オブジェクトです。

hasEventListener

()

method

public override function hasEventListener(type:String):Boolean

EventDispatcher インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.

Parameters

type:String — イベントのタイプです。 The type of event.

Returns

Boolean — 指定したタイプのリスナーが登録されている場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type is registered; false otherwise.

insertCommand

()

method

public function insertCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

Parameters

... commands — 登録したいコマンドを含む配列です。

localToGlobal

()

method

public function localToGlobal(sceneId:SceneId):SceneId

シーン識別子をローダーシーンの（ローカル）パスからルートシーン（グローバル）パスに変換します。

Parameters

sceneId:SceneId — 変換したいシーン識別子オブジェクトです。

Returns

SceneId — グローバルパスに変換されたシーン識別子オブジェクトです。

removeAllScenes

()

method

public function removeAllScenes():void

SceneObject に追加されている全ての子 SceneObject インスタンスを削除します。

See also

removeScene()
removeSceneAt()

removeEventListener

()

method

public override function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

EventDispatcher インスタンスからリスナーを削除します。このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventDispatcher instance. The listener removed by using this method can re-register by restoreRemovedListeners() method.

Parameters

	`type:String` — イベントのタイプです。 The type of event.

	`listener:Function` — 削除するリスナーオブジェクトです。 The listener object to remove.

	`useCapture:Boolean` (default = `false`) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、removeEventListener() を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は useCapture() を true に設定し、もう 1 回は useCapture() を false に設定する必要があります。 Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.

removeScene

()

method

public function removeScene(scene:SceneObject):SceneObject

SceneObject インスタンスの子リストから指定の SceneObject インスタンスを削除します。 Removes the specified child SceneObject instance from the scene list of the SceneObject instance.

Parameters

scene:SceneObject — 対象の SceneObject インスタンスの子から削除する SceneObject インスタンスです。 The SceneObject instance to remove.

Returns

SceneObject — scene パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.

See also

removeSceneAt()
removeAllScenes()

removeSceneAt

()

method

public function removeSceneAt(index:int):SceneObject

SceneObject の子リストの指定されたインデックス位置から子 SceneObject インスタンスを削除します。 Removes a child SceneObject from the specified index position in the child list of the SceneObject.

Parameters

index:int — 削除する SceneObject の子インデックスです。 The child index of the SceneObject to remove.

Returns

SceneObject — 削除された SceneObject インスタンスです。 The SceneObject instance that was removed.

See also

removeScene()
removeAllScenes()

setProperties

()

method

public function setProperties(parameters:Object):SceneObject

インスタンスに対して、複数のプロパティを一括設定します。

Parameters

parameters:Object — 設定したいプロパティを含んだオブジェクトです。

Returns

SceneObject — 自身の参照です。

setSceneIndex

()

method

public function setSceneIndex(scene:SceneObject, index:int):void

シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.

Parameters

	`scene:SceneObject` — インデックス番号を変更する子 SceneObject インスタンスです。 The child SceneObject instance for which you want to change the index number.

	`index:int` — child インスタンスの結果のインデックス番号です。 The resulting index number for the child SceneObject.

See also

setSceneIndexAbove()

setSceneIndexAbove

()

method

public function setSceneIndexAbove(scene:SceneObject, index:int):void

シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.

Parameters

	`scene:SceneObject` — インデックス番号を変更する子 SceneObject インスタンスです。 The child SceneObject instance for which you want to change the index number.

	`index:int` — child インスタンスの結果のインデックス番号です。 The resulting index number for the child SceneObject.

See also

setSceneIndex()

swapScenes

()

method

public function swapScenes(scene1:SceneObject, scene2:SceneObject):void

指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the two specified scene objects.

Parameters

	`scene1:SceneObject` — 先頭の子 SceneObject インスタンスです。 The first scene object.

	`scene2:SceneObject` — 2 番目の子 SceneObject インスタンスです。 The second scene object.

See also

swapScenesAt()

swapScenesAt

()

method

public function swapScenesAt(index1:int, index2:int):void

子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the scene objects at the two specified index positions in the scene list.

Parameters

	`index1:int` — 最初の子 SceneObject インスタンスのインデックス位置です。 The index position of the first scene object.

	`index2:int` — 2 番目の子 SceneObject インスタンスのインデックス位置です。 The index position of the second scene object.

See also

swapScenes()

toString

()

method

public override function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns

String — オブジェクトのストリング表現です。 A string representation of the object.

toXMLString

()

method

public function toXMLString():String

指定されたオブジェクトの XML ストリング表現を返します。 Returns a XML string representation of the XML object.

Returns

String — オブジェクトの XML ストリング表現です。 The XML string representation of the XML object.

updateManager

()

method

public function updateManager():Boolean

マネージャーオブジェクトとの関連付けを更新します。

Returns

Boolean — 関連付けが成功したら true を、それ以外は false を返します。

See also

manager
jp.progression.Progression

validate

()

method

public static function validate(prml:XML):Boolean

XML データが PRML フォーマットに準拠しているかどうかを返します。

Parameters

prml:XML — フォーマットを検査したい XML データです。

Returns

Boolean — フォーマットが合致すれば true を、合致しなければ false となります。

Example

willTrigger

()

method

public override function willTrigger(type:String):Boolean

指定されたイベントタイプについて、この EventDispatcher インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.

Parameters

type:String — イベントのタイプです。 The type of event.

Returns

Boolean — 指定したタイプのリスナーがトリガされた場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type will be triggered; false otherwise.

Event detail

executeError

event

Event object type: jp.progression.events.ExecuteErrorEvent

非同期処理中にエラーが発生した場合に送出されます。

managerActivate

event

Event object type: jp.progression.events.ManagerEvent

Progression インスタンスとの関連付けがアクティブになったときに送出されます。

managerDeactivate

event

Event object type: jp.progression.events.ManagerEvent

Progression インスタンスとの関連付けが非アクティブになったときに送出されます。

sceneAdded

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクトがシーンリストに追加された場合に送出されます。

sceneAddedToRoot

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの追加により、ルートシーン上のシーンリストに追加されたときに送出されます。

sceneAscend

event

Event object type: jp.progression.events.SceneEvent

シーン移動時に目的地がシーンオブジェクトの親階層であり、かつ出発地ではない場合に、自身が移動を中継した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

sceneDescend

event

Event object type: jp.progression.events.SceneEvent

シーン移動時に目的地がシーンオブジェクトの子階層であり、かつ出発地ではない場合に、自身が移動を中継した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

sceneGoto

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクト自身が出発地だった場合に、移動を開始した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

sceneInit

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクト自身が目的地だった場合に、到達した瞬間に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

sceneInitComplete

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクト自身が目的地だった場合に、イベント sceneInit の非同期処理が完了した瞬間に送出されます。

sceneLoad

event

Event object type: jp.progression.events.SceneEvent

シーン移動時に目的地がシーンオブジェクト自身もしくは子階層だった場合に、階層が変更された直後に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

sceneRemoved

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクトがシーンリストから削除された場合に送出されます。

sceneRemovedFromRoot

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの削除により、ルートシーン上のシーンリストから削除されようとしているときに送出されます。

sceneTitleChange

event

Event object type: jp.progression.events.SceneEvent

シーンオブジェクトの title プロパティが変更された場合に送出されます。

sceneUnload

event

Event object type: jp.progression.events.SceneEvent

シーン移動時に目的地がシーンオブジェクト自身もしくは親階層だった場合に、階層が変更される直前に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Progression 4.0 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class SceneObject	Properties \| Methods \| Events

Package	jp.progression.scenes
Class	public class SceneObject
Inheritance	SceneObject flash.events.EventDispatcher
Implements	IIdGroup, jp.progression.core.impls.IDisposable, jp.progression.core.impls.IExecutable, jp.progression.core.impls.IManageable
Subclasses	EasyCastingScene, SceneLoader