实例对象中的事件

事件可以通过实例对象访问

用法:

以下是通过实例对象监听事件的示例:

import { loadOml2d } from 'oh-my-live2d';
const oml2d = loadOml2d({
  // ...options
});

// 监听模型加载完成事件
oml2d.onLoad((status) => {
  switch (status) {
    case 'success':
      console.log('加载成功');
      return;
    case 'fail':
      console.log('加载失败');
      return;
    case 'loading':
      console.log('正在加载中');
      return;
  }
});

事件:

onLoad()

onLoad: (fn: (status: "loading" | "success" | "fail") => void | Promise<void>) => void

模型加载事件, 加载成功不代表舞台可见, 如果需要在舞台完全可见时触发, 请在 onStageSlideIn 事件中执行操作.

用法:

import { loadOml2d } from 'oh-my-live2d';
const oml2d = loadOml2d({
  // ...options
});
oml2d.onLoad((status) => {
  switch (status) {
    case 'success':
      console.log('加载成功');
      return;
    case 'fail':
      console.log('加载失败');
      return;
    case 'loading':
      console.log('正在加载中');
      return;
  }
});

参数:

参数名	类型	描述
fn	(status: "loading" | "success" | "fail") => void | Promise<void>	加载结束的回调, 回调时会传入加载状态: 'loading' |'success' | 'fail' loading: 正在加载模型 success: 加载成功 fail: 加载失败

返回值类型:

void

---

onStageSlideIn()

onStageSlideIn: (fn: () => void | Promise<void>) => void

舞台完全滑入事件

用法:

import { loadOml2d } from 'oh-my-live2d';
const oml2d = loadOml2d({
  // ...options
});
oml2d.onStageSlideIn(() => {
  // ...code
});

参数:

参数名	类型	描述
fn	() => void | Promise<void>	事件回调

返回值类型:

void

---

onStageSlideOut()

onStageSlideOut: (fn: () => void | Promise<void>) => void

舞台完全滑出事件

用法:

import { loadOml2d } from 'oh-my-live2d';
const oml2d = loadOml2d({
  // ...options
});
oml2d.onStageSlideOut(() => {
  // ...code
});

参数:

参数名	类型	描述
fn	() => void | Promise<void>	事件回调

返回值类型:

void