Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Terrain

Hierarchy

Index

Constructors

constructor

Properties

Protected __asset

__asset: TerrainAsset | null = null

Protected _blockCount

_blockCount: number[] = [1, 1]

Protected _blockInfos

_blockInfos: TerrainBlockInfo[] = []

Protected _blocks

_blocks: TerrainBlock[] = []

Private _enabled

_enabled: boolean = true
property

_enabled

type

{Boolean}

Protected _heights

_heights: Uint16Array = new Uint16Array()

_id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _layers

_layers: Array<TerrainLayer | null> = []

Protected _lightMapSize

_lightMapSize: number = 128

Protected _name

_name: string

Protected _normals

_normals: number[] = []

_objFlags

_objFlags: number

sceneGetter

sceneGetter: null | function = null

Protected _sharedIndexBuffer

_sharedIndexBuffer: GFXBuffer | null = null

Protected _tileSize

_tileSize: number = 1

Protected _weightMapSize

_weightMapSize: number = 128

Protected _weights

_weights: Uint8Array = new Uint8Array()

node

node: Node = NullNode

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

property

node

type

{Node}

example
cc.log(comp.node);

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null
  • Returns null

asset

  • Returns null | TerrainAsset

  • Parameters

    Returns void

isOnLoadCalled

  • get isOnLoadCalled(): number
  • 返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。

    property

    _isOnLoadCalled

    type

    {Number}

    readonly
    example
    cc.log(this._isOnLoadCalled > 0);

    Returns number

blockCount

  • get blockCount(): number[]
  • Returns number[]

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void
  • 表示该组件自身是否启用。

    property

    enabled

    type

    {Boolean}

    default

    true

    example
    comp.enabled = true;
    cc.log(comp.enabled);

    Returns boolean

  • Parameters

    • value: boolean

    Returns void

enabledInHierarchy

  • get enabledInHierarchy(): boolean
  • 表示该组件是否被启用并且所在的节点也处于激活状态。

    property

    enabledInHierarchy

    type

    {Boolean}

    readonly
    example
    cc.log(comp.enabledInHierarchy);

    Returns boolean

heights

  • get heights(): Uint16Array
  • Returns Uint16Array

info

  • Returns TerrainInfo

isValid

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

    property

    {Boolean} isValid

    default

    true

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

    Returns boolean

lightMapSize

  • get lightMapSize(): number
  • Returns number

name

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

  • Parameters

    • value: string

    Returns void

size

  • Returns Size

tileCount

  • get tileCount(): number[]
  • Returns number[]

tileSize

  • get tileSize(): number
  • Returns number

uuid

  • get uuid(): string
  • 组件的 uuid,用于编辑器。

    property

    uuid

    type

    {String}

    readonly
    example
    cc.log(comp.uuid);

    Returns string

valid

  • get valid(): boolean
  • Returns boolean

vertexCount

  • get vertexCount(): number[]
  • Returns number[]

weightMapSize

  • get weightMapSize(): number
  • Returns number

weights

  • get weights(): Uint8Array
  • Returns Uint8Array

Methods

Optional Private preload

  • __preload(): void
  • __preload 在每次onLoad之前调用。
    它用于在内部初始化内置组件,
    以避免在每次公有方法调用之前检查是否调用了onLoad。
    如果支持脚本优先级,则应删除此方法。

    Returns void

Private buildImp

  • _buildImp(): undefined | false | true
  • Returns undefined | false | true

buildNormals

  • _buildNormals(): void
  • Returns void

calcuNormal

  • calcuNormal(x: number, z: number): Vec3
  • Parameters

    • x: number
    • z: number

    Returns Vec3

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

Protected Optional getLocalBounds

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

    Parameters

    • out_rect: Rect

      提供包围盒的 Rect

    Returns void

getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any
  • Parameters

    • cloned: any

    Returns any

onPreDestroy

  • _onPreDestroy(): void

Private rebuildHeights

  • Parameters

    Returns boolean

Private rebuildWeights

  • Parameters

    Returns boolean

setNormal

  • setNormal(i: number, j: number, n: Vec3): void
  • Parameters

    • i: number
    • j: number
    • n: Vec3

    Returns void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null
  • 向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。

    example
    var test = node.addComponent("Test");

    Type parameters

    Parameters

    Returns T | null

  • 向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。

    example
    var test = node.addComponent("Test");

    Parameters

    • className: string

    Returns Component | null

addLayer

  • Parameters

    Returns number

build

  • Parameters

    Returns undefined | false | true

destroy

  • destroy(): any

exportAsset

  • Returns TerrainAsset

exportHeightField

  • exportHeightField(hf: HeightField, heightScale: number): void
  • Parameters

    Returns void

getBlock

  • Parameters

    • i: number
    • j: number

    Returns TerrainBlock

getBlockInfo

  • Parameters

    • i: number
    • j: number

    Returns TerrainBlockInfo

getBlocks

  • Returns TerrainBlock[]

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

    Returns T | null

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

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

    Parameters

    • className: string

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null
  • 递归查找所有子节点中第一个匹配指定类型的组件。

    example
    var Test = node.getComponentInChildren("Test");

    Type parameters

    Parameters

    Returns T | null

  • 递归查找所有子节点中第一个匹配指定类型的组件。

    example
    var Test = node.getComponentInChildren("Test");

    Parameters

    • className: string

    Returns Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]
  • 返回节点上指定类型的所有组件。

    example
    var tests = node.getComponents("Test");

    Type parameters

    Parameters

    Returns T[]

  • 返回节点上指定类型的所有组件。

    example
    var tests = node.getComponents("Test");

    Parameters

    • className: string

    Returns Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]
  • 递归查找自身或所有子节点中指定类型的组件。

    example
    var tests = node.getComponentsInChildren("Test");

    Type parameters

    Parameters

    Returns T[]

  • 递归查找自身或所有子节点中指定类型的组件。

    example
    var tests = node.getComponentsInChildren("Test");

    Parameters

    • className: string

    Returns Component[]

getHeight

  • getHeight(i: number, j: number): number
  • Parameters

    • i: number
    • j: number

    Returns number

getHeightAt

  • getHeightAt(x: number, y: number): null | number
  • Parameters

    • x: number
    • y: number

    Returns null | number

getHeightClamp

  • getHeightClamp(i: number, j: number): number
  • Parameters

    • i: number
    • j: number

    Returns number

getHeightField

  • getHeightField(): Uint16Array
  • Returns Uint16Array

getLayer

  • Parameters

    • id: number

    Returns null | TerrainLayer

getNormal

  • getNormal(i: number, j: number): Vec3
  • Parameters

    • i: number
    • j: number

    Returns Vec3

getNormalAt

  • getNormalAt(x: number, y: number): null | Vec3
  • Parameters

    • x: number
    • y: number

    Returns null | Vec3

getPosition

  • getPosition(i: number, j: number): Vec3
  • Parameters

    • i: number
    • j: number

    Returns Vec3

getSharedIndexBuffer

  • Returns null | GFXBuffer

getWeight

  • getWeight(i: number, j: number): Vec4
  • Parameters

    • i: number
    • j: number

    Returns Vec4

getWeightAt

  • getWeightAt(x: number, y: number): null | Vec4
  • Parameters

    • x: number
    • y: number

    Returns null | Vec4

importHeightField

  • importHeightField(hf: HeightField, heightScale: number): void
  • Parameters

    Returns void

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

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

onLoad

  • onLoad(): void
  • Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

onRestore

  • onRestore(): void

rayCheck

  • rayCheck(start: Vec3, dir: Vec3, step: number, worldspace?: boolean): null | Vec3
  • Parameters

    • start: Vec3
    • dir: Vec3
    • step: number
    • Default value worldspace: boolean = true

    Returns null | Vec3

rebuild

  • Parameters

    Returns void

removeLayer

  • removeLayer(id: number): void
  • Parameters

    • id: number

    Returns void

Optional resetInEditor

  • resetInEditor(): void
  • 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

    Returns void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • 调度一个自定义的回调函数。
    如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

    method

    schedule

    example
    var timeCallback = function (dt) {
      cc.log("time: " + dt);
    }
    this.schedule(timeCallback, 1);

    Parameters

    • callback: any

      回调函数。

    • Default value interval: number = 0

      时间间隔,0 表示每帧都重复。

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

      将被重复执行(repeat+ 1)次,您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    var timeCallback = function (dt) {
      cc.log("time: " + dt);
    }
    this.scheduleOnce(timeCallback, 2);

    Parameters

    • callback: any

      回调函数。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

setHeight

  • setHeight(i: number, j: number, h: number): void
  • Parameters

    • i: number
    • j: number
    • h: number

    Returns void

setLayer

  • Parameters

    Returns void

setWeight

  • setWeight(i: number, j: number, w: Vec4): void
  • Parameters

    • i: number
    • j: number
    • w: Vec4

    Returns void

Protected Optional start

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

    Returns void

unschedule

  • unschedule(callback_fn: any): void
  • 取消调度一个自定义的回调函数。

    example
    this.unschedule(_callback);

    Parameters

    • callback_fn: any

      回调函数。

    Returns void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void
  • 取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

    method

    unscheduleAllCallbacks

    example
    this.unscheduleAllCallbacks();

    Returns void

update

  • update(dtime: number): void
  • Parameters

    • dtime: number

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc