From 21d31a9fb3a4a52fce42a6f65f37c342cbb9b5b1 Mon Sep 17 00:00:00 2001 From: FineArchs <133759614+FineArchs@users.noreply.github.com> Date: Fri, 12 Jan 2024 21:45:54 +0900 Subject: [PATCH] =?UTF-8?q?AiScript=E3=81=AB=E3=81=A4=E3=81=84=E3=81=A6?= =?UTF-8?q?=E8=BF=BD=E8=A8=98=20(#106)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * AiScriptについて追記 * Update content/ja/docs/4.for-developers/aiscript.md Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com> * Update content/ja/docs/4.for-developers/aiscript.md Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com> * Update content/ja/docs/4.for-developers/aiscript.md Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com> * Update aiscript.md --------- Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com> --- content/ja/docs/4.for-developers/aiscript.md | 51 ++++++++++++++++++-- 1 file changed, 48 insertions(+), 3 deletions(-) diff --git a/content/ja/docs/4.for-developers/aiscript.md b/content/ja/docs/4.for-developers/aiscript.md index 76da369a..465d113b 100644 --- a/content/ja/docs/4.for-developers/aiscript.md +++ b/content/ja/docs/4.for-developers/aiscript.md @@ -1,11 +1,56 @@ # AiScript -AiScriptは、Misskeyで使用できるスクリプト言語です。 +AiScriptは、Misskeyの以下の箇所で使用できるスクリプト言語です。 +- [プラグイン](./plugin/) +- [ウィジェット](/docs/for-users/features/widgets/) + - ボタン + - AiScriptコンソール + - AiScript App +- Misskey Play +- スクラッチパッド :::tip -AiScript実装はMisskeyとは別リポジトリで、[オープンソースで公開されています](https://github.com/syuilo/aiscript)。 +AiScriptの実装はMisskeyとは別リポジトリで、[オープンソースで公開されています](https://github.com/aiscript-dev/aiscript)。 ::: ## 使い方 -AiScriptの構文や組み込み関数などのドキュメントは、[こちら](https://github.com/syuilo/aiscript/tree/master/docs)で公開されています。 +AiScript標準の構文や組み込み関数などが使用できます。 + +:::tip + +ドキュメントは[こちら](https://github.com/aiscript-dev/aiscript/tree/master/docs) +Misskey本体のバージョンにより、使用できるAiScriptのバージョンが異なる場合があります。バージョンの確認には`<: Core:v`をScratchpadなどで実行してください。 + +::: + +これらに加え、Misskey専用の組み込み定数・関数が３グループに分けて提供されています。 + +### Misskey AiScript API +接頭辞: `Mk:` +Misskey内の全てのAiScript環境で使用できる定関数群です。 +詳しくは[プラグインAPIリファレンス](./plugin/plugin-api-reference/)の`Mk:`とついた部分を参照して下さい。 + +### プラグインAPI +接頭辞: `Plugin:` +[プラグイン](./plugin/)でのみ使用できる定関数群です。 +詳しくは[プラグインAPIリファレンス](./plugin/plugin-api-reference/)の`Plugin:`とついた部分を参照して下さい。 + +### UI API +接頭辞: `Ui:` +[ウィジェット](/docs/for-users/features/widgets/)（AiScript App）、Misskey Play、Scratchpadで使用できます。 +ドキュメントは未整備（TODO）ですが、インターネット上に有志の方が執筆された解説記事があります。 + +### 標準入出力 +AiScript標準で定義されている`readline`関数と`print`関数（および`<:`構文）の内部実装は、Misskey側で独自に提供されています。 +#### readline(message) +`message`: `str` +返り値: `str` +Misskey内の全てのAiScript環境で使用できます。 +文字列の入力を求めるポップアップを表示します。 +#### print(message) +`message`: `any` +返り値: `null` +[ウィジェット](/docs/for-users/features/widgets/)（AiScriptコンソール）、Scratchpadで使用できます。 +コンソールに文字列を出力します。 +`<:`構文も同様の働きをします。