|
Wwise SDK 2023.1.8
|
新しいプラグインを作成すると、Wwise Property Helpビューにプラグインの意義や、デフォルト値、範囲、単位、使い方など、各プロパティの情報がユーザー向けに表示されます。Property Helpビューに、ユーザーがWwiseで最後に選択したプロパティのヘルプ情報が表示されるのです。 あなたのプラグインが、具体的なプロパティに関するドキュメンテーションファイルを提供する場合は、このプロパティが選択されるたびに、そのヘルプ記述が自動的に表示されます。
プロパティのドキュメンテーションファイルはWwiseディレクトリ内にあり、場所は <Wwise>/Authoring/Data/Plugins/<plugin_name>/Html/<language>/PropertyName.html です。
Html フォルダに、各ランゲージ用のプロパティヘルプファイルを、いくつかのフォルダに分けて入れることができます。Wwiseに表示されるドキュメンテーションのランゲージを変更するには、メニューバーで Help > Documentation Language をクリックします。対応するランゲージコード（ <language> ）:
| en | English |
|---|---|
| ko | Korean |
| zh | Mandarin |
| ja | Japanese |
Property Helpファイルをビルドする
プロパティヘルプのドキュメンテーションのソースファイルは、 <PluginProject>/WwisePlugin/res/Md/<language>/PropertyName.md に入れ、プロパティ1つにつき、ファイルを1つ用意します。
これらのファイルのテキストはMarkdownフォーマットとし、 wp.py 開発ツールでHTMLに変換します。開発ツールの詳細は、 開発ツールを使う を参照してください。 ヘルプメッセージのフォーマットに、太字、リストブロック、ハイパーリンクなどのマークダウンスタイルを自由に使うことができます。
 | 注釈: Property Helpのドキュメンテーションをビルドするには、以下の2つのPythonの依存性（dependency）をインストールしてください: |
wp.py を使い、プラグイン用のWwise Property Helpファイルを作成します:
このコマンドが、MarkdownからHTMLへの変換を実行して変換後のファイルをWwiseの適切なディレクトリに保存します。
例
以下は、Cutoff Frequency ParameterプロパティのHelpファイルの例と、それがWwiseのProperty Helpビューに表示された様子です:
##Cutoff Frequency Parameter フィルタのカットオフ周波数を設定する。 ローパスフィルタの理論に関する **詳細** は、 [lowpass filter on wikipedia](https://en.wikipedia.org/wiki/Low-pass_filter) を参照してください。 範囲: 20 - 20000 <br/> 単位: Hz <br/>
