Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TiledMap

在场景中渲染一个 tmx 格式的 Tile Map。

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private __prefab

__prefab: CompPrefabInfo | null = null

_animations

_animations: TiledAnimationType = new Map()

Protected _enableCulling

_enableCulling: boolean = true

是否开启瓦片地图的自动裁减功能。瓦片地图如果设置了 skew, rotation 或者采用了摄像机的话，需要手动关闭，否则渲染会出错。

Private _enabled

_enabled: boolean = true

_groups

_groups: TiledObjectGroup[] = []

Private _id

_id: string = idGenerator.getNewId()

For internal usage.

_imageLayers

_imageLayers: TMXImageLayerInfo[] = []

_images

_images: ImageExtendedNode[] = []

_layers

_layers: TiledLayer[] = []

_mapInfo

_mapInfo: TMXMapInfo | null = null

_mapOrientation

_mapOrientation: Orientation = Orientation.ORTHO

_mapSize

_mapSize: Size = new Size(0, 0)

Protected _name

_name: string

_objFlags

_objFlags: number

_preloaded

_preloaded: boolean = false

_properties

_properties: PropertiesInfo = {} as any

Private sceneGetter

sceneGetter: null | (() => RenderScene) = null

_texGrids

_texGrids: TiledTextureGrids = new Map()

_textures

_textures: SpriteFrame[] = []

_tileProperties

_tileProperties: Map<GID, PropertiesInfo> = new Map()

_tileSize

_tileSize: Size = new Size(0, 0)

_tilesets

_tilesets: TMXTilesetInfo[] = []

_tmxFile

_tmxFile: TiledMapAsset | null = null

Protected cleanupImageCache

cleanupImageCache: boolean = true

node

node: Node = NullNode

该组件被附加到的节点。组件总会附加到一个节点。

example
import { log } from 'cc';
log(comp.node);

Static Orientation

Orientation: Orientation = Orientation

Static Property

Property: Property = Property

Static RenderOrder

RenderOrder: RenderOrder = RenderOrder

Static StaggerAxis

StaggerAxis: StaggerAxis = StaggerAxis

Static StaggerIndex

StaggerIndex: StaggerIndex = StaggerIndex

Static TMXObjectType

TMXObjectType: TMXObjectType = TMXObjectType

Static TileFlag

TileFlag: TileFlag = TileFlag

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

isOnLoadCalled

  • get isOnLoadCalled(): number

enableCulling

  • get enableCulling(): boolean
  • set enableCulling(value: boolean): void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

isValid

  • get isValid(): boolean

  • 表示该对象是否可用（被 destroy 后将不可用）。
    当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy，请使用 isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
const node = new Node();
log(node.isValid);    // true
node.destroy();
log(node.isValid);    // true, still valid in this frame
// after a frame...
log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

name

  • get name(): string
  • set name(value: string): void

tmxAsset

uuid

  • get uuid(): string

Methods

preload

  • __preload(): void

applyFile

  • _applyFile(): void

buildLayerAndGroup

  • _buildLayerAndGroup(): void

Protected buildWithMapInfo

Protected changeLayer

  • changeLayer(layerName: any, replaceLayer: any): void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void

  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

fillAniGrids

Optional Private getLocalBounds

  • getLocalBounds(out_rect: Rect): void

  • 如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB）， 以便编辑器的场景视图可以正确地执行点选测试。

    Parameters

    • out_rect: Rect

      The rect to store the result bounding rect

    Returns void

Private getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any

onPreDestroy

  • _onPreDestroy(): void

releaseMapInfo

  • _releaseMapInfo(): void

syncAnchorPoint

  • _syncAnchorPoint(): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

destroy

  • destroy(): boolean

doCleanupImageCache

  • doCleanupImageCache(texture: any): void

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null

  • 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
var test = node.getComponent("Test");

    Type parameters

    Parameters

    • classConstructor: Constructor<T>

      The class of component to be retrieved or to be created

    Returns T | null

  • 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
var test = node.getComponent("Test");

    Parameters

    • className: string

      A string for the class name of the component

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

getLayer

  • 获取指定名称的 layer。

    method

    getLayer

    example

    let layer = titledMap.getLayer("Player"); cc.log(layer);

    Parameters

    • layerName: any

    Returns null | TiledLayer

getLayers

  • 返回包含所有 layer 的数组。

    method

    getLayers

    example

    let layers = titledMap.getLayers(); for (let i = 0; i < layers.length; ++i) { cc.log("Layers: " + layers[i]); }

    Returns TiledLayer[]

getMapOrientation

  • 获取地图方向。

    method

    getMapOrientation

    example

    let mapOrientation = tiledMap.getMapOrientation(); cc.log("Map Orientation: " + mapOrientation);

    Returns Orientation

getMapSize

  • getMapSize(): Size

getObjectGroup

  • 获取指定的 TMXObjectGroup。

    method

    getObjectGroup

    example

    let group = titledMap.getObjectGroup("Players"); cc.log("ObjectGroup: " + group);

    Parameters

    • groupName: string

    Returns null | TiledObjectGroup

getObjectGroups

  • 获取所有的对象层。

    method

    getObjectGroups

    example

    let objGroups = titledMap.getObjectGroups(); for (let i = 0; i < objGroups.length; ++i) { cc.log("obj: " + objGroups[i]); }

    Returns TiledObjectGroup[]

getProperties

  • getProperties(): {}

  • 获取地图的属性。

    method

    getProperties

    example

    let properties = titledMap.getProperties(); for (let i = 0; i < properties.length; ++i) { cc.log("Properties: " + properties[i]); }

    Returns {}

    • [key: string]: number | string

getPropertiesForGID

  • getPropertiesForGID(gid: GID): undefined | {}

  • 通过 GID ，获取指定的属性。

    method

    getPropertiesForGID

    example

    let properties = titledMap.getPropertiesForGID(GID); cc.log("Properties: " + properties);

    Parameters

    Returns undefined | {}

getProperty

  • getProperty(propertyName: string): string | number

  • 通过属性名称，获取指定的属性。

    method

    getProperty

    example

    let property = titledMap.getProperty("info"); cc.log("Property: " + property);

    Parameters

    • propertyName: string

    Returns string | number

getTileSize

  • getTileSize(): Size

  • 获取地图背景中 tile 元素的大小。

    method

    getTileSize

    example

    let tileSize = tiledMap.getTileSize(); cc.log("Tile Size: " + tileSize);

    Returns Size

Protected Optional lateUpdate

  • lateUpdate(dt: number): void

  • 如果该组件启用，则每帧调用 LateUpdate。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

Protected Optional onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

  • onLoad(): void

  • 当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

  • onRestore(): void

  • onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。 然而，在极端的情况下，它可能无法良好运作。
    那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。 一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的，编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单，你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。

    Returns void

Optional resetInEditor

  • resetInEditor(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void

  • 调度一个自定义的回调任务。
    如果回调任务已调度，那么将不会重复调度它，只会更新时间间隔参数。

    example
    import { log } from 'cc';
this.schedule((dt) => void log(`time: ${dt}`), 1);

    Parameters

    • callback: any

      The callback function of the task

    • Default value interval: number = 0

      The time interval between each invocation

    • Default value repeat: number = legacyCC.macro.REPEAT_FOREVER

      The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void

  • 调度一个只运行一次的回调任务，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    import { log } from 'cc';
this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

    Parameters

    • callback: any

      The callback function of the task

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

Protected Optional start

  • start(): void

  • 如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Returns void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

update

  • update(dt: number): void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc