类 TileMapLayer

2D 渲染基类

层级 (查看完整内容)

BaseRenderNode2D
- TileMapLayer

索引

属性

_extra _id _singleton owner runInEditor scriptPath BASERENDER2DCOLOR BASERENDER2DTEXTURE BASERENDERSIZE NORMAL2DSTRENGTH NORMAL2DTEXTURE SHADERDEFINE_BASERENDER2D SHADERDEFINE_LIGHT2D_ADDMODE SHADERDEFINE_LIGHT2D_EMPTY SHADERDEFINE_LIGHT2D_ENABLE SHADERDEFINE_LIGHT2D_NORMAL_PARAM SHADERDEFINE_LIGHT2D_SUBMODE

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

Blueprint Ignore

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

`只读`owner

owner: Sprite

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

Blueprint Ignore

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

Blueprint Ignore

`静态` `只读`BASERENDER2DCOLOR

BASERENDER2DCOLOR: number

渲染节点颜色ID

`静态` `只读`BASERENDER2DTEXTURE

BASERENDER2DTEXTURE: number

渲染节点纹理ID

`静态` `只读`BASERENDERSIZE

BASERENDERSIZE: number

渲染节点size ID

`静态` `只读`NORMAL2DSTRENGTH

NORMAL2DSTRENGTH: number

`静态` `只读`NORMAL2DTEXTURE

NORMAL2DTEXTURE: number

渲染节点纹理ID

`静态` `只读`SHADERDEFINE_BASERENDER2D

SHADERDEFINE_BASERENDER2D: ShaderDefine

2D渲染节点宏

`静态` `只读`SHADERDEFINE_LIGHT2D_ADDMODE

SHADERDEFINE_LIGHT2D_ADDMODE: ShaderDefine

`静态` `只读`SHADERDEFINE_LIGHT2D_EMPTY

SHADERDEFINE_LIGHT2D_EMPTY: ShaderDefine

`静态` `只读`SHADERDEFINE_LIGHT2D_ENABLE

SHADERDEFINE_LIGHT2D_ENABLE: ShaderDefine

2D灯光宏

`静态` `只读`SHADERDEFINE_LIGHT2D_NORMAL_PARAM

SHADERDEFINE_LIGHT2D_NORMAL_PARAM: ShaderDefine

`静态` `只读`SHADERDEFINE_LIGHT2D_SUBMODE

SHADERDEFINE_LIGHT2D_SUBMODE: ShaderDefine

访问器

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 BaseRenderNode2D.awaked
- 定义于 src/layaAir/laya/components/Component.ts:136

boundsChange

get boundsChange(): boolean
返回 boolean
继承自 BaseRenderNode2D.boundsChange
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:224
set boundsChange(value): void
参数
- value: boolean
返回 void
继承自 BaseRenderNode2D.boundsChange
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:227

chunkDatas

set chunkDatas(datas): void
参数
- datas: Record<number, Record<number, TileMapChunkData>>
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:121

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 BaseRenderNode2D.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:144

enabled

get enabled(): boolean
返回 boolean
En
whether the component is enabled.

Zh
是否启用组件。
继承自 BaseRenderNode2D.enabled
- 定义于 src/layaAir/laya/components/Component.ts:120
set enabled(value): void
参数
- value: boolean
返回 void
继承自 BaseRenderNode2D.enabled
- 定义于 src/layaAir/laya/components/Component.ts:124

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 BaseRenderNode2D.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:70
set hideFlags(value): void
参数
- value: number
返回 void
继承自 BaseRenderNode2D.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:74

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 BaseRenderNode2D.id
- 定义于 src/layaAir/laya/components/Component.ts:112

layer

get layer(): number
返回 number
En
render layer

Zh
渲染层。
继承自 BaseRenderNode2D.layer
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:337
set layer(value): void
参数
- value: number
返回 void
继承自 BaseRenderNode2D.layer
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:341

layerColor

get layerColor(): Color
返回 Color
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:137
set layerColor(value): void
参数
- value: Color
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:141

lightOccluderEnable

get lightOccluderEnable(): boolean
返回 boolean
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:173
set lightOccluderEnable(value): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:177

lightReceive

get lightReceive(): boolean
返回 boolean
继承自 BaseRenderNode2D.lightReceive
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:367
set lightReceive(value): void
参数
- value: boolean
返回 void
继承自 BaseRenderNode2D.lightReceive
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:354

navigationEnable

get navigationEnable(): boolean
返回 boolean
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:156
set navigationEnable(value): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:160

physicsEnable

get physicsEnable(): boolean
返回 boolean
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:164
set physicsEnable(value): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:168

rect

get rect(): Vector4
获取渲染范围

返回 Vector4
重写了 BaseRenderNode2D.rect
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:440

renderLayer

get renderLayer(): number
获取渲染层掩码

返回 number
继承自 BaseRenderNode2D.renderLayer
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:201
set renderLayer(value): void
设置渲染层掩码
参数
- value: number
返回 void
继承自 BaseRenderNode2D.renderLayer
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:208

renderTileSize

get renderTileSize(): number
返回 number
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:200
set renderTileSize(value): void
参数
- value: number
  how many tiles in a chunk.
返回 void
En
The size of the chunk, when set, it will recalculate the range of all tiles.

Zh
设置chunk 的尺寸,当设置后会重新计算所有格子的范围
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:210

sharedMaterial

get sharedMaterial(): Material
返回 Material
En
get first Material

Zh
第一个材质。
继承自 BaseRenderNode2D.sharedMaterial
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:415
set sharedMaterial(value): void
参数
- value: Material
返回 void
继承自 BaseRenderNode2D.sharedMaterial
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:419

sortMode

get sortMode(): TileLayerSortMode
返回 TileLayerSortMode
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:148
set sortMode(value): void
参数
- value: TileLayerSortMode
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:152

tileMapDatas

get tileMapDatas(): Uint8Array
返回 Uint8Array
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:216
set tileMapDatas(value): void
参数
- value: Uint8Array
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:220

tileMapOccluder

get tileMapOccluder(): TileMapOccluderAgent
返回 TileMapOccluderAgent
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:228

tileMapPhysics

get tileMapPhysics(): TileMapPhysics
返回 TileMapPhysics
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:224

tileSet

get tileSet(): TileSet
返回 TileSet
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:182
set tileSet(value): void
参数
- value: TileSet
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:186

方法

_globalChangeHandler

_globalChangeHandler(): void
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:407

_resetUpdateMark

_resetUpdateMark(): void
返回 void
继承自 BaseRenderNode2D._resetUpdateMark
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:371

_setCellData

_setCellData(x, y, cellData, transFlag?, isPixel?): void
添加一个格子
参数
- x: number
  横向坐标
- y: number
  纵向坐标
- cellData: TileSetCellData
  格子数据
- transFlag: number = 0
  位操作
- isPixel: boolean = true
  是否是像素坐标 true: 像素坐标 false: 格子坐标
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:614

_updateLight

_updateLight(): void
返回 void
继承自 BaseRenderNode2D._updateLight
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:375

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 BaseRenderNode2D.destroy
- 定义于 src/layaAir/laya/components/Component.ts:294

getCellData

getCellData(x, y, isPixel?): ChunkCellInfo
获取一个CellData数据
参数
- x: number
- y: number
- isPixel: boolean = true
  是否是像素坐标 true: 像素坐标 false: 格子坐标
返回 ChunkCellInfo
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:637

getDefalutMaterial

getDefalutMaterial(texture): Material
参数
- texture: Texture2D
返回 Material
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:686

getRenderID

getRenderID(): number
返回 number
获得ID

En
Get 2D render component ID

Zh
获得2D渲染组件标识ID
继承自 BaseRenderNode2D.getRenderID
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:440

gridToPixel

gridToPixel(cellRow, cellCol, out): void
格子系统转像素系统
参数
- cellRow: number
- cellCol: number
- out: Vector2
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:681

hasHideFlag

hasHideFlag(flag): boolean
参数
- flag: number
  The hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.

Zh
检查组件是否设置了特定的隐藏标志。
继承自 BaseRenderNode2D.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:104

onAdded

onAdded(): void
返回 void
En
Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

Zh
组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。

Blueprint Event
继承自 BaseRenderNode2D.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:336

onAwake

onAwake(): void
返回 void
En
Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

Zh
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。

Blueprint Event
重写了 BaseRenderNode2D.onAwake
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:379

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

Zh
手动调用节点销毁时执行。

Blueprint Event
重写了 BaseRenderNode2D.onDestroy
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:401

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

Zh
组件被禁用时执行，比如从节点从舞台移除后。

Blueprint Event
重写了 BaseRenderNode2D.onDisable
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:394

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

Zh
组件被启用后执行，比如节点被添加到舞台后。

Blueprint Event
重写了 BaseRenderNode2D.onEnable
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:385

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。

Blueprint Event
继承自 BaseRenderNode2D.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。

Blueprint Event
继承自 BaseRenderNode2D.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:396

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。

Blueprint Event
继承自 BaseRenderNode2D.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:389

`可选`onReset

onReset(): void
返回 void
En
Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

Zh
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 BaseRenderNode2D.onReset
- 定义于 src/layaAir/laya/components/Component.ts:345

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

Zh
在第一次执行 update 之前执行，只会执行一次。

Blueprint Default Event
继承自 BaseRenderNode2D.onStart
- 定义于 src/layaAir/laya/components/Component.ts:368

`可选`onUpdate

onUpdate(): void
返回 void
En
Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

Zh
每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。

Blueprint Event
继承自 BaseRenderNode2D.onUpdate
- 定义于 src/layaAir/laya/components/Component.ts:375

pixelToGrid

pixelToGrid(pixelX, pixelY, out): void
像素系统转格子系统
参数
- pixelX: number
- pixelY: number
- out: Vector2
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:674

removeCell

removeCell(x, y, isPixel?): void
移除一个格子
参数
- x: number
  横向坐标
- y: number
  纵向坐标
- isPixel: boolean = true
  是否是像素坐标 true: 像素坐标 false: 格子坐标
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:658

renderUpdate

renderUpdate(context): void
根据相机和设置做裁剪;更新所有格子的渲染数据
参数
- context: IRenderContext2D
返回 void
重写了 BaseRenderNode2D.renderUpdate
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:497

setCellData

setCellData(x, y, cellData, isPixel?, rotateCount?, flipH?, flipV?, transpose?): void
添加一个格子
参数
- x: number
  横向坐标
- y: number
  纵向坐标
- cellData: TileSetCellData
  格子数据
- isPixel: boolean = true
  是否是像素坐标 true: 像素坐标 false: 格子坐标
- rotateCount: number = 0
  旋转次数
- flipH: boolean = false
  水平翻转
- flipV: boolean = false
  垂直翻转
- transpose: boolean = false
  斜角翻转
返回 void
- 定义于 src/layaAir/laya/tilemap/TileMapLayer.ts:602

类 TileMapLayer

层级 (查看完整内容)

索引

属性

访问器

方法

属性

_extra

En

Zh

Blueprint Ignore

_id

En

Zh

_singleton

En

Zh

只读owner

En

Zh

runInEditor

En

Zh

Blueprint Ignore

scriptPath

En

Zh

Blueprint Ignore

静态 只读BASERENDER2DCOLOR

静态 只读BASERENDER2DTEXTURE

静态 只读BASERENDERSIZE

静态 只读NORMAL2DSTRENGTH

静态 只读NORMAL2DTEXTURE

静态 只读SHADERDEFINE_BASERENDER2D

静态 只读SHADERDEFINE_LIGHT2D_ADDMODE

静态 只读SHADERDEFINE_LIGHT2D_EMPTY

静态 只读SHADERDEFINE_LIGHT2D_ENABLE

静态 只读SHADERDEFINE_LIGHT2D_NORMAL_PARAM

静态 只读SHADERDEFINE_LIGHT2D_SUBMODE

访问器

awaked

返回 boolean

En

Zh

boundsChange

返回 boolean

参数

返回 void

chunkDatas

参数

返回 void

destroyed

返回 boolean

En

Zh

enabled

返回 boolean

En

Zh

参数

返回 void

hideFlags

返回 number

En

Zh

参数

返回 void

id

返回 number

En

Zh

layer

返回 number

En

Zh

参数

返回 void

layerColor

返回 Color

参数

`只读`owner

`静态` `只读`BASERENDER2DCOLOR

`静态` `只读`BASERENDER2DTEXTURE

`静态` `只读`BASERENDERSIZE

`静态` `只读`NORMAL2DSTRENGTH

`静态` `只读`NORMAL2DTEXTURE

`静态` `只读`SHADERDEFINE_BASERENDER2D

`静态` `只读`SHADERDEFINE_LIGHT2D_ADDMODE

`静态` `只读`SHADERDEFINE_LIGHT2D_EMPTY

`静态` `只读`SHADERDEFINE_LIGHT2D_ENABLE

`静态` `只读`SHADERDEFINE_LIGHT2D_NORMAL_PARAM

`静态` `只读`SHADERDEFINE_LIGHT2D_SUBMODE