Editor API
Return to top
AdsButton
Edit

UI / AdsButton

AdsButton Class ​

Advertisement button, please note that it is not allowed to be obscured

Onshow/include is required in the game to play advertisements

When there is any non hidden/folded UI above it, the advertising button will not take effect

Hierarchy ​

Table of contents ​

Properties ​

click

Properties ​

onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
Monitor custom attribute synchronization events

Accessors ​

autoAdjust(): boolean other
Get whether the font is adaptive to adjust: boolean (when true, the font size of text content will automatically change to fill the entire text box as large as possible, while the text box size will not change)
fontColor(): LinearColor other
Get font color
fontLetterSpace(): number other
Get font spacing
fontSize(): number other
Get font size
glyph(): UIFontGlyph other
Get font and glyph shapes
onClose(): MulticastDelegate<(isSuccess: boolean) => void> other
The user manually closes the callback of Ads
onShow(): MulticastDelegate<(isReady: boolean) => void> other
Click the button callback to execute before playing the advertisement
outlineColor(): LinearColor other
Get font outline color
outlineSize(): number other
Get font outline width
shadowColor(): LinearColor other
Get font shadow color
shadowOffset(): Vector2 other
Get font shadow offset
strikethroughEnable(): boolean other
Get whether to enable font strikethrough
text(): string <Badge type="tip" text="other" />
Get button text
textAlign(): TextJustify other
Get font align
textVerticalAlign(): TextVerticalJustify other
Get the vertical alignment of the font
underlineEnable(): boolean other
Return whether to enable font underline
click

Accessors ​

alignPosition(): Readonly<Vector2> other
Get the align position of the widget. When the align method is right align, bottom align, and center align, the value of alignPosition is different from that of position;
autoSizeHorizontalEnable(): boolean other
Get whether to automatically set the size horizontally
autoSizeVerticalEnable(): boolean other
Get whether to set the size automatically vertical
cachedGeometry(): Geometry other
Get the previous Get TickSpaceGeometry
constraints(): Readonly<UIConstraintAnchors> other
Get the layout of the control
desiredSize(): Vector2 other
Obtain expected size
enable(): boolean other
Is it available
guid(): string other
Get the widget GUID
isHovered(): boolean other
Is it hovered
mouseCursor(): MouseCursor other
Get the cursor type on the widget
name(): string other
Get Name
paintSpaceGeometry(): Geometry other
Get the last geometric information used to render the Widget
parent(): Widget other
Get parent node
pivot(): Vector2 other
Get the position of the widget anchor. This property determine the relative position of the widget graph and the anchor; At (0,0), the anchor point is located in the upper left corner of the control; (0.5,0.5), the anchor is at the center of the widget
position(): Readonly<Vector2> other
Get the position of the control
renderOpacity(): number other
Obtain rendering transparency
renderScale(): Vector2 other
Get rendering scaling
renderShear(): Vector2 other
Obtain rendering misalignment deformation
renderTransformAngle(): number other
Obtain the rendering angle
renderTransformPivot(): Vector2 other
Get Render anchor
size(): Vector2 other
Get size
tickSpaceGeometry(): Geometry other
Retrieve the last geometric information used to drive Widget Tick
transform(): Readonly<UITransform> other
Obtain the size and position of the control
visibility(): SlateVisibility other
Get visibility
visible(): boolean other
Is it visible
zOrder(): number other
Get Zorder

Methods ​

addKey(key: Keys): void other
The same button can only control one UI control at a time, and the latest bound UI control will overwrite the previous binding; The binding added in the script cannot override the UI controls bound to the same key in the editor's key binding menu. However, when two UI controls are bound to the same key separately through code and menu, the priority of using code binding is higher
getKeys(): Keys[] other
Get all the keyboard keys bound to the current UI widget, including the editor key binding menu and the code bound keys
removeKey(key: Keys): void other
This operation only unbinds dynamically bound keys and cannot unbind keys bound in the editor's key binding menu
newObject(parent?: Canvas, inName?: string): AdsButton other
Create Button Control
click

Methods ​

addChild(child: Widget): void other
Add child nodes
clone(position: Vector2, Parent?: any): Widget other
Clone the UI widget and its child nodes to the specified parent widget position (default to its parent node)
destroyObject(): void other
Remove and destroy immediately. Cannot be used again
equal(that: Widget): boolean other
Determine if it is the same object
findChildByPath(inPath: string): Widget other
Find nodes by relative path
getChildAt(index: number): Widget other
What is the position node to obtain
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> other
Search for nodes by name
getChildrenCount(): number other
Obtain the number of child nodes
getCustomProperties(): string[] other
Get all customize property
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType other
Get customize property
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
Event proxy triggered when a given object property is modified
invalidateLayoutAndVolatility(): void other
Immediately trigger re rendering and layout calculation
removeAllChildren(): void other
Clearing all child nodes will destroy the UI and render it unusable
removeChild(child: Widget): void other
Removing a node will destroy the UI and make it unusable
removeChildAt(index: number): void other
Removing the third node will destroy the UI and render it unusable
removeObject(): void other
Immediately remove and add to the root node for reuse
serialize(): string other
Serialize UI widget
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void other
Set custom attributes
deserialize(Data: string, Parent?: Widget): Widget other
Deserialize UI

Properties ​

Accessors ​

autoAdjust ​

• get autoAdjust(): boolean other

• set autoAdjust(isAdjust): void other

Get whether the font is adaptive to adjust: boolean (when true, the font size of text content will automatically change to fill the entire text box as large as possible, while the text box size will not change)

Returns ​

booleanIs the font adaptively resized

Set whether the font is adaptive to adjust: boolean (when true, the font size of text content will automatically change to fill the entire text box as large as possible, while the text box size will not change)

Parameters ​

isAdjust booleanUsage: Whether the font is adaptive to adjust

fontColor ​

• get fontColor(): LinearColor other

• set fontColor(inColor): void other

Get font color

Returns ​

LinearColorFont color, TypeLinearColor type, data range 0~1

Set font color

Parameters ​

inColor LinearColorUsage: Font color, TypeLinearColor type, data range 0~1

fontLetterSpace ​

• get fontLetterSpace(): number other

• set fontLetterSpace(fontLetterSpace): void other

Get font spacing

Returns ​

numberFont spacing

Set font spacing

Parameters ​

fontLetterSpace numberUsage: spacing

fontSize ​

• get fontSize(): number other

• set fontSize(FontSize): void other

Get font size

Returns ​

numberfont size

Set font size

Parameters ​

FontSize numberUsage: Size

glyph ​

• get glyph(): UIFontGlyph other

• set glyph(inGlyph): void other

Get font and glyph shapes

Returns ​

UIFontGlyphFont Shape

Set font and glyph shape

Parameters ​

inGlyph UIFontGlyphUsage: Type of font and glyph

onClose ​

• get onClose(): MulticastDelegate<(isSuccess: boolean) => void> other

The user manually closes the callback of Ads

Returns ​

MulticastDelegate<(isSuccess: boolean) => void>Return the proxy of the event

onShow ​

• get onShow(): MulticastDelegate<(isReady: boolean) => void> other

Click the button callback to execute before playing the advertisement

Returns ​

MulticastDelegate<(isReady: boolean) => void>Return the proxy of the event

outlineColor ​

• get outlineColor(): LinearColor other

• set outlineColor(inOutlineColor): void other

Get font outline color

Returns ​

LinearColorFont stroke color, TypeLinearColor type, data range 0~1

Set font outline color

Parameters ​

inOutlineColor LinearColorUsage: Stroke color, TypeLinearColor type, data range 0~1

outlineSize ​

• get outlineSize(): number other

• set outlineSize(inOutlineSize): void other

Get font outline width

Returns ​

numberFont stroke width

Set font outline width

Parameters ​

inOutlineSize numberUsage: Set size

shadowColor ​

• get shadowColor(): LinearColor other

• set shadowColor(inShadowColor): void other

Get font shadow color

Returns ​

LinearColorFont shadow color, TypeLinearColor type, data range 0~1

Set font shadow color

Parameters ​

inShadowColor LinearColorUsage: Input color, TypeLinearColor type, data range 0~1

shadowOffset ​

• get shadowOffset(): Vector2 other

• set shadowOffset(inOffset): void other

Get font shadow offset

Returns ​

Vector2Font Shadow offset

Set font shadow offset

Parameters ​

inOffset Vector2Usage: shadow offset

strikethroughEnable ​

• get strikethroughEnable(): boolean other

• set strikethroughEnable(inEnableStrikethrough): void other

Get whether to enable font strikethrough

Returns ​

booleanDo you want to enable font strikethrough

Set whether to enable font strikethrough

Parameters ​

inEnableStrikethrough booleanUsage: Is it enabled

text ​

• get text(): string other

• set text(InString): void other

Get button text

Returns ​

stringReturn Text

Set button text

Parameters ​

InString stringUsage: Text

new text

textAlign ​

• get textAlign(): TextJustify other

• set textAlign(InTextJustify): void other

Get font align

Returns ​

TextJustifyFont align

Set font align

Parameters ​

InTextJustify TextJustifyUsage: enumeration of align

textVerticalAlign ​

• get textVerticalAlign(): TextVerticalJustify other

• set textVerticalAlign(inTextVerticalJustify): void other

Get the vertical alignment of the font

Returns ​

TextVerticalJustifyFont vertical align

Set font vertical alignment method

Parameters ​

inTextVerticalJustify TextVerticalJustifyUsage: Alignment method

underlineEnable ​

• get underlineEnable(): boolean other

• set underlineEnable(inEnableUnderline): void other

Return whether to enable font underline

Returns ​

booleanGet whether to enable font underline

Set whether to enable font underline

Parameters ​

inEnableUnderline booleanUsage: Set whether to enable underline

Methods ​

addKey ​

• addKey(key): void other

The same button can only control one UI control at a time, and the latest bound UI control will overwrite the previous binding; The binding added in the script cannot override the UI controls bound to the same key in the editor's key binding menu. However, when two UI controls are bound to the same key separately through code and menu, the priority of using code binding is higher

Parameters ​

key KeysUsage: button

getKeys ​

• getKeys(): Keys[] other

Get all the keyboard keys bound to the current UI widget, including the editor key binding menu and the code bound keys

Returns ​

Keys[]Returns the key bound to the current widget, which may be empty

removeKey ​

• removeKey(key): void other

This operation only unbinds dynamically bound keys and cannot unbind keys bound in the editor's key binding menu

Parameters ​

key KeysUsage: button

newObject ​

• Static newObject(parent?, inName?): AdsButton other

Create Button Control

Parameters ​

parent? CanvasUsage: the parent object of the create widget default: null
inName? stringUsage: name of the create widget default: null range: set a reasonable name

Returns ​

AdsButtonReturn the created object

When the parent and inName are the same as an existing object, the old object will be destroyed