バージョン
menu
Wwise SDK 2024.1.10
プラグインプロパティのドキュメンテーション作成

新しいプラグインを作成すると、Wwise Property Helpビューにプラグインの意義や、デフォルト値、範囲、単位、使い方など、各プロパティの情報がユーザー向けに表示されます。Property Helpビューに、ユーザーがWwiseで最後に選択したプロパティのヘルプ情報が表示されるのです。 あなたのプラグインが、具体的なプロパティに関するドキュメンテーションファイルを提供する場合は、このプロパティが選択されるたびに、そのヘルプ記述が自動的に表示されます。

プロパティのドキュメンテーションファイルはWwiseディレクトリ内にあり、場所は /Authoring/Data/Plugins//Html//PropertyName.html です。

Html フォルダに、各ランゲージ用のプロパティヘルプファイルを、いくつかのフォルダに分けて入れることができます。Wwiseに表示されるドキュメンテーションのランゲージを変更するには、メニューバーで Help > Documentation Language をクリックします。対応するランゲージコード（ ）:

enEnglish
koKorean
zhMandarin
jaJapanese

Property Helpファイルをビルドする

プロパティヘルプのドキュメンテーションのソースファイルは、 /WwisePlugin/res/Md//PropertyName.md に入れ、プロパティ1つにつき、ファイルを1つ用意します。

これらのファイルのテキストはMarkdownフォーマットとし、 wp.py 開発ツールでHTMLに変換します。開発ツールの詳細は、 開発ツールを使う を参照してください。 ヘルプメッセージのフォーマットに、太字、リストブロック、ハイパーリンクなどのマークダウンスタイルを自由に使うことができます。

注釈: Property Helpのドキュメンテーションをビルドするには、以下の2つのPythonの依存性（dependency）をインストールしてください:
pip install markdown
pip install jinja2

wp.py を使い、プラグイン用のWwise Property Helpファイルを作成します:

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" build Documentation

このコマンドが、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 

単位: Hz

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう