引擎核心类,请继承这个作为启动类

Constructor

@:has_untyped@:value({ scalePower : false, isDebug : false, HDHeight : 480, HDWidth : 800 })new (HDWidth:Int = 800, HDHeight:Int = 480, isDebug:Bool = false, scalePower:Bool = false)

启动一个启动器,用于启动进入游戏入口。

 *  @param HDWidth - 以宽适配时使用的宽度像素
 *  @param HDHeight - 以高适配时使用的高度像素
 *  @param isDebug - 是否显示debug数据,当该值为true时,FPSDebug对象将会建立,一般在发布正式版时,该值应该被设置为false。
 *  @param scalePower - 测试性功能,使缩放永远为0.5作为间隔缩放。

Variables

@:value(0)HDHeight:Int = 0

指定的适配高度

@:value(0)HDWidth:Int = 0

指定的适配宽度

fps:FPSDebug

FPS以及内存显示器,请在super(0,0,true)第三个参数设置为true时设置为生效,否则fps将会为null。

@:value(false)isDebug:Bool = false

是否为Debug模式

topView:StageDisplayObjectContainer

最顶层显示,该窗口会根据缩放比例进行适配,能够与实际游戏内容的坐标匹配。

view3d:Dynamic

3D渲染对象,它永远会比我们的2D画面要置低。

Methods

addToUpdate (display:Refresher):Void

添加对象到帧事件

 *  @param display -

getCPUTime ():Float

获取CPU运行时间

Returns:

Float

getIntervalTime ():Float

获取每帧间隔时间

Returns:

Float

getUpdateLength ():Int

获取帧侦听数量

Returns:

Int

lockLandscape ():Void

锁定横版模式

onActivate (e:Event):Void

onDeActivate (e:Event):Void

onFrame ():Void

重写onFrame

onInitEvent (e:Event):Void

初始化时机控制,确保ZQuad可用

Parameters:

null

e

onRender (e:RenderEvent):Void

渲染事件

Parameters:

null

e

onStageMouseClick (e:MouseEvent):Void

removeToUpdate (display:Refresher):Void

将对象从帧事件移除

 *  @param display -

super3d (pclass:Class<Dynamic>):Void

启动3D引擎渲染

Static variables

@:value(0)staticTEXTURE_COUNT:Int = 0

纹理数量

staticcurrent:Start

当前Start启动器的引用

staticcurrentScale:Float

当前舞台与实际设备尺寸的像素比例

staticfocus:DisplayObject

焦点对象

@:value(true)staticisActivate:Bool = true

应用是否处于活动状态,当离开页面时,该属性会返回false。

@:value(0)staticstageHeight:Int = 0

设定的舞台的高度

@:value(0)staticstageWidth:Int = 0

设定的舞台的宽度

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

onSceneRelease ():Void

当场景释放时,请在这里精准释放所有额外内容。

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

当添加到舞台时

@: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