| Package | jp.progression.scenes |
| Class | public class SceneId |
| Inheritance | SceneId  Object |
| Property | Defined By | ||
|---|---|---|---|
| length : int [read-only]
シーンパスの深度を取得します。
| SceneId | ||
| path : String [read-only]
シーンパスを取得します。
| SceneId | ||
| query : Query [read-only]
シーンパスに関連付けられているクエリを Object 表現で取得します。
| SceneId | ||
| Method | Defined By | ||
|---|---|---|---|
SceneId(scenePath:String, query:Object = null)
新しい SceneId インスタンスを作成します。
Creates a new SceneId object.
| SceneId | ||
SceneId インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。
Duplicates an instance of an SceneId subclass.
| SceneId | ||
指定されたシーン識別子が、自身の表すシーンパスの子シーンオブジェクトを指しているかどうかを返します。
| SceneId | ||
指定されたシーン識別子が、自身の表すシーンパスと同一かどうかを返します。
| SceneId | ||
getNameByIndex(index:int):String
指定位置にあるシーンの名前を返します。
| SceneId | ||
シーン識別子の保存するシーンパスの指定された範囲のエレメントを取り出して、新しいシーン識別子を返します。
この操作で元のシーン識別子は変更されません。
| SceneId | ||
toString():String
指定されたオブジェクトのストリング表現を返します。
Returns the string representation of the specified object.
| SceneId | ||
指定された絶対シーンパスもしくは相対シーンパスを使用して移動後のシーン識別子を返します。
この操作で元のシーン識別子は変更されません。
| SceneId | ||
validate(path:String):Boolean [static]
シーンパスの書式が正しいかどうかを返します。
| SceneId | ||
| length | property |
length:int [read-only] シーンパスの深度を取得します。
public function get length():int| path | property |
path:String [read-only] シーンパスを取得します。
public function get path():String| query | property |
query:Query [read-only] シーンパスに関連付けられているクエリを Object 表現で取得します。
public function get query():Query| SceneId | () | Constructor |
public function SceneId(scenePath:String, query:Object = null)新しい SceneId インスタンスを作成します。 Creates a new SceneId object.
ParametersscenePath:String — シーン識別子に変換するシーンパス、または URL を表すストリングです。
| |
query:Object (default = null) |
| clone | () | method |
public function clone():SceneIdSceneId インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an SceneId subclass.
ReturnsSceneId —
元のオブジェクトと同じプロパティ値を含む新しい SceneId インスタンスです。
A new SceneId object that is identical to the original.
|
| contains | () | method |
public function contains(sceneId:SceneId):Boolean指定されたシーン識別子が、自身の表すシーンパスの子シーンオブジェクトを指しているかどうかを返します。
Parameters
sceneId:SceneId — テストするシーン識別子です。
|
Boolean —
子シーンオブジェクトを指していれば true に、それ以外の場合は false になります。
|
| equals | () | method |
public function equals(sceneId:SceneId, matchQuery:Boolean = false):Boolean指定されたシーン識別子が、自身の表すシーンパスと同一かどうかを返します。
Parameters
sceneId:SceneId — テストするシーン識別子です。
| |
matchQuery:Boolean (default = false) |
Boolean —
同一のシーンパスを指していれば true に、それ以外の場合は false になります。
|
| getNameByIndex | () | method |
public function getNameByIndex(index:int):String指定位置にあるシーンの名前を返します。
Parameters
index:int — 取得した名前のあるシーンの位置です。
|
String —
指定位置にあるシーンの名前です。
|
| slice | () | method |
public function slice(startIndex:int = 0, endIndex:int = 16777215):SceneIdシーン識別子の保存するシーンパスの指定された範囲のエレメントを取り出して、新しいシーン識別子を返します。 この操作で元のシーン識別子は変更されません。
Parameters
startIndex:int (default = 0) | |
endIndex:int (default = 16777215) |
SceneId —
元のシーンパスから取り出した一連のエレメントから成るシーン識別子です。
|
| toString | () | method |
public function toString():String指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
ReturnsString —
オブジェクトのストリング表現です。
A string representation of the object.
|
| transfer | () | method |
public function transfer(path:String):SceneId指定された絶対シーンパスもしくは相対シーンパスを使用して移動後のシーン識別子を返します。 この操作で元のシーン識別子は変更されません。
Parameters
path:String — 移動先のシーンパスです。
|
SceneId —
移動後のシーン識別子です。
|
| validate | () | method |
public static function validate(path:String):Booleanシーンパスの書式が正しいかどうかを返します。
Parameters
path:String — 書式を調べるシーンパスです。
|
Boolean —
書式が正しければ true に、それ以外の場合は false になります。
|