Deprecated API

    • markAsWarning embeds a warning in the attribute on the given object, and the attribute needs to exist on the given object.

    • removeProperty redefines the removed property on the given object, and embeds an error message. The property should not exist on the given object.

    According to the module division, each module maintains an obsolete file. In order to facilitate maintenance, the name is unified as deprecated.ts and placed in the directory of the corresponding module, and the file needs to be import in the index.ts file of the corresponding module, such as import'./deprecated'.

    1. // For APIs that are not compatible with replacement parameters, adapt them through appropriate custom functions
    2. replaceProperty(AnimationComponent.prototype, 'AnimationComponent.prototype', [
    3.     {
    4.         name: 'removeClip',
    5.         newName: 'removeState',
    6.         customFunction: function (...args: any) {
    7.             const arg0 = args[0] as AnimationClip;
    8.             return AnimationComponent.prototype.removeState.call(this, arg0.name);
    10. ]);
    12. replaceProperty(vmath, 'vmath', [
    13.     {
    14.         name: 'vec2',
    15.         newName: 'Vec2',
    16.         target: math,
    17.         targetName: 'math',
    18.         'logTimes': 1
    19.     },
    20.     {
    21.         name: 'EPSILON',
    22.         target: math,
    23.         targetName: 'math',
    24.         'logTimes': 2
    25. ]);
    27. removeProperty(vmath, 'vmath', [
    28.     {
    29.         'name': 'random',
    30.         'suggest': 'use Math.random.'
    31.     }
    32. ]);
    34. markAsWarning(math, 'math', [
    35.     {
    36.         'name': 'toRadian'
    37.     }
    38. ]);

    • replaceProperty does not pass in newName or newTarget, which means it is consistent with name or target.