Packagekrewfw.core
Classpublic class KrewScene
InheritanceKrewScene Inheritance KrewGameObject Inheritance starling.display.Sprite



Public Properties
 PropertyDefined By
 Inheritedid : int
[read-only]
KrewGameObject
 Inheritedkrew : KrewTopUtil
[read-only] よく使う utility への簡易アクセス
KrewGameObject
 InheritedsharedObj : KrewSharedObjects
KrewGameObject
Public Methods
 MethodDefined By
  
KrewScene
  
addPeriodicTask(interval:Number, task:Function):void
KrewScene
  
addScheduledTask(timeout:Number, task:Function):void
KrewScene
 Inherited
blackIn(duration:Number = 0.33, startAlpha:Number = 1):void
KrewGameObject
 Inherited
blackOut(duration:Number = 0.33, startAlpha:Number = 0):void
KrewGameObject
 Inherited
colorIn(color:uint, duration:Number = 0.33, startAlpha:Number = 1):void
KrewGameObject
 Inherited
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
  
「ゲーム全体で常に保持しておきたいアセット」に追加するファイル名群を指定.
KrewScene
 Inherited
getByteArray(fileName:String):ByteArray
KrewGameObject
  
衝突判定を行うグループの定義
KrewScene
  
exit() が呼ばれた際に遷移する次のシーンを返すよう override してほしい.
KrewScene
 Inherited
getImage(fileName:String):Image
KrewGameObject
 Inherited
getLayer(layerName:String):StageLayer
KrewGameObject
  
getLayerList():Array
レイヤー構造の定義
KrewScene
 Inherited
getObject(fileName:String):Object
KrewGameObject
  
このシーンで必要なアセットのファイルパス一覧を指定.
KrewScene
 Inherited
getSound(fileName:String):Sound
KrewGameObject
 Inherited
getTexture(fileName:String):Texture
KrewGameObject
 Inherited
getXml(fileName:String):XML
KrewGameObject
  
hookBeforeInit(doneCallback:Function):void
initAfterLoad の前に、非同期処理を含む初期化のための処理シーケンスを 挟みたい場合はここに記述する。 (サーバのレスポンスをもとにリソースを読み込みたい場合など)
KrewScene
 Inherited
init():void
この時点で sharedObj がセットされているので resourceManager にアクセスできる
KrewGameObject
  
全てのアセットのロード完了後の本命のシーン初期化処理 ここから requiredAssets で指定したアセットが使える
KrewScene
  
ローディング画面を構成するための init.
KrewScene
 Inherited
listen(eventType:String, callback:Function):void
KrewGameObject
 Inherited
loadResources(fileNameList:Array, onLoadProgress:Function, onLoadComplete:Function):void
KrewGameObject
  
mainLoop(passedTime:Number):void
Process one frame of game main loop.
KrewScene
  
getRequiredAssets で指定したアセット群のロード完了時に呼ばれる。 (これの直後に initAfterLoad が呼ばれる)
KrewScene
  
getAdditionalGlobalAssets で指定したアセット群のロード完了時に呼ばれる。 (これの直後に getRequiredAssets で指定したアセットの読み込みが始まる)
KrewScene
  
onLoadProgress(loadRatio:Number):void
getRequiredAssets で指定したアセット群のロード中に呼ばれる。 アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる
KrewScene
  
onLoadProgressGlobal(loadRatio:Number):void
getAdditionalGlobalAssets で指定したアセット群のロード中に呼ばれる。 アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる
KrewScene
 Inherited
onUpdate(passedTime:Number):void
KrewGameObject
 Inherited
pauseBgm():void
KrewGameObject
 Inherited
playBgm(bgmId:String, vol:Number, startTime:Number = 0):void
同じ bgmId をすでに再生中の場合は、再生し直さない。 (0 から再生し直したい場合は先に stopBgm() を呼んでね)
KrewGameObject
 Inherited
playSe(seId:String, pan:Number = 0, loops:int = 0, vol:Number, startTime:Number = 0):void
KrewGameObject
 Inherited
resetTimeScale(layerName:String):void
KrewGameObject
 Inherited
resumeBgm():void
KrewGameObject
 Inherited
sendMessage(eventType:String, eventArgs:Object = null):void
KrewGameObject
 Inherited
setAllLayersEnabled(enabled:Boolean):void
KrewGameObject
 Inherited
setCollision(groupName:String, shape:CollisionShape):void
KrewGameObject
 Inherited
setLayerEnabled(layerNameList:Array, enabled:Boolean):void
KrewGameObject
 Inherited
setLayerEnabledOtherThan(excludeLayerNameList:Array, enabled:Boolean):void
KrewGameObject
 Inherited
setTimeScale(layerName:String, timeScale:Number):void
KrewGameObject
  
setUpActor(layerName:String, actor:KrewActor, putOnDisplayList:Boolean = true):void
KrewScene
 Inherited
KrewGameObject
 Inherited
KrewGameObject
 Inherited
stopBgm():void
KrewGameObject
 Inherited
stopListening(eventType:String):void
KrewGameObject
 Inherited
stopSe():void
KrewGameObject
 Inherited
whiteIn(duration:Number = 0.33, startAlpha:Number = 1):void
KrewGameObject
 Inherited
whiteOut(duration:Number = 0.33, startAlpha:Number = 0):void
KrewGameObject
Protected Methods
 MethodDefined By
  
act(action:StuntAction = null):StuntAction
KrewScene
  
exit(nextScene:KrewScene = null):void
KrewScene
 Inherited
onDispose():void
KrewGameObject
  
react():void
KrewScene
Constructor Detail
KrewScene()Constructor
public function KrewScene()



Method Detail
act()method
protected function act(action:StuntAction = null):StuntAction

Parameters

action:StuntAction (default = null)

Returns
StuntAction
addPeriodicTask()method 
public function addPeriodicTask(interval:Number, task:Function):void

Parameters

interval:Number
 
task:Function

addScheduledTask()method 
public function addScheduledTask(timeout:Number, task:Function):void

Parameters

timeout:Number
 
task:Function

cyclic()method 
public function cyclic(interval:Number, task:Function):void

Parameters

interval:Number
 
task:Function

cyclicFrame()method 
public function cyclicFrame(task:Function, waitFrames:int = 1, times:int = -1):void

Parameters

task:Function
 
waitFrames:int (default = 1)
 
times:int (default = -1)

delayed()method 
public function delayed(timeout:Number, task:Function):void

Parameters

timeout:Number
 
task:Function

delayedFrame()method 
public function delayedFrame(task:Function, waitFrames:int = 1):void

Parameters

task:Function
 
waitFrames:int (default = 1)

dispose()method 
override public function dispose():void

exit()method 
protected function exit(nextScene:KrewScene = null):void

Parameters

nextScene:KrewScene (default = null)

getAdditionalGlobalAssets()method 
public function getAdditionalGlobalAssets():Array

「ゲーム全体で常に保持しておきたいアセット」に追加するファイル名群を指定. これは起動時に 1 回だけ呼ばれる起動処理専用の Scene で指定されることを想定している。 現時点では、これによってグローバルに保持したアセットを解放するインタフェースは用意していない。 Scene の getAdditionalGlobalAssets がオーバライドされていた場合、 Scene は遷移時に Global のアセット読み込みを先に行ってから Scene スコープのアセット読み込みを行う。

Returns
Array

See also

getRequiredAssets
getCollisionGroups()method 
public function getCollisionGroups():Array

衝突判定を行うグループの定義

Returns
Array — 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():KrewScene

exit() が呼ばれた際に遷移する次のシーンを返すよう override してほしい. なお exit(specificScene) と引数にシーンを渡した場合はそのシーンが遷移先となり、 この関数は無視される

Returns
KrewScene
getLayerList()method 
public function getLayerList():Array

レイヤー構造の定義

Returns
Array — Example: ['back', 'front', 'ui']
getRequiredAssets()method 
public function getRequiredAssets():Array

このシーンで必要なアセットのファイルパス一覧を指定. ここで指定したアセットによって確保されたリソースは、 シーン遷移時に自動的に解放される

Returns
Array — 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):void

initAfterLoad の前に、非同期処理を含む初期化のための処理シーケンスを 挟みたい場合はここに記述する。 (サーバのレスポンスをもとにリソースを読み込みたい場合など)

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):void

Process 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():void

getRequiredAssets で指定したアセット群のロード完了時に呼ばれる。 (これの直後に initAfterLoad が呼ばれる)

onLoadCompleteGlobal()method 
public function onLoadCompleteGlobal():void

getAdditionalGlobalAssets で指定したアセット群のロード完了時に呼ばれる。 (これの直後に getRequiredAssets で指定したアセットの読み込みが始まる)

onLoadProgress()method 
public function onLoadProgress(loadRatio:Number):void

getRequiredAssets で指定したアセット群のロード中に呼ばれる。 アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる

Parameters

loadRatio:Number

onLoadProgressGlobal()method 
public function onLoadProgressGlobal(loadRatio:Number):void

getAdditionalGlobalAssets で指定したアセット群のロード中に呼ばれる。 アセットの指定があれば最低 1 回は呼ばれ、最後の呼び出しでは loadRatio = 1 となる

Parameters

loadRatio:Number

react()method 
protected function react():void

setUpActor()method 
public function setUpActor(layerName:String, actor:KrewActor, putOnDisplayList:Boolean = true):void

Parameters

layerName:String
 
actor:KrewActor
 
putOnDisplayList:Boolean (default = true)