|
Wwise SDK 2024.1.1
|
When creating a new plug-in, the Wwise Property Help view allows you to inform the user about the plug-in's properties: their meaning, default value, range, units, and how to use them. The Property Help view displays the help entry for the last selected property within Wwise. If your plug-in provides a documentation file for a specific property, each time this property is selected, its help will be automatically displayed.
Within Wwise directory, property documentation files can be found in <Wwise>/Authoring/Data/Plugins/<plugin_name>/Html/<language>/PropertyName.html.
The Html folder can contain several folders with property help files for different languages. To change the documentation language displayed in Wwise, from the menu bar, click Help > Documentation Language. Supported language codes (<language>) are:
| en | English |
|---|---|
| ko | Korean |
| zh | Mandarin |
| ja | Japanese |
Building the Property Help Files
Property help documentation source files must be located in <PluginProject>/WwisePlugin/res/Md/<language>/PropertyName.md, one file per property.
The text in these files is in Markdown format, which will be converted to HTML by the wp.py development tool. For more detail about development tools, refer to Using the Development Tools. Any markdown styles, such as bold emphasis, list block or hyperlink, can be used to format the help message.
 | Note: To build the Property Help documentation, install these two Python dependencies: pip install markdown
pip install jinja2
|
Use wp.py to build the Wwise Property Help files for the plug-in:
This command will perform the Markdown to HTML conversion and will save the resulting files in the appropriate Wwise directory.
Example
The following is an example of the Help file for a Cutoff Frequency Parameter property and its result in the Property Help view of Wwise:
##Cutoff Frequency Parameter Set the cutoff frequency of the filter. For more **information** about lowpass filter theory, refer to [lowpass filter on wikipedia](https://en.wikipedia.org/wiki/Low-pass_filter). Range: 20 - 20000 <br/> Units: Hz <br/>
Cette page a-t-elle été utile ?
Besoin d'aide ?
Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !
Visitez notre page d'AideDécrivez-nous de votre projet. Nous sommes là pour vous aider.
Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !
Partir du bon pied avec Wwise