Skip to content
ClassUI & Typography@public

FlxNineSliceButton

link with a renderer-owned Pixi NineSliceSprite background.

ts
export declare class FlxNineSliceButton extends FlxButton

Properties

PropertyModifiersTypeDescription
bottomHeightreadonlynumber-
leftWidthreadonlynumber-
rightWidthreadonlynumber-
topHeightreadonlynumber-

Methods

createRenderHandle()

ts
createRenderHandle(): FlxNineSliceButtonRenderHandle

Returns: FlxNineSliceButtonRenderHandle

loadGraphic()

ts
loadGraphic(source: FlxGraphic | Texture, animated?: boolean, reverse?: boolean, width?: number, height?: number, unique?: boolean): this

Parameters:

ParameterTypeDescription
sourceFlxGraphic | Texture-
animatedboolean-
reverseboolean-
widthnumber-
heightnumber-
uniqueboolean-

Returns: this

loadNineSliceFrame()

ts
loadNineSliceFrame(atlas: FlxAtlas, name: string, width: number, height: number, borders?: FlxNineSliceBorderInput): this

Parameters:

ParameterTypeDescription
atlasFlxAtlas-
namestring-
widthnumber-
heightnumber-
bordersFlxNineSliceBorderInput-

Returns: this

loadNineSliceGraphic()

ts
loadNineSliceGraphic(source: FlxGraphic | Texture, animated?: boolean, reverse?: boolean, frameWidth?: number, frameHeight?: number, borders?: FlxNineSliceBorderInput, displayWidth?: number, displayHeight?: number): this

Parameters:

ParameterTypeDescription
sourceFlxGraphic | Texture-
animatedboolean-
reverseboolean-
frameWidthnumber-
frameHeightnumber-
bordersFlxNineSliceBorderInput-
displayWidthnumber-
displayHeightnumber-

Returns: this

loadNineSliceTexture()

ts
loadNineSliceTexture(texture: Texture, width: number, height: number, borders?: FlxNineSliceBorderInput): this

Parameters:

ParameterTypeDescription
textureTexture-
widthnumber-
heightnumber-
bordersFlxNineSliceBorderInput-

Returns: this

postUpdate()

ts
postUpdate(): void

Returns: void

setBorders()

ts
setBorders(left: number, top: number, right: number, bottom: number): this

Parameters:

ParameterTypeDescription
leftnumber-
topnumber-
rightnumber-
bottomnumber-

Returns: this

Released under the MIT License.