index / guide_manage_ / event_protocol

Interface: event_protocol

guide_manage_.event_protocol

事件协议

Table of contents

Methods

• pause
• resume
• before_switch
• loading_step
• after_unload_step
• loading_step_complete
• break
• finish

Methods

pause

▸ pause(): void

暂停

Returns

void

Defined in

assets/@framework/guide/mk_guide_manage.ts:312

---

resume

▸ resume(): void

恢复

Returns

void

Defined in

assets/@framework/guide/mk_guide_manage.ts:314

---

before_switch

▸ before_switch(next_step_n): void

切换步骤前

Parameters

Name	Type	Description
next_step_n	number	下个步骤

Returns

void

Remarks

set_step 时执行

Defined in

assets/@framework/guide/mk_guide_manage.ts:321

---

loading_step

▸ loading_step(): void

加载步骤

Returns

void

Remarks

加载步骤(场景/操作)前调用，可在此处打开遮罩

Defined in

assets/@framework/guide/mk_guide_manage.ts:327

---

after_unload_step

▸ after_unload_step(step): void

卸载步骤后

Parameters

Name	Type	Description
step	guide_step_base<any>	卸载的步骤

Returns

void

Defined in

assets/@framework/guide/mk_guide_manage.ts:332

---

loading_step_complete

▸ loading_step_complete(): void

加载步骤完成

Returns

void

Remarks

步骤 load 执行后调用，可在此处关闭遮罩

Defined in

assets/@framework/guide/mk_guide_manage.ts:338

---

break

▸ break(): void

中断

Returns

void

Defined in

assets/@framework/guide/mk_guide_manage.ts:340

---

finish

▸ finish(): void

完成

Returns

void

Defined in

assets/@framework/guide/mk_guide_manage.ts:342