RPGツクールMV JavaScriptリファレンス

RPGツクールMVのJavaScriptの公式リファレンスは、ごく一部しかないみたいなので作ってみました。
http://tonbi.jp/Game/RPGMakerMV/
僕が理解した(よーな気がするところから)随時更新中です。

以下を参考にしてます。
※2020年現在は

RPGツクールMV JavaScript 非公式リファレンス


で製作しております
 
最後に編集:
jsdocで書き出されるのrpg_core.jsのクラスだけなの、なんでかなーと思ったら、jsdocコメント入ってるのがrpg_core.jsだけだったからみたい。

コードとは別にVisioとかでクラス図とかUML的なの作って管理してたのかなぁ。
 
一部だけ、こんな感じで出力できるようになってきました。
地道にコードにJSDOCコメントを埋め込んでjsdocにかけるという作業をやってます。
途中で力尽きそうな雰囲気がモリモリ発生してます(笑)
スクリーンショット 2018-09-02 2.59.11.png
 
_ が付いているメンバも普通に使うもんだとは思ってなかったので無視してたんですが、人のプラグイン読んで見るとフツーに使ってるんで、頑張って追記しました。
 

フトコロ

ユーザー
内容が充実していけば、さらにいいものになりますね。

Game_Mapクラスの説明をみました。以下の内容ならこんな意味かと。

eventsXyNt(x, y)
指定座標にあるすり抜けNGのイベントを取得。
Nt = No Through だと思う。

tileEventsXy(x, y)
指定座標のtileEvent(画像にタイルセットを選択したイベント)を取得。

unlockEvent(eventId)
指定したイベントのロック状態(決定ボタンでイベントをプレイヤーの方に向かせた状態)を解除。
 
はどはど@Had2Appsさん、最初Wikiでやろうかと思ったんですけど、フォーマットの統一とかプログラムを即参照できるとかの理由でJSDocにしたんですよ。後でWikiに移植してみんなで色々と改善していけるようにするのもいいかもしれないですね。

フトコロさん、なるほどっ! 確かにそんな感じがします。転記します。
 
>最初Wikiでやろうかと思ったんですけど、フォーマットの統一とかプログラムを即参照できるとかの理由でJSDocにしたんですよ

どうにかしてJSDocをMarkdownに全部変換することができれば、GitHubにパブリックリポジトリとして作って、誰でもプルリクを送れるような感じにすれば、それっぽいことはできそうかなと

一応、それっぽいもの:https://www.npmjs.com/package/jsdoc-to-markdown
 
最後に編集:
GitHubに上げるのは、RPGツクールMVの規約的にダメなんじゃなかろうか。
僕は、非公開にできるアカウントは持ってないですし。
RPGツクールMVユーザ間なら、メールでzip送るのはOKじゃないかと思います。
 
ツクールMVのコアスクリプトはMITライセンスでOSS化されているので、MITライセンス下に則っていればいいのでは。
不安ならcorescriptのリポジトリからfolkしてきて、それを改変・追記する形でjsdocを作り直せばいいと思う。

リポジトリ:
https://github.com/rpgtkoolmv/corescript
ライセンス情報:
https://github.com/rpgtkoolmv/corescript/blob/master/LICENSE

だから、コアスクリプトにコメントを追記してGitHub上で公開しても、ちゃんと著作権表示と同ライセンス表示がしっかりされていれば問題ない。

心配しなくていいと思う
 
最後に編集:
本体付属のコアスクリプト自体はOSSではないですよね。それを勝手にライセンス変更はできないよーな。
といってJSDocを作り直すのは、キツイので避けたいっすー。
ちょっと、コミュニティ版(かな?)がどういう経緯で作られてるんだか、よく分かってないですが、コミュニティ版を元に作ったらコミュニティ版のリファレンスになっちゃうよーな。

あと、根本的なところでGit経由で渡す理由が、いまいち分かんないですけど。
 
いや、リポジトリのREADME.mdには
The core script developed by this project is widely distributed to RPG Maker users through KADOKAWA. The RPGMaker MV
(このプロジェクトで開発したコアスクリプトは、KADOKAWAを通じてRPGツクールユーザーに広く配布されています)
---------
Develop --- Development version. You can download it with GitHub.
(開発版。GitHubでダウンロードできます)
RC --- Release candidate version. It is for game developers to do the test. It will be distributed from game posting site "RPG Atsumaru".
(RC版。RPGアツマールから先行配信される候補版です)
Stable --- Stable version. KADOKAWA is widely distributed to general users through Steam and official website.
(安定版。KADOKAWAがSteamや公式サイトを通じ一般ユーザーに広く配布されています)
と書いてあるし、実際にリポジトリを落としてきてbuildすると、concat処理を通じて本体付属のコアスクリプトと同様の形になるよう出力されるので、本体付属のコアスクリプトとほぼ同一で、コミュニティ版があって初めて本体付属版があると考えていいのでは。

GitHub経由で渡すのを推奨する理由:
・コントリビューター機能を使うことでWikiには劣るが共同編集が可能になるから
 →リポジトリの編集権限があればブラウザからでも鉛筆マークからファイルを直接書き換えられる
・出力されたJSDocからMarkdownへの変換ができれば、共同編集時はMarkdownを直接編集するだけでよくなる。
 →コアスクリプトを丸上げする必要もなくなる
・GitHub-Pages機能を使えばMarkdownを自動的にHTMLに変換してWEBサイト化してくれる。
・万が一間違えても簡単にRevertできるので、Wikiよりも失敗に寛容になる
・変換ツールを作るときに、とんびさんのJSDocの編集データもあればテストしやすいし、すぐに変換ファイルを共有できるから
 
最後に編集:
とりあえず、JSDoc出力されたドキュメントをMarkdownに変換する仕組みを作ってみました。
(入力HTMLはとんびさんのJSDocページからそのまま拝借しました)
これでMarkdown化することでjsのコメントやHTMLのソースを直接いじるよりも幾分か楽になるはず。

リポジトリ:
https://github.com/katai5plate/jsdoc-output-to-md-test
変換前のJSDoc HTML:
JSDoc_ Class_ DataManager
JSDoc_ Class_ Game_CharacterBase JSDoc_ Class_ Sprite_Battler
Markdown変換後:
JSDoc_ Class_ DataManager
JSDoc_ Class_ Game_CharacterBase JSDoc_ Class_ Sprite_Battler
GitHub-PagesでWEBに反映:
JSDoc_ Class_ DataManager
JSDoc_ Class_ Game_CharacterBase JSDoc_ Class_ Sprite_Battler

想定しているのは、とんびさんがこのプログラムで全部のJSDocHTMLをMarkdownに変換して、このプログラムごとファイルをアップロードしてプライベートリポジトリ化とGitHubPagesによるWEB公開、あとは集団でこのMarkdownファイルを編集していくっていう流れですね。
 
最後に編集:
なんか会話が、すれ違ってる理由わかりました。
僕は「はどはど@Had2Apps さんが、Wiki(あるいは.md)への変換およびその後のデータ管理までやる」んだと思ってたんです。
もう、データも管理権限も渡しちゃって、編集者のひとりって立場になるつもりだったんですよー。
楽したかったんですよー(笑)

コミュニティ版の立ち位置については、README.mdも読んでましたが、いまいち理解できてません。
KADOKAWAを通じて配布されてるといっても、コミュニティ版そのものではなくて、本体付属版にコミュニティ版の一部を取り入れる形で配布してるように思うんですが。
ただ、コミュニティ版が作られた経緯とか立ち位置とかは、このスレッドの趣旨と直接は関係ないんで、だいたい大丈夫そうぐらいの認識で構わないと思います。
 
トップ