Script作成/APIドキュメントの見方

このページは

このページは、
「スクリプトに挑戦しようとAPIドキュメントを見に行ったらなにかなんだかわからない」
となってしまった時のためものです。
REのPythonスクリプトをはじめたばかりの人向けです。

APIドキュメントのリンク

RazorEnhanced API Documentation: https://razorenhanced.github.io/doc/api/

APIドキュメントを開いたら

左上の「RE API v～～」

ここのバージョン表記をクリックすると、トップページ(index.html)に戻ります。

左メニュー

各項目をクリックすると、右側に各ページの内容が表示されます。
各項目のタイトルは、クラス名であったり、こういうデータをこう呼んでますよって名前だったりしてます。
クラスをまだ知らなくても使えるので大丈夫。

色違いで書かれている Properties と Methods

APIドキュメントでは、赤字に続いてオレンジ色で書かれているものと、水色で書かれているものがあります。

このオレンジ色のと水色のは、使い方がちょっと違います。
それぞれどんな感じに使うものなのかを、ざっくり説明します。

水色で書かれているMethods

各ページ内にPropertiesとMethodsが両方あるときは、オレンジ表記のPropertiesが先に書かれているのですが、
先に水色表記のMethodsの説明をすることにします。
Methodsにある項目(以下メソッド)は、REやクライアントに何らかの行動を指示するのに使います。

下の画像は、Enhanced Script Editor の Record? を使ってキャラクターの行動を記録したものです。

3歩南に歩いてから「こんにちは！」と発言したものです。これをPlayさせると、同じく3歩南に歩いて発言します。
プレイヤーキャラクターに、「歩く」という動きと、「発言(Say)」という動きをさせたというわけです。
Recordで記録できるやつは、だいたい水色表記のメソッドかも*1。

キャラクターやアイテム等の操作をするほかにも、ジャーナルに特定の文字が出てきているか検索させたり、スクリプトからREのAgent?を使用させたり…
とにかくたくさんあるので、まずはRecord機能で記録して、色々見てみるところからがおすすめです。

Methods: 個々の見方と書き方

APIドキュメントから、プレイヤーに発言させる Player.ChatSay() の部分のスクリーンショットに、解説を加えた画像です。

メソッドを使う時は、赤字の部分と水色の文字の部分はそのまま書き写し、後ろの()の中に緑の文字が書いてある場合は指定のデータで埋めます。
()内に何も書いていないメソッドは、()だけ書いておきます。