| Package | krewfw.core |
| Class | public class KrewScene |
| Inheritance | KrewScene KrewGameObject starling.display.Sprite |
| Method | Defined By | ||
|---|---|---|---|
| KrewScene | |||
addPeriodicTask(interval:Number, task:Function):void | KrewScene | ||
addScheduledTask(timeout:Number, task:Function):void | KrewScene | ||
![]() | blackIn(duration:Number = 0.33, startAlpha:Number = 1):void | KrewGameObject | |
![]() | blackOut(duration:Number = 0.33, startAlpha:Number = 0):void | KrewGameObject | |
![]() | colorIn(color:uint, duration:Number = 0.33, startAlpha:Number = 1):void | KrewGameObject | |
![]() | colorOut(color:uint, duration:Number = 0.33, startAlpha:Number = 0):void | KrewGameObject | |
cyclic(interval:Number, task:Function):void | KrewScene | ||
cyclicFrame(task:Function, waitFrames:int = 1, times:int = -1):void | KrewScene | ||
delayed(timeout:Number, task:Function):void | KrewScene | ||
delayedFrame(task:Function, waitFrames:int = 1):void | KrewScene | ||
dispose():void [override] | KrewScene | ||
getAdditionalGlobalAssets():Array
「ゲーム全体で常に保持しておきたいアセット」に追加するファイル名群を指定. | KrewScene | ||
![]() | getByteArray(fileName:String):ByteArray | KrewGameObject | |
getCollisionGroups():Array
衝突判定を行うグループの定義
| KrewScene | ||
exit() が呼ばれた際に遷移する次のシーンを返すよう override してほしい. | KrewScene | ||
![]() | getImage(fileName:String):Image | KrewGameObject | |
![]() | getLayer(layerName:String):StageLayer | KrewGameObject | |
getLayerList():Array
レイヤー構造の定義
| KrewScene | ||
![]() | getObject(fileName:String):Object | KrewGameObject | |
getRequiredAssets():Array
このシーンで必要なアセットのファイルパス一覧を指定. | KrewScene | ||
![]() | getSound(fileName:String):Sound | KrewGameObject | |
![]() | getTexture(fileName:String):Texture | KrewGameObject | |
![]() | getXml(fileName:String):XML | KrewGameObject | |
hookBeforeInit(doneCallback:Function):void
initAfterLoad の前に、非同期処理を含む初期化のための処理シーケンスを
挟みたい場合はここに記述する。
(サーバのレスポンスをもとにリソースを読み込みたい場合など)
| KrewScene | ||
![]() | init():void
この時点で sharedObj がセットされているので
resourceManager にアクセスできる
| KrewGameObject | |
initAfterLoad():void
全てのアセットのロード完了後の本命のシーン初期化処理
ここから requiredAssets で指定したアセットが使える
| KrewScene | ||
initLoadingView():void
ローディング画面を構成するための init. | KrewScene | ||
![]() | listen(eventType:String, callback:Function):void | KrewGameObject | |
![]() | loadResources(fileNameList:Array, onLoadProgress:Function, onLoadComplete:Function):void | KrewGameObject | |
mainLoop(passedTime:Number):void
Process one frame of game main loop. | KrewScene | ||
onLoadComplete():void
getRequiredAssets で指定したアセット群のロード完了時に呼ばれる。
(これの直後に initAfterLoad が呼ばれる)
| KrewScene | ||
onLoadCompleteGlobal():void
getAdditionalGlobalAssets で指定したアセット群のロード完了時に呼ばれる。
(これの直後に getRequiredAssets で指定したアセットの読み込みが始まる)
| KrewScene | ||
onLoadProgress(loadRatio:Number):void
getRequiredAssets で指定したアセット群のロード中に呼ばれる。
アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる
| KrewScene | ||
onLoadProgressGlobal(loadRatio:Number):void
getAdditionalGlobalAssets で指定したアセット群のロード中に呼ばれる。
アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる
| KrewScene | ||
![]() | onUpdate(passedTime:Number):void | KrewGameObject | |
![]() | pauseBgm():void | KrewGameObject | |
![]() | playBgm(bgmId:String, vol:Number, startTime:Number = 0):void
同じ bgmId をすでに再生中の場合は、再生し直さない。
(0 から再生し直したい場合は先に stopBgm() を呼んでね)
| KrewGameObject | |
![]() | playSe(seId:String, pan:Number = 0, loops:int = 0, vol:Number, startTime:Number = 0):void | KrewGameObject | |
![]() | resetTimeScale(layerName:String):void | KrewGameObject | |
![]() | resumeBgm():void | KrewGameObject | |
![]() | sendMessage(eventType:String, eventArgs:Object = null):void | KrewGameObject | |
![]() | setAllLayersEnabled(enabled:Boolean):void | KrewGameObject | |
![]() | setCollision(groupName:String, shape:CollisionShape):void | KrewGameObject | |
![]() | setLayerEnabled(layerNameList:Array, enabled:Boolean):void | KrewGameObject | |
![]() | setLayerEnabledOtherThan(excludeLayerNameList:Array, enabled:Boolean):void | KrewGameObject | |
![]() | setTimeScale(layerName:String, timeScale:Number):void | KrewGameObject | |
setUpActor(layerName:String, actor:KrewActor, putOnDisplayList:Boolean = true):void | KrewScene | ||
![]() | stopAllListening():void | KrewGameObject | |
![]() | stopAllSound():void | KrewGameObject | |
![]() | stopBgm():void | KrewGameObject | |
![]() | stopListening(eventType:String):void | KrewGameObject | |
![]() | stopSe():void | KrewGameObject | |
![]() | whiteIn(duration:Number = 0.33, startAlpha:Number = 1):void | KrewGameObject | |
![]() | whiteOut(duration:Number = 0.33, startAlpha:Number = 0):void | KrewGameObject | |
| Method | Defined By | ||
|---|---|---|---|
| KrewScene | |||
| KrewScene | |||
![]() | onDispose():void | KrewGameObject | |
react():void | KrewScene | ||
| KrewScene | () | Constructor |
public function KrewScene()| act | () | method |
protected function act(action:StuntAction = null):StuntActionParameters
action:StuntAction (default = null) |
StuntAction |
| addPeriodicTask | () | method |
public function addPeriodicTask(interval:Number, task:Function):voidParameters
interval:Number | |
task:Function |
| addScheduledTask | () | method |
public function addScheduledTask(timeout:Number, task:Function):voidParameters
timeout:Number | |
task:Function |
| cyclic | () | method |
public function cyclic(interval:Number, task:Function):voidParameters
interval:Number | |
task:Function |
| cyclicFrame | () | method |
public function cyclicFrame(task:Function, waitFrames:int = 1, times:int = -1):voidParameters
task:Function | |
waitFrames:int (default = 1) | |
times:int (default = -1) |
| delayed | () | method |
public function delayed(timeout:Number, task:Function):voidParameters
timeout:Number | |
task:Function |
| delayedFrame | () | method |
public function delayedFrame(task:Function, waitFrames:int = 1):voidParameters
task:Function | |
waitFrames:int (default = 1) |
| dispose | () | method |
override public function dispose():void| exit | () | method |
protected function exit(nextScene:KrewScene = null):voidParameters
nextScene:KrewScene (default = null) |
| getAdditionalGlobalAssets | () | method |
public function getAdditionalGlobalAssets():Array「ゲーム全体で常に保持しておきたいアセット」に追加するファイル名群を指定. これは起動時に 1 回だけ呼ばれる起動処理専用の Scene で指定されることを想定している。 現時点では、これによってグローバルに保持したアセットを解放するインタフェースは用意していない。 Scene の getAdditionalGlobalAssets がオーバライドされていた場合、 Scene は遷移時に Global のアセット読み込みを先に行ってから Scene スコープのアセット読み込みを行う。
ReturnsArray |
See also
| getCollisionGroups | () | method |
public function getCollisionGroups():Array衝突判定を行うグループの定義
ReturnsArray — Example: Array of Array such as
[
['myship' , ['enemy', 'en-shot', 'item']],
['myshot' , ['enemy']],
['enemy' , []],
['en-shot', []],
['item' , []]
]
こう書くと「c-myship と c-enemy グループ間」、
「c-myship と c-item グループ間」などでヒットテストが行われるといった次第
|
| getDefaultNextScene | () | method |
public function getDefaultNextScene():KrewSceneexit() が呼ばれた際に遷移する次のシーンを返すよう override してほしい. なお exit(specificScene) と引数にシーンを渡した場合はそのシーンが遷移先となり、 この関数は無視される
ReturnsKrewScene |
| getLayerList | () | method |
public function getLayerList():Arrayレイヤー構造の定義
ReturnsArray — Example: ['back', 'front', 'ui']
|
| getRequiredAssets | () | method |
public function getRequiredAssets():Arrayこのシーンで必要なアセットのファイルパス一覧を指定. ここで指定したアセットによって確保されたリソースは、 シーン遷移時に自動的に解放される
ReturnsArray — Example:
[
"image/atlas_1.png",
"image/atlas_1.xml",
"bgm/bgm_1.mp3",
"bmp_font/gothic.png",
"bmp_font/gothic.fnt",
"level_data/stage_1.json"
]
|
| hookBeforeInit | () | method |
public function hookBeforeInit(doneCallback:Function):voidinitAfterLoad の前に、非同期処理を含む初期化のための処理シーケンスを 挟みたい場合はここに記述する。 (サーバのレスポンスをもとにリソースを読み込みたい場合など)
Parameters
doneCallback:Function |
| initAfterLoad | () | method |
public function initAfterLoad():void全てのアセットのロード完了後の本命のシーン初期化処理 ここから requiredAssets で指定したアセットが使える
| initLoadingView | () | method |
public function initLoadingView():voidローディング画面を構成するための init. この時点では KrewGameDirector で指定した大域リソースしか使えないので、 ここでセットする Actor はグローバルに保持しているリソースを使う必要がある
| mainLoop | () | method |
public function mainLoop(passedTime:Number):voidProcess one frame of game main loop. It is called automatically by framework, but you can manually call it for unit test of Actor's messaging.
Parameters
passedTime:Number (default = NaN) |
| onLoadComplete | () | method |
public function onLoadComplete():voidgetRequiredAssets で指定したアセット群のロード完了時に呼ばれる。 (これの直後に initAfterLoad が呼ばれる)
| onLoadCompleteGlobal | () | method |
public function onLoadCompleteGlobal():voidgetAdditionalGlobalAssets で指定したアセット群のロード完了時に呼ばれる。 (これの直後に getRequiredAssets で指定したアセットの読み込みが始まる)
| onLoadProgress | () | method |
public function onLoadProgress(loadRatio:Number):voidgetRequiredAssets で指定したアセット群のロード中に呼ばれる。 アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる
Parameters
loadRatio:Number |
| onLoadProgressGlobal | () | method |
public function onLoadProgressGlobal(loadRatio:Number):voidgetAdditionalGlobalAssets で指定したアセット群のロード中に呼ばれる。 アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる
Parameters
loadRatio:Number |
| react | () | method |
protected function react():void| setUpActor | () | method |
public function setUpActor(layerName:String, actor:KrewActor, putOnDisplayList:Boolean = true):voidParameters
layerName:String | |
actor:KrewActor | |
putOnDisplayList:Boolean (default = true) |