diff options
| author | Yuri Sizov <yuris@humnom.net> | 2023-07-12 17:15:19 +0200 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-07-12 17:15:19 +0200 |
| commit | f25233cbc9386d35baa4c5a9aa8bbe998c999440 (patch) | |
| tree | 17d80d38d107fe0a8a458eeb08aab8a1b9a93a41 /modules/vorbis | |
| parent | 4e66c4cdd9158cdd9ef8167e55e419511978e970 (diff) | |
| parent | 8352122e70ec2a582af9a713791eabbbcb935c10 (diff) | |
| download | redot-engine-f25233cbc9386d35baa4c5a9aa8bbe998c999440.tar.gz | |
Merge pull request #49524 from Calinou/document-editor-import-options
Document editor import options in the class reference
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 e498253892..4f920e2e04 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); } |