类: EventHandler

导入示例:

import { EventHandler } from "cc";

“EventHandler” 类用来设置场景中的事件回调,该类允许用户设置回调目标节点,目标组件名,组件方法名,并可通过 emit 方法调用目标函数。

example

// Let's say we have a MainMenu component on newTarget
// file: MainMenu.ts
@ccclass('MainMenu')
export class MainMenu extends Component {
    // sender: the node MainMenu.ts belongs to
    // eventType: CustomEventData
    onClick (sender, eventType) {
        cc.log('click');
    }
}

import { Component } from 'cc';
const eventHandler = new Component.EventHandler();
eventHandler.target = newTarget;
eventHandler.component = "MainMenu";
eventHandler.handler = "OnClick";
eventHandler.customEventData = "my data";

索引

构造函数

静态方法
组件事件派发。

属性
事件响应组件和函数所在节点
响应事件函数名,比如例子中的 'onClick' 方法名
自定义事件数据
事件响应函数所在组件名(脚本名), 比如例子中的脚本名 'MainMenu'

方法
触发目标组件上的指定 handler 函数,可以选择传递参数。

详情

构造函数

public EventHandler () :
EventHandler
返回值: EventHandler

静态方法

public emitEvents (events : EventHandler [], ...args : any []) :
void
static
组件事件派发。
输入参数
名称类型描述
eventsEventHandler []The event list to be emitted
argsany []The callback arguments
返回值: void

属性

public target : null | Node
default: null
事件响应组件和函数所在节点
public handler : string
default: ''
响应事件函数名,比如例子中的 'onClick' 方法名
public customEventData : string
default: ''
自定义事件数据
public component : string
default: ''
事件响应函数所在组件名(脚本名), 比如例子中的脚本名 'MainMenu'
protected _componentId : string
default: ''
deprecated
Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.
protected _componentName : any
deprecated
Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.

方法

public emit (params : any []) :
void
触发目标组件上的指定 handler 函数,可以选择传递参数。
输入参数
名称类型描述
paramsany []The arguments for invoking the callback
返回值: void

示例

import { Component } from 'cc';
const eventHandler = new Component.EventHandler();
eventHandler.target = newTarget;
eventHandler.component = "MainMenu";
eventHandler.handler = "OnClick"
eventHandler.emit(["param1", "param2", ....]); 
protected _compId2Name (compId : any) :
any
输入参数
名称类型描述
compIdany-
返回值: any
protected _compName2Id (compName : any) :
any
输入参数
名称类型描述
compNameany-
返回值: any
protected _genCompIdIfNeeded () :
void
返回值: void