diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-05-13 22:34:34 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-06-15 08:30:48 +0200 |
| commit | 8352122e70ec2a582af9a713791eabbbcb935c10 (patch) | |
| tree | 87676ef5586fa432b20d677bd26e7f321dd0be8d /modules/vorbis | |
| parent | 33957aee69683cf1f542a8622e5a9efd23070f1c (diff) | |
| download | redot-engine-8352122e70ec2a582af9a713791eabbbcb935c10.tar.gz | |
Document editor import options in the class reference
Tooltips are displayed when hovering import options, both in the Import
dock and in the import defaults editor (which is in the Project Settings).
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Diffstat (limited to 'modules/vorbis')
| -rw-r--r-- | modules/vorbis/config.py | 1 | ||||
| -rw-r--r-- | modules/vorbis/doc_classes/AudioStreamOggVorbis.xml | 2 | ||||
| -rw-r--r-- | modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml | 22 | ||||
| -rw-r--r-- | modules/vorbis/register_types.cpp | 4 |
4 files changed, 28 insertions, 1 deletions
diff --git a/modules/vorbis/config.py b/modules/vorbis/config.py index a231ef179d..9e10a58849 100644 --- a/modules/vorbis/config.py +++ b/modules/vorbis/config.py @@ -11,6 +11,7 @@ def get_doc_classes(): return [ "AudioStreamOggVorbis", "AudioStreamPlaybackOggVorbis", + "ResourceImporterOggVorbis", ] diff --git a/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml b/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml index 4551d395df..c553955192 100644 --- a/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml +++ b/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml @@ -14,7 +14,7 @@ <member name="bpm" type="float" setter="set_bpm" getter="get_bpm" default="0.0"> </member> <member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false"> - If [code]true[/code], the stream will automatically loop when it reaches the end. + If [code]true[/code], the audio will play again from the specified [member loop_offset] once it is done playing. Useful for ambient sounds and background music. </member> <member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset" default="0.0"> Time in seconds at which the stream starts after being looped. diff --git a/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml b/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml new file mode 100644 index 0000000000..e5da120519 --- /dev/null +++ b/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceImporterOggVorbis" inherits="ResourceImporter" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="bar_beats" type="int" setter="" getter="" default="4"> + </member> + <member name="beat_count" type="int" setter="" getter="" default="0"> + </member> + <member name="bpm" type="float" setter="" getter="" default="0"> + </member> + <member name="loop" type="bool" setter="" getter="" default="false"> + If [code]true[/code], the audio will play again from the specified [member loop_offset] once it is done playing. Useful for ambient sounds and background music. + </member> + <member name="loop_offset" type="float" setter="" getter="" default="0"> + </member> + </members> +</class> diff --git a/modules/vorbis/register_types.cpp b/modules/vorbis/register_types.cpp index e131ff6dc9..028b7a3086 100644 --- a/modules/vorbis/register_types.cpp +++ b/modules/vorbis/register_types.cpp @@ -44,7 +44,11 @@ void initialize_vorbis_module(ModuleInitializationLevel p_level) { ogg_vorbis_importer.instantiate(); ResourceFormatImporter::get_singleton()->add_importer(ogg_vorbis_importer); } + + // Required to document import options in the class reference. + GDREGISTER_CLASS(ResourceImporterOggVorbis); #endif + GDREGISTER_CLASS(AudioStreamOggVorbis); GDREGISTER_CLASS(AudioStreamPlaybackOggVorbis); } |