API界面 / AdsButton
AdsButton Class
广告按钮，请注意广告按钮不允许被遮挡
需要在游戏中使用 onshow/onclose 才能播放广告
当其上方有任何非隐藏/折叠的UI时，广告按钮将无法生效
Hierarchy
↳
AdsButton
Table of contents
Accessors
autoAdjust(): boolean client |
|---|
| 获取字体是否自适应调整大小:boolean(为True时，文本内容字体大小将自动改变，尽可能大的充满整个文本框，而文本框大小不会变化) |
fontColor(): LinearColor client |
| 获取字体颜色 |
fontLetterSpace(): number client |
| 获取字体间距 |
fontSize(): number client |
| 获取字体大小 |
glyph(): UIFontGlyph client |
| 获取字体字形 |
onClose(): MulticastDelegate<(isSuccess: boolean) => void> client |
| 用户手动关闭广告的回调 |
onShow(): MulticastDelegate<(isReady: boolean) => void> client |
| 点击按钮的回调，播放广告前执行 |
outlineColor(): LinearColor client |
| 获取字体描边颜色 |
outlineSize(): number client |
| 获取字体描边宽度 |
shadowColor(): LinearColor client |
| 获取字体阴影颜色 |
shadowOffset(): Vector2 client |
| 获取字体阴影偏移 |
strikethroughEnable(): boolean client |
| 获取是否开启字体删除线 |
text(): string <Badge type="tip" text="client" /> |
| 获取按钮文字 |
textAlign(): TextJustify client |
| 获取字体对齐方式 |
textVerticalAlign(): TextVerticalJustify client |
| 获取字体垂直对齐方式 |
underlineEnable(): boolean client |
| 返回是否开启字体下划线 |
click
Accessors
alignPosition(): Readonly<Vector2> client |
|---|
| 获取控件的对齐位置,在对齐方式为靠右对齐、靠下对齐、中心对齐时，alignPosition的值与positon不同； |
autoSizeHorizontalEnable(): boolean client |
| 获取是否自动水平设置大小 |
autoSizeVerticalEnable(): boolean client |
| 获取是否自动垂直设置大小 |
cachedGeometry(): Geometry client |
| 获取上一次的GetTickSpaceGeometry |
constraints(): Readonly<UIConstraintAnchors> client |
| 获取控件的布局 |
desiredSize(): Vector2 client |
| 获取期望大小 |
enable(): boolean client |
| 是否可用 |
guid(): string client |
| 获取控件GUID |
isHovered(): boolean client |
| 是否是hovered |
mouseCursor(): MouseCursor client |
| 获取控件上光标类型 |
name(): string client |
| 获取名字 |
paintSpaceGeometry(): Geometry client |
| 获取最后一次用于渲染Widget的几何信息 |
parent(): Widget client |
| 获取父节点 |
pivot(): Vector2 client |
| 获取控件锚点位置,这个属性决定了控件图形与锚点的相对位置；(0,0)时，锚点位于控件左上角；(0.5,0.5)时，锚点位于控件正中心 |
position(): Readonly<Vector2> client |
| 获取控件的位置 |
renderOpacity(): number client |
| 获取渲染透明度 |
renderScale(): Vector2 client |
| 获取渲染缩放 |
renderShear(): Vector2 client |
| 获取渲染错切形变 |
renderTransformAngle(): number client |
| 获取渲染的角度 |
renderTransformPivot(): Vector2 client |
| 获取渲染锚点 |
size(): Vector2 client |
| 获取大小 |
tickSpaceGeometry(): Geometry client |
| 获取最后一次用于驱动Widget Tick的几何信息 |
transform(): Readonly<UITransform> client |
| 得到控件的大小和位置 |
visibility(): SlateVisibility client |
| 获取可见性 |
visible(): boolean client |
| 是否可见 |
zOrder(): number client |
| 获取zorder |
Methods
addKey(key: Keys): void client |
|---|
| 同一按键同时只能操控一个UI控件，最新绑定的UI控件会覆盖之前的绑定；脚本中添加的绑定无法覆盖编辑器按键绑定菜单中绑定相同按键的UI控件，但当两个UI控件分别通过代码和菜单绑定到同一按键时，使用代码绑定的优先级更高 |
getKeys(): Keys[] client |
| 获取当前UI控件绑定的所有键盘按键，包括编辑器按键绑定菜单和用代码绑定的按键 |
removeKey(key: Keys): void client |
| 此操作只会解绑动态绑定的按键无法解除编辑器按键绑定菜单中绑定的按键 |
newObject(parent?: Canvas, inName?: string): AdsButton client |
| 创建 Button 控件 |
click
Methods
addChild(child: Widget): void client |
|---|
| 添加子节点 |
clone(position: Vector2, Parent?: any): Widget client |
| 克隆UI控件及其子节点到指定父控件位置（默认到其父节点） |
destroyObject(): void client |
| 立刻移除并销毁 不可以在使用 |
equal(that: Widget): boolean client |
| 判断是不是同一个对象 |
findChildByPath(inPath: string): Widget client |
| 通过相对路径查找节点 |
getChildAt(index: number): Widget client |
| 获取第几位子节点 |
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> client |
| 通过名字查找节点 |
getChildrenCount(): number client |
| 获取子节点数量 |
invalidateLayoutAndVolatility(): void client |
| 立刻触发重新渲染的和排布计算 |
removeAllChildren(): void client |
| 清除所有子节点,会销毁UI无法再使用 |
removeChild(child: Widget): void client |
| 移除节点,会销毁UI无法在使用 |
removeChildAt(index: number): void client |
| 移除第几个节点,会销毁UI无法再使用 |
removeObject(): void client |
| 立刻移除并添加到根节点 可以再使用 |
serialize(): string client |
| 序列化UI控件 |
deserialize(Data: string, Parent?: Widget): Widget client |
| 反序列化UI |
Accessors
autoAdjust
• | • | ||||
|---|---|---|---|---|---|
获取字体是否自适应调整大小:boolean(为True时，文本内容字体大小将自动改变，尽可能大的充满整个文本框，而文本框大小不会变化) Returns
| 设置字体是否自适应调整大小:boolean(为True时，文本内容字体大小将自动改变，尽可能大的充满整个文本框，而文本框大小不会变化) Parameters
|
fontColor
• | • | ||||
|---|---|---|---|---|---|
获取字体颜色 Returns
| 设置字体颜色 Parameters
|
fontLetterSpace
• | • | ||||
|---|---|---|---|---|---|
获取字体间距 Returns
| 设置字体间距 Parameters
|
fontSize
• | • | ||||
|---|---|---|---|---|---|
获取字体大小 Returns
| 设置字体大小 Parameters
|
glyph
• | • | ||||
|---|---|---|---|---|---|
获取字体字形 Returns
| 设置字体字形 Parameters
|
onClose
• | ||
|---|---|---|
用户手动关闭广告的回调 Returns
|
onShow
• | ||
|---|---|---|
点击按钮的回调，播放广告前执行 Returns
|
outlineColor
• | • | ||||
|---|---|---|---|---|---|
获取字体描边颜色 Returns
| 设置字体描边颜色 Parameters
|
outlineSize
• | • | ||||
|---|---|---|---|---|---|
获取字体描边宽度 Returns
| 设置字体描边宽度 Parameters
|
shadowColor
• | • | ||||
|---|---|---|---|---|---|
获取字体阴影颜色 Returns
| 设置字体阴影颜色 Parameters
|
shadowOffset
• | • | ||||
|---|---|---|---|---|---|
获取字体阴影偏移 Returns
| 设置字体阴影偏移 Parameters
|
strikethroughEnable
• | • | ||||
|---|---|---|---|---|---|
获取是否开启字体删除线 Returns
| 设置是否开启字体删除线 Parameters
|
text
• | • | ||||
|---|---|---|---|---|---|
获取按钮文字 Returns
| 设置按钮文字 Parameters
新文本 |
textAlign
• | • | ||||
|---|---|---|---|---|---|
获取字体对齐方式 Returns
| 设置字体对齐方式 Parameters
|
textVerticalAlign
• | • | ||||
|---|---|---|---|---|---|
获取字体垂直对齐方式 Returns
| 设置字体垂直对齐方式 Parameters
|
underlineEnable
• | • | ||||
|---|---|---|---|---|---|
返回是否开启字体下划线 Returns
| 设置是否开启字体下划线 Parameters
|
Methods
addKey
• addKey(key): void client
同一按键同时只能操控一个UI控件，最新绑定的UI控件会覆盖之前的绑定；脚本中添加的绑定无法覆盖编辑器按键绑定菜单中绑定相同按键的UI控件，但当两个UI控件分别通过代码和菜单绑定到同一按键时，使用代码绑定的优先级更高
Parameters
key Keys | 按键 |
|---|
getKeys
• getKeys(): Keys[] client
获取当前UI控件绑定的所有键盘按键，包括编辑器按键绑定菜单和用代码绑定的按键
Returns
Keys[] | 返回当前控件绑定的按键,可能为空 |
|---|
removeKey
• removeKey(key): void client
此操作只会解绑动态绑定的按键无法解除编辑器按键绑定菜单中绑定的按键
Parameters
key Keys | 按键 |
|---|
newObject
• Static newObject(parent?, inName?): AdsButton client
创建 Button 控件
Parameters
parent? Canvas | 创建控件的外parent对象 default: null |
|---|---|
inName? string | 创建控件的名称 default:null range:设置合理的名称即可 |
Returns
AdsButton | 返回创建的对象 |
|---|
当parent和inName与已有的对象相同时，旧的对象会被销毁