UISprite | 小游戏框架

图片组件。

export

Hierarchy

Renderable2D
- UISprite

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UISprite(entity: Entity): UISprite

Inherited from Renderable2D.constructor
- Defined in src/engine/game/component.ts:125
Parameters
- entity: Entity
Returns UISprite

Properties

Readonly entity

entity: Entity2D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static BlendMode

BlendMode: Readonly<typeof BlendMode> = ...

二维渲染叠加混合方式

static
memberof: Renderable2D

Static BlendType

BlendType: Readonly<typeof BlendType> = ...

继承混合颜色的方式

static
memberof: Renderable2D

Static FillDirectionType

FillDirectionType: Readonly<typeof UISpriteFillDirectionType> = ...

图片填充方式枚举值。

static
memberof: UISprite

Static FlipType

FlipType: Readonly<typeof UISpriteFlipType> = ...

图片翻转类型枚举值。

static
memberof: UISprite

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

Align: number
Layout: number
Low: number
Physics: number
Render: number
Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Static Type

Type: Readonly<typeof UISpriteType> = ...

图片显示类型枚举值。

static
memberof: UISprite

Accessors

active

get active(): boolean
set active(value: boolean): void

- Defined in src/engine/game/component.ts:57
Returns boolean
- Defined in src/engine/game/component.ts:60
Parameters
- value: boolean
Returns void

activeInHierarchy

get activeInHierarchy(): boolean

- Defined in src/engine/game/component.ts:79
在场景树中是否active

readonly

memberof

Component

Returns boolean

alpha

get alpha(): number
set alpha(val: number): void

- Defined in src/engine/game/2D/renderable2D.ts:311
Returns number
- Defined in src/engine/game/2D/renderable2D.ts:294
Parameters
- val: number
Returns void

blendMode

get blendMode(): BlendMode
set blendMode(val: BlendMode): void

- Defined in src/engine/game/2D/renderable2D.ts:233
当前渲染元素的混合方式

Returns BlendMode
- Defined in src/engine/game/2D/renderable2D.ts:224
当前渲染元素的混合方式

overload

memberof

Renderable2D

Parameters
- val: BlendMode
Returns void

color

get color(): Color
set color(val: Color): void

- Defined in src/engine/game/2D/renderable2D.ts:287
渲染组件本身的颜色，用于与渲染元素进行颜色混合

Returns Color
- Defined in src/engine/game/2D/renderable2D.ts:271
渲染组件本身的颜色，用于与渲染元素进行颜色混合

memberof

Renderable2D

Parameters
- val: Color
Returns void

colorBlendType

get colorBlendType(): BlendType
set colorBlendType(val: BlendType): void

- Defined in src/engine/game/2D/renderable2D.ts:335
渲染组件继承父渲染组件颜色，颜色混合的方式

Returns BlendType
- Defined in src/engine/game/2D/renderable2D.ts:327
渲染组件继承父渲染组件颜色，颜色混合的方式

overload

memberof

Renderable2D

Parameters
- val: BlendType
Returns void

cullingMask

get cullingMask(): number
set cullingMask(val: number): void

- Defined in src/engine/game/2D/renderable2D.ts:343
Returns number
- Defined in src/engine/game/2D/renderable2D.ts:350
deprecated

Parameters
- val: number
Returns void

fillAmount

get fillAmount(): number
set fillAmount(fillAmount: number): void

- Defined in src/engine/game/2D/UISprite.ts:295
图片填充模式下的填充程度，范围0~1。

memberof

UISprite

Returns number
- Defined in src/engine/game/2D/UISprite.ts:299
图片填充模式下的填充程度，范围0~1。

Parameters
- fillAmount: number
Returns void

fillDir

get fillDir(): UISpriteFillDirectionType
set fillDir(fillDir: UISpriteFillDirectionType): void

- Defined in src/engine/game/2D/UISprite.ts:273
图片填充模式下的填充方式。

memberof

UISprite

Returns UISpriteFillDirectionType
- Defined in src/engine/game/2D/UISprite.ts:277
图片填充模式下的填充方式。

Parameters
- fillDir: UISpriteFillDirectionType
Returns void

flip

get flip(): UISpriteFlipType
set flip(flip: UISpriteFlipType): void

- Defined in src/engine/game/2D/UISprite.ts:222
图片的翻转类型。

Returns UISpriteFlipType
- Defined in src/engine/game/2D/UISprite.ts:214
图片的翻转类型。

memberof

UISprite

Parameters
- flip: UISpriteFlipType
Returns void

grayScale

get grayScale(): boolean
set grayScale(val: boolean): void

- Defined in src/engine/game/2D/UISprite.ts:382
是否使用灰阶。

memberof

UISprite

Returns boolean
- Defined in src/engine/game/2D/UISprite.ts:386
是否使用灰阶。

Parameters
- val: boolean
Returns void

invertFill

get invertFill(): boolean
set invertFill(invertFill: boolean): void

- Defined in src/engine/game/2D/UISprite.ts:317
图片填充模式下是否反向填充。

memberof

UISprite

Returns boolean
- Defined in src/engine/game/2D/UISprite.ts:321
图片填充模式下是否反向填充。

Parameters
- invertFill: boolean
Returns void

isMask

get isMask(): boolean

- Defined in src/engine/game/2D/renderable2D.ts:339
Returns boolean

material

get material(): Material
set material(val: Material): void

- Defined in src/engine/game/2D/renderable2D.ts:257
当前渲染元素的混合方式

Returns Material
- Defined in src/engine/game/2D/renderable2D.ts:248
当前渲染元素的混合方式

overload

memberof

Renderable2D

Parameters
- val: Material
Returns void

spriteFrame

get spriteFrame(): SpriteFrame | OpenData
set spriteFrame(value: SpriteFrame | OpenData): void

- Defined in src/engine/game/2D/UISprite.ts:340
图片资源。

memberof

UISprite

Returns SpriteFrame | OpenData
- Defined in src/engine/game/2D/UISprite.ts:344
图片资源。

Parameters
- value: SpriteFrame | OpenData
Returns void

tileScale

get tileScale(): number
set tileScale(tileScale: number): void

- Defined in src/engine/game/2D/UISprite.ts:235
图片tiled模式下的缩放。

memberof

UISprite

Returns number
- Defined in src/engine/game/2D/UISprite.ts:239
图片tiled模式下的缩放。

Parameters
- tileScale: number
Returns void

type

get type(): UISpriteType
set type(type: UISpriteType): void

- Defined in src/engine/game/2D/UISprite.ts:202
图片的显示类型。

Returns UISpriteType
- Defined in src/engine/game/2D/UISprite.ts:195
图片的显示类型。

memberof

UISprite

Parameters
- type: UISpriteType
Returns void

visible

get visible(): boolean
set visible(val: boolean): void

- Defined in src/engine/game/2D/renderable2D.ts:190
渲染组件是否具体渲染

Returns boolean
- Defined in src/engine/game/2D/renderable2D.ts:182
渲染组件是否具体渲染

overload

memberof

Renderable2D

Parameters
- val: boolean
Returns void

zOrder

get zOrder(): number
set zOrder(val: number): void

- Defined in src/engine/game/2D/renderable2D.ts:212
渲染组件在同级的渲染顺序

Returns number
- Defined in src/engine/game/2D/renderable2D.ts:204
渲染组件在同级的渲染顺序

overload

memberof

Renderable2D

Parameters
- val: number
Returns void

Methods

destroy

destroy(): void

Inherited from Renderable2D.destroy
- Defined in src/engine/game/component.ts:133
Returns void

getMaterialAtIndex

getMaterialAtIndex(index?: number): FakeMaterial

Inherited from Renderable2D.getMaterialAtIndex
- Defined in src/engine/game/2D/renderable2D.ts:620
Parameters
- index: number = 0
Returns FakeMaterial

getMaterialCount

getMaterialCount(): number

Inherited from Renderable2D.getMaterialCount
- Defined in src/engine/game/2D/renderable2D.ts:607
Returns number

getTypeName

getTypeName(): string

Inherited from Renderable2D.getTypeName
- Defined in src/engine/game/component.ts:129
Returns string

isDetached

isDetached(): boolean

Inherited from Renderable2D.isDetached
- Defined in src/engine/game/component.ts:145
Returns boolean

resetProperties

resetProperties(): void

Inherited from Renderable2D.resetProperties
- Defined in src/engine/game/component.ts:169
Returns void

setMaterialDirty

setMaterialDirty(): void

Inherited from Renderable2D.setMaterialDirty
- Defined in src/engine/game/2D/renderable2D.ts:924
对外暴露的，将渲染元素对应RenderDraw的材质信息置脏

Returns void

setVertexDirty

setVertexDirty(): void

Inherited from Renderable2D.setVertexDirty
- Defined in src/engine/game/2D/renderable2D.ts:915
对外暴露的，将渲染元素对应RenderDraw的顶点数据置脏逻辑

Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

Returns UISprite

Properties

Readonly entity

Readonly id

Readonly isDestroyed

Readonly isDestroying

Readonly priority

Static BlendMode

Static BlendType

Static FillDirectionType

Static FlipType

Static Priority

Type declaration

Align: number

Layout: number

Low: number

Physics: number

Render: number

Tool: number

Static Optional Serialize

Type declaration

Parameters

Rest ...args: any[]

Returns any

Static Type

Accessors

active

Returns boolean

Parameters

value: boolean

Returns void

activeInHierarchy

Returns boolean

alpha

Returns number

Parameters

val: number

Returns void

blendMode

Returns BlendMode

Parameters

val: BlendMode

Returns void

color

Returns Color

Parameters

val: Color

Returns void

colorBlendType

Returns BlendType

Parameters

val: BlendType

Returns void

cullingMask

Returns number

Parameters

val: number

Returns void

fillAmount

Returns number

Parameters

fillAmount: number

Returns void

fillDir

Returns UISpriteFillDirectionType

Parameters

fillDir: UISpriteFillDirectionType

Returns void

flip

Returns UISpriteFlipType