#contents
*このページは [#summary]
//このページは、「APIドキュメントをどのように見たらいいか」ということについて、取り扱います。
このページは、
「スクリプトに挑戦しようとAPIドキュメントを見に行ったらなにかなんだかわからない」
となってしまった時のためものです。
REのPythonスクリプトをはじめたばかりの人向けです。
*APIドキュメントのリンク [#doc-link]
RazorEnhanced API Documentation: https://razorenhanced.github.io/doc/api/
*APIドキュメントを開いたら [#opendoc]
:左上の「RE API v～～」|
ここのバージョン表記をクリックすると、トップページ(index.html)に戻ります。
:左メニュー|
各項目をクリックすると、右側に各ページの内容が表示されます。
各項目のタイトルは、クラス名であったり、こういうデータをこう呼んでますよって名前だったりしてます。
クラスをまだ知らなくても使えるので大丈夫。
*色違いで書かれている Properties と Methods [#properties_and_methods]
APIドキュメントでは、&color(red){''赤字''};に続いて&color(orange){''オレンジ色''};で書かれているものと、&color(lightskyblue){''水色''};で書かれているものがあります。
#ref(APIDoc_Properties_and_Methods.png)
//&color(red){赤};+&color(orange){オレンジ};で表記された Properties と、&color(red){赤};+&color(lightskyblue){水色};で表記された Methods が掲載されています。
この&color(orange){''オレンジ色''};のと&color(lightskyblue){''水色''};のは、使い方がちょっと違います。
それぞれどんな感じに使うものなのかを、ざっくり説明します。
**水色で書かれているMethods [#methods]
各ページ内にPropertiesとMethodsが両方あるときは、オレンジ表記のPropertiesが先に書かれているのですが、
先に&color(lightskyblue){''水色表記のMethods''};の説明をすることにします。
Methodsにある項目(以下メソッド)は、REやクライアントに何らかの行動を指示するのに使います。
下の画像は、[[Enhanced Script Editor の Record>UI/Scripting#enhanced_script_editor]] を使ってキャラクターの行動を記録したものです。
#ref(APIDoc_Methods_Record.png)
3歩南に歩いてから「こんにちは！」と発言したものです。これをPlayさせると、同じく3歩南に歩いて発言します。
プレイヤーキャラクターに、「歩く」という動きと、「発言(Say)」という動きをさせたというわけです。
Recordで記録できるやつは、だいたい&color(lightskyblue){''水色表記のメソッド''};かも((記録できるのは多分全部メソッドな気がするけど未確認))。
キャラクターやアイテム等の操作をするほかにも、ジャーナルに特定の文字が出てきているか検索させたり、スクリプトからREの[[Agent>UI/Agent]]を使用させたり…
とにかくたくさんあるので、まずはRecord機能で記録して、色々見てみるところからがおすすめです。
***Methods 個々の見方と書き方 [#methods_edit]
***Methods: 個々の見方と書き方 [#methods_edit]
APIドキュメントから、プレイヤーに発言させる [[Player.ChatSay()>https://razorenhanced.github.io/doc/api/Player.html#M-Player-ChatSay]] の部分のスクリーンショットに、解説を加えた画像です。
#ref(APIDoc_Methods_Player_ChatSay_v0.8.2.88.png)
メソッドを使う時は、&color(red){''赤字''};の部分と&color(lightskyblue){''水色の文字''};の部分は''そのまま書き写し''、後ろの()の中の&color(#2EAD38){''緑の文字''};の部分を''指定のデータで埋めます''。
メソッドを使う時は、&color(red){''赤字''};の部分と&color(lightskyblue){''水色の文字''};の部分は''そのまま書き写し''、後ろの()の中に&color(#2EAD38){''緑の文字''};が書いてある場合は''指定のデータで埋めます''。
()内に何も書いていないメソッドは、()だけ書いておきます。