Package | krewfw.core |
Class | public class KrewActor |
Inheritance | KrewActor ![]() ![]() |
Subclasses | ColorActor, ColorRect, DraggableActor, ImageButton, KeyboardStatus, KrewMovieClip, KrewPoolableActor, KrewScenarioPlayer, KrewStateMachine, MinimalStateMachine, SceneServantActor, ScreenCurtain, SimpleButton, SimpleImageActor, SimpleLoadingScreen, SimpleVirtualJoystick, StageLayer, TextButton, TouchFilter |
Property | Defined By | ||
---|---|---|---|
applyForNewActor : Function | KrewActor | ||
cachedHeight : Number [read-only] | KrewActor | ||
cachedWidth : Number [read-only]
[CAUTION] starling.display.DisplayObjectContainer の
width / height の getter は重い行列計算が走るので滅多なことでもない限り使うな
| KrewActor | ||
childActors : Vector.<KrewActor> [read-only] | KrewActor | ||
collidable : Boolean = true false にすると CollisionShape が衝突判定を行わない | KrewActor | ||
color : uint Actor が持つ Image や TextField 全てに色をセットする | KrewActor | ||
displayable : Boolean = true
addActor 前に false にすると addActor 時に addChild を行わない
(Starling の DisplayList にのせない.)
見た目を持たずに仕事をする Actor はこれを false にすればよい
| KrewActor | ||
displayOrder : int = 0 high is front | KrewActor | ||
hasInitialized : Boolean Called from StageLayerManager for re-init global actor. | KrewActor | ||
![]() | id : int [read-only] | KrewGameObject | |
isDead : Boolean [read-only] | KrewActor | ||
![]() | krew : KrewTopUtil [read-only]
よく使う utility への簡易アクセス
| KrewGameObject | |
layer : StageLayer | KrewActor | ||
layerName : String | KrewActor | ||
numActor : int [read-only] | KrewActor | ||
poolable : Boolean = false
true にすると再セットアップが可能な状態に dispose する。
(GC を促すための null を入れることをしない)
| KrewActor | ||
![]() | sharedObj : KrewSharedObjects | KrewGameObject |
Property | Defined By | ||
---|---|---|---|
_cachedHeight : Number | KrewActor | ||
_cachedWidth : Number | KrewActor | ||
_checkDisplayArea : Boolean = false | KrewActor |
Method | Defined By | ||
---|---|---|---|
KrewActor | |||
KrewActor | |||
krewFramework のシステムに Actor を登録し、同時に Starling の DisplayList に追加する. | KrewActor | ||
addChild(child:DisplayObject):DisplayObject [override]
addChild したものは Actor 破棄時に勝手に dispose が呼ばれる
| KrewActor | ||
addImage(image:Image, width:Number, height:Number, x:Number = 0, y:Number = 0, anchorX:Number = 0.5, anchorY:Number = 0.5):void
addChild の代わりに addImage を呼ぶことで破棄時に Image.texture の dispose が
呼ばれるようになる。また、KrewActor.color の指定で全 Image に色がかかるようになる
| KrewActor | ||
addInitializer(initFunc:Function):void
init が呼ばれる時(KrewScene.setUpActor に渡された時、または
Actor から addActor されたとき)に、init 後に呼ばれる関数を登録。
コンストラクタでの使用を想定. | KrewActor | ||
addPeriodicTask(interval:Number, task:Function, times:int = -1):void Equivalent to setInterval(), but passed time will be based on game's timeline. | KrewActor | ||
addScheduledTask(timeout:Number, task:Function):void Equivalent to setTimeout(), but passed time will be based on game's timeline. | KrewActor | ||
addText(text:TextField, x:Number, y:Number):void
Actor 全体の color に影響させたい場合は addChild ではなく addText で足す
| KrewActor | ||
addTouchMarginNode(touchWidth:Number = 0, touchHeight:Number = 0):void
for touch action adjustment. | KrewActor | ||
addTween(tween:Tween):void | KrewActor | ||
![]() | blackIn(duration:Number = 0.33, startAlpha:Number = 1):void | KrewGameObject | |
![]() | blackOut(duration:Number = 0.33, startAlpha:Number = 0):void | KrewGameObject | |
changeImage(image:Image, imageName:String):void | KrewActor | ||
![]() | colorIn(color:uint, duration:Number = 0.33, startAlpha:Number = 1):void | KrewGameObject | |
![]() | colorOut(color:uint, duration:Number = 0.33, startAlpha:Number = 0):void | KrewGameObject | |
createActor(newActor:KrewActor, layerName:String = null):void | KrewActor | ||
cyclic(interval:Number, task:Function, times:int = -1):void Alias for addPeriodicTask | KrewActor | ||
cyclicFrame(task:Function, waitFrames:int = 1, times:int = -1):void Runs task several times after n frames. | KrewActor | ||
delayed(timeout:Number, task:Function):void Alias for addScheduledTask | KrewActor | ||
delayedFrame(task:Function, waitFrames:int = 1):void Runs task 1 times after n frames. | KrewActor | ||
![]() | dispose():void [override] | KrewGameObject | |
enchant(duration:Number, transition:String):Tween | KrewActor | ||
![]() | getByteArray(fileName:String):ByteArray | KrewGameObject | |
![]() | getImage(fileName:String):Image | KrewGameObject | |
![]() | getLayer(layerName:String):StageLayer | KrewGameObject | |
![]() | getObject(fileName:String):Object | KrewGameObject | |
![]() | getSound(fileName:String):Sound | KrewGameObject | |
![]() | getTexture(fileName:String):Texture | KrewGameObject | |
![]() | getXml(fileName:String):XML | KrewGameObject | |
![]() | init():void
この時点で sharedObj がセットされているので
resourceManager にアクセスできる
| KrewGameObject | |
![]() | listen(eventType:String, callback:Function):void | KrewGameObject | |
![]() | loadResources(fileNameList:Array, onLoadProgress:Function, onLoadComplete:Function):void | KrewGameObject | |
![]() | onUpdate(passedTime:Number):void | KrewGameObject | |
passAway():void | KrewActor | ||
![]() | 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 | |
react():void | KrewActor | ||
removeTweens():void | KrewActor | ||
![]() | 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 | |
setVertexColor(color1:int = 0, color2:int = 0, color3:int = 0, color4:int = 0):void | KrewActor | ||
sortDisplayOrder():void
displayOrder の値でツリーをソート。 children が皆 KrewActor である前提。
actor.displayOrder = 1; のように設定した上で
getLayer('hoge').sortDisplayOrder(); のように使う
| KrewActor | ||
![]() | 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 | ||
---|---|---|---|
_disposeFromPool():void | KrewActor | ||
_retrieveFromPool():void | KrewActor | ||
![]() | onDispose():void | KrewGameObject | |
onRecycle():void
poolable = true な Actor が dispose されるタイミングで、
onDispose の代わりに呼ばれる
| KrewActor |
_cachedHeight | property |
protected var _cachedHeight:Number
_cachedWidth | property |
protected var _cachedWidth:Number
_checkDisplayArea | property |
protected var _checkDisplayArea:Boolean = false
applyForNewActor | property |
public var applyForNewActor:Function
cachedHeight | property |
cachedHeight:Number
[read-only]
public function get cachedHeight():Number
See also
cachedWidth | property |
cachedWidth:Number
[read-only] [CAUTION] starling.display.DisplayObjectContainer の width / height の getter は重い行列計算が走るので滅多なことでもない限り使うな
public function get cachedWidth():Number
childActors | property |
childActors:Vector.<KrewActor>
[read-only] public function get childActors():Vector.<KrewActor>
collidable | property |
public var collidable:Boolean = true
false にすると CollisionShape が衝突判定を行わない
color | property |
color:uint
Actor が持つ Image や TextField 全てに色をセットする
public function get color():uint
public function set color(value:uint):void
displayable | property |
public var displayable:Boolean = true
addActor 前に false にすると addActor 時に addChild を行わない (Starling の DisplayList にのせない.) 見た目を持たずに仕事をする Actor はこれを false にすればよい
displayOrder | property |
public var displayOrder:int = 0
high is front
hasInitialized | property |
hasInitialized:Boolean
Called from StageLayerManager for re-init global actor.
public function get hasInitialized():Boolean
public function set hasInitialized(value:Boolean):void
isDead | property |
isDead:Boolean
[read-only] public function get isDead():Boolean
layer | property |
public var layer:StageLayer
layerName | property |
public var layerName:String
numActor | property |
numActor:int
[read-only] public function get numActor():int
poolable | property |
public var poolable:Boolean = false
true にすると再セットアップが可能な状態に dispose する。 (GC を促すための null を入れることをしない)
KrewActor | () | Constructor |
public function KrewActor()
_disposeFromPool | () | method |
protected function _disposeFromPool():void
_retrieveFromPool | () | method |
protected function _retrieveFromPool():void
act | () | method |
public function act(action:StuntAction = null):StuntAction
Parameters
action:StuntAction (default = null )
|
StuntAction |
addActor | () | method |
public function addActor(actor:KrewActor, putOnDisplayList:Boolean = true):void
krewFramework のシステムに Actor を登録し、同時に Starling の DisplayList に追加する. 見た目を持たずに仕事をするような Actor は putOnDisplayList に false を渡すか、 Actor のコンストラクタで displayable に false を設定しておくと Starling の DisplayList には追加しない
Parameters
actor:KrewActor | |
putOnDisplayList:Boolean (default = true )
|
addChild | () | method |
override public function addChild(child:DisplayObject):DisplayObject
addChild したものは Actor 破棄時に勝手に dispose が呼ばれる
Parameters
child:DisplayObject |
DisplayObject |
addImage | () | method |
public function addImage(image:Image, width:Number, height:Number, x:Number = 0, y:Number = 0, anchorX:Number = 0.5, anchorY:Number = 0.5):void
addChild の代わりに addImage を呼ぶことで破棄時に Image.texture の dispose が 呼ばれるようになる。また、KrewActor.color の指定で全 Image に色がかかるようになる
Parameters
image:Image | |
width:Number (default = NaN )
| |
height:Number (default = NaN )
| |
x:Number (default = 0 )
| |
y:Number (default = 0 )
| |
anchorX:Number (default = 0.5 )
| |
anchorY:Number (default = 0.5 )
|
addInitializer | () | method |
public function addInitializer(initFunc:Function):void
init が呼ばれる時(KrewScene.setUpActor に渡された時、または Actor から addActor されたとき)に、init 後に呼ばれる関数を登録。 コンストラクタでの使用を想定. コンストラクタで引数を渡して init に用いたい場合、クラスメンバに値を 保持しておくなどの手間がかかるため、それを楽にするためのもの。 登録した関数は init 実行後に、登録した順番で呼ばれる。
Parameters
initFunc:Function |
addPeriodicTask | () | method |
public function addPeriodicTask(interval:Number, task:Function, times:int = -1):void
Equivalent to setInterval(), but passed time will be based on game's timeline.
Parameters
interval:Number | |
task:Function | |
times:int (default = -1 )
|
addScheduledTask | () | method |
public function addScheduledTask(timeout:Number, task:Function):void
Equivalent to setTimeout(), but passed time will be based on game's timeline.
Parameters
timeout:Number | |
task:Function |
addText | () | method |
public function addText(text:TextField, x:Number, y:Number):void
Actor 全体の color に影響させたい場合は addChild ではなく addText で足す
Parameters
text:TextField | |
x:Number (default = NaN )
| |
y:Number (default = NaN )
|
addTouchMarginNode | () | method |
public function addTouchMarginNode(touchWidth:Number = 0, touchHeight:Number = 0):void
for touch action adjustment. [CAUTION] You should call this after actor's init (setUpActor or addActor).
Parameters
touchWidth:Number (default = 0 )
| |
touchHeight:Number (default = 0 )
|
addTween | () | method |
public function addTween(tween:Tween):void
Parameters
tween:Tween |
changeImage | () | method |
public function changeImage(image:Image, imageName:String):void
Parameters
image:Image | |
imageName:String |
createActor | () | method |
public function createActor(newActor:KrewActor, layerName:String = null):void
Parameters
newActor:KrewActor | |
layerName:String (default = null )
|
cyclic | () | method |
public function cyclic(interval:Number, task:Function, times:int = -1):void
Alias for addPeriodicTask
Parameters
interval:Number | |
task:Function | |
times:int (default = -1 )
|
cyclicFrame | () | method |
public function cyclicFrame(task:Function, waitFrames:int = 1, times:int = -1):void
Runs task several times after n frames.
Parameters
task:Function | |
waitFrames:int (default = 1 )
| |
times:int (default = -1 )
|
delayed | () | method |
public function delayed(timeout:Number, task:Function):void
Alias for addScheduledTask
Parameters
timeout:Number | |
task:Function |
delayedFrame | () | method |
public function delayedFrame(task:Function, waitFrames:int = 1):void
Runs task 1 times after n frames.
Parameters
task:Function | |
waitFrames:int (default = 1 )
|
enchant | () | method |
public function enchant(duration:Number, transition:String):Tween
Parameters
duration:Number | |
transition:String (default = NaN )
|
Tween |
onRecycle | () | method |
protected function onRecycle():void
poolable = true な Actor が dispose されるタイミングで、 onDispose の代わりに呼ばれる
passAway | () | method |
public function passAway():void
react | () | method |
public function react():void
removeTweens | () | method |
public function removeTweens():void
setVertexColor | () | method |
public function setVertexColor(color1:int = 0, color2:int = 0, color3:int = 0, color4:int = 0):void
Parameters
color1:int (default = 0 )
| |
color2:int (default = 0 )
| |
color3:int (default = 0 )
| |
color4:int (default = 0 )
|
sortDisplayOrder | () | method |
public function sortDisplayOrder():void
displayOrder の値でツリーをソート。 children が皆 KrewActor である前提。 actor.displayOrder = 1; のように設定した上で getLayer('hoge').sortDisplayOrder(); のように使う