class ZBuilderScene

package zygame.components

extends ZScene › ZBox › Component › TouchDisplayObjectContainer › DisplayObjectContainer

@:directlyUsed

通过ZBuilder创建场景，请注意在new构造函数准备好所有需要加载的资源。在触发onInit后，会自动载入； 加载完成后会触发onBuilded事件；加载失败会触发onBuildError事件。场景在释放时，会自动释放掉assetsBuilder。

Constructor

new (xmlPath:String)

Variables

assetsBuilder:AssetsBuilder

资源管理对象

read onlyloaded:Bool

是否已经加载完毕

Methods

get<T> (id:String, type:Class<T>):Null<T>

根据类型获取对象

Parameters:

id
type

Returns:

T

onBuildError ():Bool

构造失败，一般为加载失败时触发，当返回true时，该窗口会自动移除，返回false可自行处理。

Returns:

Bool

onBuilded ():Void

dynamiconBuildedEvent ():Void

onLoad ():Void

开始加载，如果需要额外加载资源，请重写onLoad后对assetsBuilder追加。

onLoaded ():Void

Inherited Variables

Defined by ZBox

childs:Array<DisplayObject>

添加到容器盒子里会记录所有的子项

layout:BaseLayout

设置布局对象，用于控制Box里的容器显示位置

Defined by Component

Defined by TouchDisplayObjectContainer

@:value(false)isTouch:Bool = false

@:value(true)mouseEvent:Bool = true

默认触摸为鼠标触摸

Defined by DisplayObjectContainer

@:keepbaseBuilder:Builder

基础生成baseBuilder，该属性只有通过MiniEngine创建时生效。

@:value(null)@:keepbindType:String = null

绑定类型，Maplive可用

@:keepcustomData:Dynamic

自定义数据，默认为null，可以作为扩展数据使用

@:keephAlign:String

横向对齐实现

@:value(false)@:keepisInit:Bool = false

@:keep@:noCompletionscrollMaskDislayObject:DisplayObject

Bate功能：遮罩对象（依赖scrollRect实现的遮罩逻辑实现）

@:value(0)@:keepsubtractionHeight:Int = 0

@:keeptween:ZTween

动画配置：这里设置的ZTween将仅影响当前容器的动画

@:keepvAlign:String

竖向对齐实现

Inherited Methods

Defined by ZScene

createScene<T> (cName:Class<T>):T

创建场景

 *  @param cName - 
 *  @return ZScene

isLockScene ():Bool

是否被锁定

Returns:

Bool

lockScene (display:DisplayObject):Void

锁定画布渲染，锁定后可让draw变成1draw，当调用了lock之后，在更换新的场景之前，务必先调用unlock

onSceneReset ():Void

当场景被创建后，重新createScene或者替换场景时，会进行调用场景重设，这时应该在这里进行重置数据。

releaseScene ():Void

释放当前场景

@:value({ isReleaseScene : false })replaceHistoryScene (isReleaseScene:Bool = false):ZScene

返回上一个场景，仅记录5个场景记录

Parameters:

isReleaseScene

Returns:

ZScene

@:value({ isReleaseScene : false })replaceScene<T> (cName:Class<T>, isReleaseScene:Bool = false):T

替换场景

 *  @param cName - 
 *  @return ZScene

unlockScene ():Void

解除画布渲染锁定

Defined by ZBox

addChildSuper (display:DisplayObject):DisplayObject

@:value({ centerY : 0, centerX : 0, bottomPx : null, topPx : null, rightPx : null, leftPx : null })align (obj:DisplayObject, ?leftPx:Dynamic, ?rightPx:Dynamic, ?topPx:Dynamic, ?bottomPx:Dynamic, centerX:Dynamic = 0, centerY:Dynamic = 0):Void

对齐功能

 *  @param obj - 对齐对象
 *  @param leftPx - 左对齐
 *  @param rightPx - 右对齐
 *  @param topPx - 顶部对齐
 *  @param bottomPx - 底部对齐
 *  @param centerX - 居中对齐
 *  @param centerY - 垂直对齐

isAutoHeight ():Bool

isAutoWidth ():Bool

removeChildSuper (display:DisplayObject):DisplayObject

updateComponents ():Void

ZBox负责刷新布局容器

Defined by Component

addComponent (child:Component, pname:String):Component

添加组件

Parameters:

child
  • 组件
pname
  • 名字，定义好后可通过findComponent方法查找

Returns:

Component

findComponent (pname:String):Component

查询组件

Parameters:

pname
  • 组件的名字

Returns:

Component

hasLayoutData ():Bool

是否存在布局文件

Returns:

Bool

onSkinChange (e:Event):Void

Defined by TouchDisplayObjectContainer

onMouseDown (e:MouseEvent):Void

onMouseMove (e:MouseEvent):Void

onMouseUp (e:MouseEvent):Void

onTouchBegin (e:TouchEvent):Void

onTouchEnd (e:TouchEvent):Void

onTouchMove (e:TouchEvent):Void

onTouchOut (e:MouseEvent):Void

onTouchOver (e:MouseEvent):Void

@:value({ priority : 0, userCapture : false })setTouchEvent (listen:Bool, userCapture:Bool = false, priority:Int = 0):Void

设置触摸事件

 *  @param listen - 是否侦听，false则清理所有事件

Defined by DisplayObjectContainer

@:value({ h : null, v : null })@:keepalignPivot (?v:String, ?h:String):Void

锚点对齐，不能直接对齐调用，容器不直接支持该功能。

@:keepdestroy ():Void

释放接口实现

@:keepgetAspectRatio ():Float

获取屏幕比例，>= 0.62的基本是平板尺寸

Returns:

Float

@:keepgetBounds (target:DisplayObject):Rectangle

getBounds优化计算

Parameters:

parent

Returns:

openfl.geom.Rectangle

@:keepgetStageHeight ():Float

经过了缩放计算的舞台高度

 *  @return Float

@:keepgetStageWidth ():Float

经过了缩放计算的舞台宽度

 *  @return Float

@:keepgetSubtractionHeight ():Int

获取高度削减高度

Returns:

Float

@:keepgetTopView ():DisplayObjectContainer

获取最顶层的容器

Returns:

DisplayObjectContainer

@:value({ f : "", e : "", d : "", c : "", b : "" })@:keeplog (a:Dynamic, b:Dynamic = "", c:Dynamic = "", d:Dynamic = "", e:Dynamic = "", f:Dynamic = ""):Void

输出log

@:keeponAddToStage ():Void

当添加到舞台时

@:keeponFrame ():Void

帧事件接口

@:keeponRemove ():Void

当自已被删掉时

@:keeponRemoveToStage ():Void

当从舞台移除时

@:keepscale (f:Float):DisplayObjectContainer

缩放处理

 *  @param f -
 *  @return DisplayObjectContainer

@:keepsetFrameEvent (listen:Bool):Void

设置帧事件使用

 *  @param listen - 是否侦听

@:keepsetSubtractionStageHeight (height:Int):Void

设置舞台高度削减

Parameters:

null

height