IButton 控件·按钮 Control·Button

构造函数 Constructor

构造函数 Constructor说明 Description 备注 Note


bmp2(Image)按钮按下后的位图 bitmap showed on button after button is pressed

txt(string) 按钮上的文字 可缺省 the text on the button ("txt" can be default)

viewprot(IViewprot) 按钮所归属的视窗 可缺省 the viewport which button belonged to ("viewprot" can be default)

isNeedDraw(bool) 需要生成单独绘制精灵 可缺省 to generate a sprite on the button to draw("isNeedDraw" can be default)

属性 Attribute

属性 Attribute说明 Description 备注 Note
tag(any) 绑定在button上的数据 Data binding on button
onload(function) 设置按钮的资源读取回调函数 Set function for callback of reading resource 仅Web有效,其他端直接执行函数内容 Only web is valid, others will directly execute function
x(Number) 设置或获得 按钮的x坐标 Set or get the x-coordinate of button
y(Number) 设置或获得 按钮的y坐标 Set or get the y-coordinate of button
z(Number) 设置或获得 按钮的图层 Set or get the layer of button
zoomX(Number) 设置或获得 按钮的X方向缩放率 Set or get the horizontal scaling rate of the button
zoomY(Number) 设置或获得 按钮的Y方向缩放率 Set or get the vertical scaling rate of the button
visible(bool) 设置按钮是否可见 Whether the button is visible or not

设置按钮的不透明度 Set button opacity

取值范围0~1 Range 0 ~ 1

width(Number) 获得按钮宽度 Get button width 只读 Read-only
height(Number) 获得按钮高度 Get button height 只读 Read-only

函数 Function

函数 Function 说明 Description 备注 Note

重新绘制按钮文字 Redraw button text

str(string) 要绘制的文字,支持转译 text to draw. Translation is supported

x(Number) 相对于按钮的x坐标 relative to the x-coordinate of button

y(Number) 相对于按钮的y坐标 relative to the y-coordinate of button


高效重新绘制按钮文字 Efficient redrawing the button text

str(string) 要绘制的文字 text to draw

color(IColor) 文字颜色 text color

size(Number) 文字大小 text size

文字在居中位置 text-centered

转换按钮类型 Switch button style

tp(Number) -1 默认双图片样式 double image style is default

0 单图片样式 single image style

sn 单图片按下缩放率 scaling rate of pressing single image


设置按钮圆心点位置 Set centre position of button

yx 圆心x 取值0~1 centre x ,value 0 ~ 1

yy 圆心y 取值0~1 centre y ,value 0 ~ 1


重新设置按钮图片 Reset button images

bmp1 未按下图片 image showed without pressing

bmp2 按下图片 image showed when pressing

dispose 释放之前的图片 free up previous images



返回值 ISprite Return ISprite


获得绘制文字的精灵(需要在构造时txt 不为空字符串才可获取)

返回值ISprite Return ISprite

dispose() 释放按钮资源 Free up button resources
disposeMin() 释放按钮索引资源,保留按钮图片资源 Free up button index resource but retain button image resource
exchange() 交换设置的按下状态与未按下状态的图片 Exchange images of pressing with not pressing

按钮是否被选中 Whether the button be selected or not

返回值 Bool Return Bool


设置按钮不可用情况的图片 Set images that will replace when the button is unavailable

bmp(Image) 位图 bitmap

setEnable(b) 设置按钮的可用状态 Set the available status of the button

获得按钮的可用状态 Get the state that whether the button is available or not

返回值 Bool Return Bool


按钮是否被鼠标悬停 Whether hover the button or not

返回值 Bool Return Bool

仅PC端有效 PC Only
cancelSelect() 取消按钮选择 Cancel button selection

按钮是否按下 Whether the button be pressed or not

返回值 Bool Return Bool


获得按钮的基本精灵 Get the sprite of the button

返回值 Isprite Return Isprite


按钮的主刷新逻辑 Main update logic of button

返回值 Bool(按钮是否被按下) Return Bool (button pressed or not)

此函数需要放进状态机中动画才能有实际效果 This function will work in statemachine

设置按钮淡入淡出动画 Fade in and out of the button

bo(Number) 起始不透明度 initial opacity

eo(Number) 结束不透明度 end opacity

fadeTo(o, frame)

设置按钮从当前不透明度起的淡入淡出动画 Fade in and out of the button from the current opacity

o(Number) 目标不透明度 target opacity

frame(Number)帧数 frame rate

slide(bx, by,ex,ey, frame)

设置按钮位移动画 Set coordinates to make the button move

bx(Number) 起始x坐标 initial x

by(Number) 起始y坐标 initial y

ex(Number) 目标x坐标 target x

ey(Number) 目标y坐标 target y

frame(Number) 所需帧数 frame rate

slideTo( x, y, frame)

设置按钮从当前位置到目标位置的移动动画 Set coordinates to make the button move from the current position to the target position

x(Number) 目标x坐标 target x

y(Number) 目标y坐标 target y

frame(Number) 所需帧数 frame rate

scale( bzx, bzy,ezx,ezy, frame)

设置按钮缩放动画 Set the scaling rate to zoom button

bzx(Number) 起始x轴缩放率 initial scaling rate of x

bzy(Number) 起始y轴缩放率 initial scaling rate of y

ezx(Number) 目标x轴缩放率 target scaling rate of x

ezy(Number) 目标y轴缩放率 target scaling rate of y

frame(Number) 帧率 frame rate

scaleTo( zx, zy, frame)

设置按钮从当前缩放率到目标缩放率的动画 Set the scaling rate from current to target to zoom the button

zx(Number) 目标x轴缩放率 target scaling rate of x

zy(Number) 目标y轴缩放率 target scaling rate of y

frame(Number) 帧率 frame rate


设置按钮动作序列 Set button action sequence

action(action枚举) (action enumeration)

args(多参数) 具体动作参数 (multi parameter)Specific action parameters

setActLoop( loop)

是否重复执行动作序列 Whether repeat action or not

loop(bool) true为重复执行 true means loop

false 只执行一次 false means not loop