2024-08-12 05:27:23 +08:00
|
|
|
|
<!doctype html>
|
|
|
|
|
|
<html lang="zh-CN" data-theme="light">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
|
|
|
|
<meta name="generator" content="VuePress 2.0.0-rc.9" />
|
|
|
|
|
|
<meta name="theme" content="VuePress Theme Hope 2.0.0-rc.32" />
|
|
|
|
|
|
<style>
|
|
|
|
|
|
html {
|
|
|
|
|
|
background: var(--bg-color, #fff);
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
html[data-theme="dark"] {
|
|
|
|
|
|
background: var(--bg-color, #1d1e1f);
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
body {
|
|
|
|
|
|
background: var(--bg-color);
|
|
|
|
|
|
}
|
|
|
|
|
|
</style>
|
|
|
|
|
|
<script>
|
|
|
|
|
|
const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
|
|
|
|
|
|
const systemDarkMode =
|
|
|
|
|
|
window.matchMedia &&
|
|
|
|
|
|
window.matchMedia("(prefers-color-scheme: dark)").matches;
|
|
|
|
|
|
|
|
|
|
|
|
if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
|
|
|
|
|
|
document.documentElement.setAttribute("data-theme", "dark");
|
|
|
|
|
|
}
|
|
|
|
|
|
</script>
|
2024-08-17 02:40:51 +08:00
|
|
|
|
<link rel="alternate" hreflang="en-us" href="https://vuepress-theme-hope-docs-demo.netlify.app/en/dev/dev_lyfunc.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/dev/dev_lyfunc.html"><meta property="og:site_name" content="LiteyukiBot 轻雪机器人"><meta property="og:title" content="轻雪函数"><meta property="og:description" content="轻雪函数 轻雪函数 Liteyuki Function 是轻雪的一个功能，它允许你在轻雪中运行一些自定义的由数据驱动的命令，类似于Minecraft的mcfunction，属于资源包的一部分，但需单独起篇幅. 函数文件 函数文件放在资源包的functions目录下，文件名以.mcfunction .lyfunction .lyf结尾，例如test.mc..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><meta property="og:updated_time" content="2024-08-11T21:26:36.000Z"><meta property="article:modified_time" content="2024-08-11T21:26:36.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"轻雪函数","image":[""],"dateModified":"2024-08-11T21:26:36.000Z","author":[]}</script><script src="/js/zh/get_data.js" type="module"></script><script src="/js/style.js" type="module"></script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/firacode/6.2.0/fira_code.min.css"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>轻雪函数 | LiteyukiBot 轻雪机器人</title><meta name="description" content="轻雪函数 轻雪函数 Liteyuki Function 是轻雪的一个功能，它允许你在轻雪中运行一些自定义的由数据驱动的命令，类似于Minecraft的mcfunction，属于资源包的一部分，但需单独起篇幅. 函数文件 函数文件放在资源包的functions目录下，文件名以.mcfunction .lyfunction .lyf结尾，例如test.mc...">
|
2024-08-24 11:58:47 +08:00
|
|
|
|
<link rel="preload" href="/assets/style-DI-mIFA3.css" as="style"><link rel="stylesheet" href="/assets/style-DI-mIFA3.css">
|
|
|
|
|
|
<link rel="modulepreload" href="/assets/app-CjATe-3J.js"><link rel="modulepreload" href="/assets/dev_lyfunc.html-BCoKJvXH.js">
|
|
|
|
|
|
<link rel="prefetch" href="/assets/index.html-DTQQC8Lz.js" as="script"><link rel="prefetch" href="/assets/index.html-BQNSyKyP.js" as="script"><link rel="prefetch" href="/assets/config.html-hUHhm1ml.js" as="script"><link rel="prefetch" href="/assets/fandq.html-BJ_T-hOv.js" as="script"><link rel="prefetch" href="/assets/install.html-1Fb-IcBW.js" as="script"><link rel="prefetch" href="/assets/index.html-B_9Qsv2n.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-C1UgiNjA.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-MhNYH9Y2.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-DEVN3K4y.js" as="script"><link rel="prefetch" href="/assets/index.html-VPmcRcQq.js" as="script"><link rel="prefetch" href="/assets/index.html-DPJTF2yb.js" as="script"><link rel="prefetch" href="/assets/plugin.html-Bn_7M68X.js" as="script"><link rel="prefetch" href="/assets/resource.html-BW8e5Xl-.js" as="script"><link rel="prefetch" href="/assets/index.html-De3cWaNV.js" as="script"><link rel="prefetch" href="/assets/agreement.html-BDfKY0ng.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-B8jiw8ac.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-1KkQm4MH.js" as="script"><link rel="prefetch" href="/assets/index.html-CzyZRVnT.js" as="script"><link rel="prefetch" href="/assets/config.html-C8qyR3Vd.js" as="script"><link rel="prefetch" href="/assets/exception.html-B70yGYl0.js" as="script"><link rel="prefetch" href="/assets/log.html-4Hjztnmf.js" as="script"><link rel="prefetch" href="/assets/mkdoc.html-DlI261cS.js" as="script"><link rel="prefetch" href="/assets/utils.html-DTQM9udQ.js" as="script"><link rel="prefetch" href="/assets/index.html-CUmjm99M.js" as="script"><link rel="prefetch" href="/assets/config.html-DoVdlJHK.js" as="script"><link rel="prefetch" href="/assets/fandq.html-aJwMBDhi.js" as="script"><link rel="prefetch" href="/assets/install.html-D0yDCWmJ.js" as="script"><link rel="prefetch" href="/assets/index.html-DO1uN8Tf.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-D3SG_Tw4.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-CWS9R4-C.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-DnO7bzlR.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-BcGxa8fl.js" as="script"><link rel="prefetch" href="/assets/index.html-BfmLPNCn.js" as="script"><link rel="prefetch" href="/assets/plugin.html-VDMFL-mu.js" as="script"><link rel="prefetch" href="/assets/resource.html-CUlLSeQe.js" as="script"><link rel="prefetch" href="/assets/index.html-C4yMl8Ou.js" as="script"><link rel="prefetch" href="/assets/agreement.html-B9zj2sX-.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-CuwAzL3j.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-DTRr2deS.js" as="script"><link rel="prefetch" href="/assets/index.html-DDoXTK8m.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-Bpr-RAtA.js" as="script"><link rel="prefetch" href="/assets/index.html-Bu29RtFZ.js" as="script"><link rel="prefetch" href="/assets/channel.html-D1gr1i96.js" as="script"><link rel="prefetch" href="/assets/event.html-C9fxx55r.js" as="script"><link rel="prefetch" href="/assets/storage.html-CogBYA9H.js" as="script"><link rel="prefetch" href="/assets/index.html-Dcer4aq-.js" as="script"><link rel="prefetch" href="/assets/manager.html-CeEm44l2.js" as="script"><link rel="prefetch" href="/assets/index.html-BdBr6wu8.js" as="script"><link rel="prefetch" href="/assets/observer.html-DXsAqFEB.js" as="script"><link rel="prefetch" href="/assets/plugin.html-BXt2mp37.js" as="script"><link rel="prefetch" href="/assets/index.html-6Vagy9oc.js" as="script"><link rel="prefetch" href="/assets/event.html-DbtWZsSv.js" as="script"><link rel="prefetch" href="/assets/matcher.html-BZum5glm.js" as="script"><link rel="prefetch" href="/assets/on.html-H8KDh39c.js" as="script"><link rel="prefetch" href="/assets/rule.html-PJE7erLl.js" as="script"><link rel="prefetch" href="/assets/session.html-DDF7Qy2U.js" as="scri
|
2024-08-12 05:27:23 +08:00
|
|
|
|
</head>
|
|
|
|
|
|
<body>
|
2024-08-19 09:56:38 +08:00
|
|
|
|
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">跳至主要內容</a><!--]--><div class="theme-container has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="route-link vp-brand" href="/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" alt><!----><span class="vp-site-name hide-in-pad">LiteyukiBot 轻雪机器人</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/" aria-label="首页"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>首页<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/deploy/" aria-label="安装及部署"><!---->安装及部署<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/usage/" aria-label="使用及功能"><!---->使用及功能<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/store/" aria-label="资源及插件"><!---->资源及插件<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/dev/" aria-label="开发及贡献"><!---->开发及贡献<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button type="button" class="dropdown-title" aria-label="选择语言"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a class="route-link nav-link active" href="/dev/dev_lyfunc.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link" href="/en/dev/dev_lyfunc.html" aria-label="English"><!---->English<!----></a></li></ul></button></div></div><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/LiteyukiStudio/LiteyukiBot" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936
|
2024-08-12 05:27:23 +08:00
|
|
|
|
cmd <span class="token builtin class-name">echo</span> hello world
|
|
|
|
|
|
|
|
|
|
|
|
<span class="token comment"># 如果你想同时输出多行内容可以尝试换行符(Python格式)</span>
|
|
|
|
|
|
cmd <span class="token builtin class-name">echo</span> hello world<span class="token punctuation">\</span>nLiteyuki bot
|
|
|
|
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>也支持句末注释，例如：</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>cmd <span class="token builtin class-name">echo</span> hello world <span class="token comment"># 输出"hello world"</span>
|
|
|
|
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><h3 id="命令文档" tabindex="-1"><a class="header-anchor" href="#命令文档"><span><strong>命令文档</strong></span></a></h3><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>var <span class="token operator"><</span>var1<span class="token operator">=</span>value<span class="token operator"><span class="token file-descriptor important">1</span>></span> <span class="token punctuation">[</span>var2<span class="token operator">=</span>value2<span class="token punctuation">]</span> <span class="token punctuation">..</span>. <span class="token comment"># 定义变量</span>
|
|
|
|
|
|
cmd <span class="token operator"><</span>command<span class="token operator">></span> <span class="token comment"># 在设备上执行命令</span>
|
|
|
|
|
|
api <span class="token operator"><</span>api_name<span class="token operator">></span> <span class="token punctuation">[</span>var<span class="token operator">=</span>value<span class="token punctuation">..</span>.<span class="token punctuation">]</span> <span class="token comment"># 调用Bot API</span>
|
|
|
|
|
|
<span class="token keyword">function</span> <span class="token operator"><</span>func_name<span class="token operator">></span> <span class="token comment"># 调用函数，可递归</span>
|
|
|
|
|
|
<span class="token function">sleep</span> <span class="token operator"><</span>time<span class="token operator">></span> <span class="token comment"># 异步等待，单位s</span>
|
|
|
|
|
|
<span class="token function">nohup</span> <span class="token operator"><</span>command<span class="token operator">></span> <span class="token comment"># 使用新的task执行命令，即不等待</span>
|
|
|
|
|
|
end <span class="token comment"># 结束函数关键字，包括子task</span>
|
|
|
|
|
|
await <span class="token comment"># 等待所有异步任务结束，若函数中启动了其他task，需要在最后调用，否则task对象会被销毁</span>
|
|
|
|
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="示例" tabindex="-1"><a class="header-anchor" href="#示例"><span><strong>示例</strong></span></a></h4><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token comment"># 疯狂戳好友</span>
|
|
|
|
|
|
<span class="token comment"># 使用 /function poke user_id=123456 执行</span>
|
|
|
|
|
|
<span class="token comment"># 每隔0.2s戳两次，无限戳，会触发最大递归深度限制</span>
|
|
|
|
|
|
<span class="token comment"># 若要戳20s后停止，则需要删除await，添加sleep 20和end</span>
|
|
|
|
|
|
api friend_poke <span class="token assign-left variable">user_id</span><span class="token operator">=</span>user_id
|
|
|
|
|
|
api friend_poke <span class="token assign-left variable">user_id</span><span class="token operator">=</span>user_id
|
|
|
|
|
|
<span class="token function">sleep</span> <span class="token number">0.2</span>
|
|
|
|
|
|
<span class="token function">nohup</span> <span class="token keyword">function</span> poke
|
|
|
|
|
|
await
|
|
|
|
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="api" tabindex="-1"><a class="header-anchor" href="#api"><span><strong>API</strong></span></a></h3><p>理论上所有基于onebotv11的api都可调用，不同Adapter api也有差别.</p><p><a href="https://283375.github.io/onebot_v11_vitepress/api/index.html" target="_blank" rel="noopener noreferrer">Onebot v11 API文档<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a></p><h3 id="结束关键字" tabindex="-1"><a class="header-anchor" href="#结束关键字"><span><strong>结束关键字</strong></span></a></h3><p>由于LiteyukiBot基于异步运行, 所以在编写lyfunction时也要注意异步的调用，避免出现"单线程走到底"的情况是效率提升的关键.</p><p><code>await</code> 异步任务结束关键字，用于结束当前已完成function的执行</p><div class="hint-container warning"><p class="hint-container-title">注意</p><p>但若出现非单function的情况，有一个task任务没有完成而await被执行了，那么当前所有函数包的task都会被截停销毁</p></div><div class="hint-container tip"><p class="hint-container-title">提示</p><p>编写轻雪函数推荐你使用VS Code插件<a href="https://github.com/LiteyukiStudio/lyfunctionTextmate" target="_blank" rel="noopener noreferrer">Liteyuki Function<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>实现语法高亮</p></div></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/LiteyukiStudio/LiteyukiBot/edit/main/docs/dev/dev_lyfunc.md" rel="noopener noreferrer" target="_blank" aria-label="在 GitHub 上编辑" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->在 GitHub 上编辑<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,
|
2024-08-24 11:58:47 +08:00
|
|
|
|
<script type="module" src="/assets/app-CjATe-3J.js" defer></script>
|
2024-08-12 05:27:23 +08:00
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
