mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-21 08:02:39 +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>
94 lines
3.2 KiB
TypeScript
94 lines
3.2 KiB
TypeScript
/*
|
|
Copyright (c) 2019-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.
|
|
*/
|
|
|
|
import { ISchedulable } from './scheduler';
|
|
import { Enum } from './value-types/enum';
|
|
|
|
/**
|
|
* @en Base class for all functional system managed by [[Director]].
|
|
* @zh 功能系统的基类,由 [[Director]] 管理。
|
|
*/
|
|
export class System implements ISchedulable {
|
|
static Priority = Enum({
|
|
LOW: 0,
|
|
MEDIUM: 100,
|
|
HIGH: 200,
|
|
SCHEDULER: (1 << 31) >>> 0,
|
|
});
|
|
|
|
protected _id = '';
|
|
protected _priority = 0;
|
|
protected _executeInEditMode = false;
|
|
|
|
set priority (value:number) {
|
|
this._priority = value;
|
|
}
|
|
get priority ():number {
|
|
return this._priority;
|
|
}
|
|
|
|
set id (id:string) {
|
|
this._id = id;
|
|
}
|
|
get id ():string {
|
|
return this._id;
|
|
}
|
|
|
|
/**
|
|
* @en Sorting between different systems.
|
|
* @zh 不同系统间排序。
|
|
* @param a System a
|
|
* @param b System b
|
|
*/
|
|
public static sortByPriority (a:System, b:System): number {
|
|
if (a._priority < b._priority) {
|
|
return 1;
|
|
} else if (a._priority > b.priority) {
|
|
return -1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @en Init the system, will be invoked by [[Director]] when registered, should be implemented if needed.
|
|
* @zh 系统初始化函数,会在注册时被 [[Director]] 调用,如果需要的话应该由子类实现
|
|
*/
|
|
init (): void {}
|
|
/**
|
|
* @en Update function of the system, it will be invoked between all components update phase and late update phase.
|
|
* @zh 系统的帧更新函数,它会在所有组件的 update 和 lateUpdate 之间被调用
|
|
* @param dt Delta time after the last frame
|
|
*/
|
|
update (dt: number): void {}
|
|
/**
|
|
* @en Post update function of the system, it will be invoked after all components late update phase and before the rendering process.
|
|
* @zh 系统的帧后处理函数,它会在所有组件的 lateUpdate 之后以及渲染之前被调用
|
|
* @param dt Delta time after the last frame
|
|
*/
|
|
postUpdate (dt: number): void {}
|
|
|
|
destroy (): void {}
|
|
}
|