mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-21 16:12:40 +08:00
509d73b27d
* PR1: add explicit function return type (#15311) * PR4: add explicit function return type (#15314) * [ci skip][AUTO]: Automated code generating update: 8843bfe54cd3f8e6f84432948716c8d130ecb233 (#15314) (#15357) Co-authored-by: cocos-robot <cocos-robot@cocos.com> * add function return type * fix version checking * fix return type --------- Co-authored-by: Cocos Robot <48829427+cocos-robot@users.noreply.github.com> Co-authored-by: cocos-robot <cocos-robot@cocos.com>
143 lines
4.8 KiB
TypeScript
143 lines
4.8 KiB
TypeScript
/*
|
|
Copyright (c) 2020-2023 Xiamen Yaji Software Co., Ltd.
|
|
|
|
https://www.cocos.com/
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
of the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
*/
|
|
/* eslint-disable @typescript-eslint/no-unsafe-return */
|
|
|
|
import { markAsWarning, removeProperty, replaceProperty, js, Color, cclegacy } from '../../core';
|
|
import { UIComponent } from './ui-component';
|
|
import { UITransform } from './ui-transform';
|
|
import { UIRenderer } from './ui-renderer';
|
|
import { Canvas } from './canvas';
|
|
import type { RenderTexture } from '../../asset/assets/render-texture';
|
|
import type { ClearFlagBit } from '../../gfx/base/define';
|
|
import type { Camera } from '../../render-scene/scene';
|
|
|
|
removeProperty(UIComponent.prototype, 'UIComponent', [
|
|
{
|
|
name: '_visibility',
|
|
},
|
|
{
|
|
name: 'setVisibility',
|
|
},
|
|
]);
|
|
|
|
replaceProperty(Canvas.prototype, 'Canvas.prototype', [
|
|
{
|
|
name: 'camera',
|
|
newName: 'cameraComponent.camera',
|
|
customGetter (this: Canvas): Camera | undefined {
|
|
return this._cameraComponent?.camera;
|
|
},
|
|
},
|
|
{
|
|
name: 'clearFlag',
|
|
newName: 'cameraComponent.clearFlags',
|
|
customGetter (this: Canvas): ClearFlagBit | 0 {
|
|
return this._cameraComponent ? this._cameraComponent.clearFlags : 0;
|
|
},
|
|
customSetter (this: Canvas, val: ClearFlagBit): void {
|
|
if (this._cameraComponent) this._cameraComponent.clearFlags = val;
|
|
},
|
|
},
|
|
{
|
|
name: 'color',
|
|
newName: 'cameraComponent.clearColor',
|
|
customGetter (this: Canvas): Readonly<Color> {
|
|
return this._cameraComponent ? this._cameraComponent.clearColor : Color.BLACK;
|
|
},
|
|
customSetter (this: Canvas, val: Readonly<Color>): void {
|
|
if (this._cameraComponent) this._cameraComponent.clearColor = val;
|
|
},
|
|
},
|
|
{
|
|
name: 'priority',
|
|
newName: 'cameraComponent.priority',
|
|
customGetter (this: Canvas): number {
|
|
return this._cameraComponent ? this._cameraComponent.priority : 0;
|
|
},
|
|
customSetter (this: Canvas, val: number): void {
|
|
if (this._cameraComponent) this._cameraComponent.priority = val;
|
|
},
|
|
},
|
|
{
|
|
name: 'targetTexture',
|
|
newName: 'cameraComponent.targetTexture',
|
|
customGetter (this: Canvas): RenderTexture | null {
|
|
return this._cameraComponent ? this._cameraComponent.targetTexture : null;
|
|
},
|
|
customSetter (this: Canvas, value: RenderTexture): void {
|
|
if (this._cameraComponent) this._cameraComponent.targetTexture = value;
|
|
},
|
|
},
|
|
{
|
|
name: 'visibility',
|
|
newName: 'cameraComponent.visibility',
|
|
customGetter (this: Canvas): number {
|
|
return this._cameraComponent ? this._cameraComponent.visibility : 0;
|
|
},
|
|
},
|
|
]);
|
|
|
|
markAsWarning(UITransform.prototype, 'UITransform.prototype', [
|
|
{
|
|
name: 'priority',
|
|
suggest: `Please use setSiblingIndex to change index of the current node in its parent's children array.`,
|
|
},
|
|
]);
|
|
|
|
/**
|
|
* Alias of [[UITransform]]
|
|
* @deprecated Since v1.2
|
|
*/
|
|
export { UITransform as UITransformComponent };
|
|
cclegacy.UITransformComponent = UITransform;
|
|
js.setClassAlias(UITransform, 'cc.UITransformComponent');
|
|
|
|
/**
|
|
* Alias of [[Renderable2D]]
|
|
* @deprecated Since v1.2
|
|
*/
|
|
export { UIRenderer as RenderComponent };
|
|
/**
|
|
* Alias of [[Renderable2D]]
|
|
* @deprecated Since v3.0
|
|
*/
|
|
export { UIRenderer as UIRenderable };
|
|
js.setClassAlias(UIRenderer, 'cc.RenderComponent');
|
|
|
|
/**
|
|
* Alias of [[Canvas]]
|
|
* @deprecated Since v1.2
|
|
*/
|
|
export { Canvas as CanvasComponent };
|
|
cclegacy.CanvasComponent = Canvas;
|
|
js.setClassAlias(Canvas, 'cc.CanvasComponent');
|
|
|
|
/**
|
|
* Alias of [[Renderable2D]]
|
|
* @deprecated Since v3.6
|
|
*/
|
|
export { UIRenderer as Renderable2D };
|
|
cclegacy.internal.Renderable2D = UIRenderer;
|
|
js.setClassAlias(UIRenderer, 'cc.Renderable2D');
|