Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CCObject

The base class of most of all the objects in Fireball.

Hierarchy

Index

Enumerations

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _name

_name: string

_objFlags

_objFlags: number

Static __props__

__props__: string[]

Static __values__

__values__: string[]

Accessors

isValid

  • get isValid(): boolean

  • Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
    When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

    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

Methods

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

destroy

  • destroy(): boolean

  • Destroy this Object, and release all its own references to other objects.
    Actual object destruction will delayed until before rendering. From the next frame, this object is not usable any more. You can use isValid(obj) to check whether the object is destroyed before accessing it.

    example
    obj.destroy();

    Returns boolean

    whether it is the first time the destroy being called

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc