Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-19 07:53:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Mark methods for various classes as required

Browse source
This commit is contained in:
Jojo-1000 2025-06-25 22:24:07 +02:00
parent 2a9ff39264
commit ab178719d9
15 changed files with 42 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

2
core/io/resource_loader.cpp
View file

@ -174,7 +174,7 @@ Ref<Resource> ResourceFormatLoader::load(const String &p_path, const String &p_o
}
}
ERR_FAIL_V_MSG(Ref<Resource>(), vformat("Failed to load resource '%s'. ResourceFormatLoader::load was not implemented for this resource type.", p_path));
return Ref<Resource>();
}
void ResourceFormatLoader::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {

2
core/io/resource_loader.h
View file

@ -70,7 +70,7 @@ protected:
GDVIRTUAL2RC(Error, _rename_dependencies, String, Dictionary)
GDVIRTUAL1RC(bool, _exists, String)
GDVIRTUAL4RC(Variant, _load, String, String, bool, int)
GDVIRTUAL4RC_REQUIRED(Variant, _load, String, String, bool, int)
public:
virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE);

2
doc/classes/AudioStream.xml
View file

@ -64,7 +64,7 @@
Override this method to return [code]true[/code] if this stream has a loop.
</description>
</method>
<method name="_instantiate_playback" qualifiers="virtual const">
<method name="_instantiate_playback" qualifiers="virtual required const">
<return type="AudioStreamPlayback" />
<description>
Override this method to customize the returned value of [method instantiate_playback]. Should return a new [AudioStreamPlayback] created when the stream is played (such as by an [AudioStreamPlayer]).

8
doc/classes/AudioStreamPlayback.xml
View file

@ -23,13 +23,13 @@
Return the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]).
</description>
</method>
<method name="_get_playback_position" qualifiers="virtual const">
<method name="_get_playback_position" qualifiers="virtual required const">
<return type="float" />
<description>
Overridable method. Should return the current progress along the audio stream, in seconds.
</description>
</method>
<method name="_is_playing" qualifiers="virtual const">
<method name="_is_playing" qualifiers="virtual required const">
<return type="bool" />
<description>
Overridable method. Should return [code]true[/code] if this playback is active and playing its audio stream.
@ -60,14 +60,14 @@
Set the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]).
</description>
</method>
<method name="_start" qualifiers="virtual">
<method name="_start" qualifiers="virtual required">
<return type="void" />
<param index="0" name="from_pos" type="float" />
<description>
Override this method to customize what happens when the playback starts at the given position, such as by calling [method AudioStreamPlayer.play].
</description>
</method>
<method name="_stop" qualifiers="virtual">
<method name="_stop" qualifiers="virtual required">
<return type="void" />
<description>
Override this method to customize what happens when the playback is stopped, such as by calling [method AudioStreamPlayer.stop].

4
doc/classes/EditorResourcePreviewGenerator.xml
View file

@ -16,7 +16,7 @@
By default, it returns [code]false[/code].
</description>
</method>
<method name="_generate" qualifiers="virtual const">
<method name="_generate" qualifiers="virtual required const">
<return type="Texture2D" />
<param index="0" name="resource" type="Resource" />
<param index="1" name="size" type="Vector2i" />
@ -47,7 +47,7 @@
By default, it returns [code]false[/code].
</description>
</method>
<method name="_handles" qualifiers="virtual const">
<method name="_handles" qualifiers="virtual required const">
<return type="bool" />
<param index="0" name="type" type="String" />
<description>

4
doc/classes/EditorSceneFormatImporter.xml
View file

@ -10,7 +10,7 @@
<tutorials>
</tutorials>
<methods>
<method name="_get_extensions" qualifiers="virtual const">
<method name="_get_extensions" qualifiers="virtual required const">
<return type="PackedStringArray" />
<description>
Return supported file extensions for this scene importer.
@ -34,7 +34,7 @@
Should return [code]true[/code] to show the given option, [code]false[/code] to hide the given option, or [code]null[/code] to ignore.
</description>
</method>
<method name="_import_scene" qualifiers="virtual">
<method name="_import_scene" qualifiers="virtual required">
<return type="Object" />
<param index="0" name="path" type="String" />
<param index="1" name="flags" type="int" />

2
doc/classes/ResourceFormatLoader.xml
View file

@ -80,7 +80,7 @@
[b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them.
</description>
</method>
<method name="_load" qualifiers="virtual const">
<method name="_load" qualifiers="virtual required const">
<return type="Variant" />
<param index="0" name="path" type="String" />
<param index="1" name="original_path" type="String" />

2
doc/classes/VideoStream.xml
View file

@ -11,7 +11,7 @@
<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
</tutorials>
<methods>
<method name="_instantiate_playback" qualifiers="virtual">
<method name="_instantiate_playback" qualifiers="virtual required">
<return type="VideoStreamPlayback" />
<description>
Called when the video starts playing, to initialize and return a subclass of [VideoStreamPlayback].

17
editor/import/3d/resource_importer_scene.cpp
View file

@ -59,14 +59,10 @@
void EditorSceneFormatImporter::get_extensions(List<String> *r_extensions) const {
Vector<String> arr;
if (GDVIRTUAL_CALL(_get_extensions, arr)) {
for (int i = 0; i < arr.size(); i++) {
r_extensions->push_back(arr[i]);
}
return;
GDVIRTUAL_CALL(_get_extensions, arr);
for (int i = 0; i < arr.size(); i++) {
r_extensions->push_back(arr[i]);
}
ERR_FAIL();
}
Node *EditorSceneFormatImporter::import_scene(const String &p_path, uint32_t p_flags, const HashMap<StringName, Variant> &p_options, List<String> *r_missing_deps, Error *r_err) {
@ -75,11 +71,8 @@ Node *EditorSceneFormatImporter::import_scene(const String &p_path, uint32_t p_f
options_dict[elem.key] = elem.value;
}
Object *ret = nullptr;
if (GDVIRTUAL_CALL(_import_scene, p_path, p_flags, options_dict, ret)) {
return Object::cast_to<Node>(ret);
}
ERR_FAIL_V(nullptr);
GDVIRTUAL_CALL(_import_scene, p_path, p_flags, options_dict, ret);
return Object::cast_to<Node>(ret);
}
void EditorSceneFormatImporter::add_import_option(const String &p_name, const Variant &p_default_value) {

4
editor/import/3d/resource_importer_scene.h
View file

@ -57,8 +57,8 @@ protected:
Node *import_scene_wrapper(const String &p_path, uint32_t p_flags, const Dictionary &p_options);
Ref<Animation> import_animation_wrapper(const String &p_path, uint32_t p_flags, const Dictionary &p_options);
GDVIRTUAL0RC(Vector<String>, _get_extensions)
GDVIRTUAL3R(Object *, _import_scene, String, uint32_t, Dictionary)
GDVIRTUAL0RC_REQUIRED(Vector<String>, _get_extensions)
GDVIRTUAL3R_REQUIRED(Object *, _import_scene, String, uint32_t, Dictionary)
GDVIRTUAL1(_get_import_options, String)
GDVIRTUAL3RC(Variant, _get_option_visibility, String, bool, String)

12
editor/inspector/editor_resource_preview.cpp
View file

@ -46,18 +46,14 @@
bool EditorResourcePreviewGenerator::handles(const String &p_type) const {
bool success = false;
if (GDVIRTUAL_CALL(_handles, p_type, success)) {
return success;
}
ERR_FAIL_V_MSG(false, "EditorResourcePreviewGenerator::_handles needs to be overridden.");
GDVIRTUAL_CALL(_handles, p_type, success);
return success;
}
Ref<Texture2D> EditorResourcePreviewGenerator::generate(const Ref<Resource> &p_from, const Size2 &p_size, Dictionary &p_metadata) const {
Ref<Texture2D> preview;
if (GDVIRTUAL_CALL(_generate, p_from, p_size, p_metadata, preview)) {
return preview;
}
ERR_FAIL_V_MSG(Ref<Texture2D>(), "EditorResourcePreviewGenerator::_generate needs to be overridden.");
GDVIRTUAL_CALL(_generate, p_from, p_size, p_metadata, preview);
return preview;
}
Ref<Texture2D> EditorResourcePreviewGenerator::generate_from_path(const String &p_path, const Size2 &p_size, Dictionary &p_metadata) const {

4
editor/inspector/editor_resource_preview.h
View file

@ -44,8 +44,8 @@ class EditorResourcePreviewGenerator : public RefCounted {
protected:
static void _bind_methods();
GDVIRTUAL1RC(bool, _handles, String)
GDVIRTUAL3RC(Ref<Texture2D>, _generate, Ref<Resource>, Vector2i, Dictionary)
GDVIRTUAL1RC_REQUIRED(bool, _handles, String)
GDVIRTUAL3RC_REQUIRED(Ref<Texture2D>, _generate, Ref<Resource>, Vector2i, Dictionary)
GDVIRTUAL3RC(Ref<Texture2D>, _generate_from_path, String, Vector2i, Dictionary)
GDVIRTUAL0RC(bool, _generate_small_preview_automatically)
GDVIRTUAL0RC(bool, _can_generate_small_preview)

2
scene/resources/video_stream.h
View file

@ -94,7 +94,7 @@ class VideoStream : public Resource {
protected:
static void _bind_methods();
GDVIRTUAL0R(Ref<VideoStreamPlayback>, _instantiate_playback);
GDVIRTUAL0R_REQUIRED(Ref<VideoStreamPlayback>, _instantiate_playback);
String file;
int audio_track = 0;

32
servers/audio/audio_stream.cpp
View file

@ -33,23 +33,15 @@
#include "core/config/project_settings.h"
void AudioStreamPlayback::start(double p_from_pos) {
if (GDVIRTUAL_CALL(_start, p_from_pos)) {
return;
}
ERR_FAIL_MSG("AudioStreamPlayback::start unimplemented!");
GDVIRTUAL_CALL(_start, p_from_pos);
}
void AudioStreamPlayback::stop() {
if (GDVIRTUAL_CALL(_stop)) {
return;
}
ERR_FAIL_MSG("AudioStreamPlayback::stop unimplemented!");
GDVIRTUAL_CALL(_stop);
}
bool AudioStreamPlayback::is_playing() const {
bool ret;
if (GDVIRTUAL_CALL(_is_playing, ret)) {
return ret;
}
ERR_FAIL_V_MSG(false, "AudioStreamPlayback::is_playing unimplemented!");
bool ret = false;
GDVIRTUAL_CALL(_is_playing, ret);
return ret;
}
int AudioStreamPlayback::get_loop_count() const {
@ -59,11 +51,9 @@ int AudioStreamPlayback::get_loop_count() const {
}
double AudioStreamPlayback::get_playback_position() const {
double ret;
if (GDVIRTUAL_CALL(_get_playback_position, ret)) {
return ret;
}
ERR_FAIL_V_MSG(0, "AudioStreamPlayback::get_playback_position unimplemented!");
double ret = 0.0;
GDVIRTUAL_CALL(_get_playback_position, ret);
return ret;
}
void AudioStreamPlayback::seek(double p_time) {
GDVIRTUAL_CALL(_seek, p_time);
@ -250,10 +240,8 @@ int AudioStreamPlaybackResampled::mix(AudioFrame *p_buffer, float p_rate_scale,
Ref<AudioStreamPlayback> AudioStream::instantiate_playback() {
Ref<AudioStreamPlayback> ret;
if (GDVIRTUAL_CALL(_instantiate_playback, ret)) {
return ret;
}
ERR_FAIL_V_MSG(Ref<AudioStreamPlayback>(), "Method must be implemented!");
GDVIRTUAL_CALL(_instantiate_playback, ret);
return ret;
}
String AudioStream::get_stream_name() const {
String ret;

10
servers/audio/audio_stream.h
View file

@ -81,11 +81,11 @@ class AudioStreamPlayback : public RefCounted {
protected:
static void _bind_methods();
PackedVector2Array _mix_audio_bind(float p_rate_scale, int p_frames);
GDVIRTUAL1(_start, double)
GDVIRTUAL0(_stop)
GDVIRTUAL0RC(bool, _is_playing)
GDVIRTUAL1_REQUIRED(_start, double)
GDVIRTUAL0_REQUIRED(_stop)
GDVIRTUAL0RC_REQUIRED(bool, _is_playing)
GDVIRTUAL0RC(int, _get_loop_count)
GDVIRTUAL0RC(double, _get_playback_position)
GDVIRTUAL0RC_REQUIRED(double, _get_playback_position)
GDVIRTUAL1(_seek, double)
GDVIRTUAL3R_REQUIRED(int, _mix, GDExtensionPtr<AudioFrame>, float, int)
GDVIRTUAL0(_tag_used_streams)
@ -170,7 +170,7 @@ class AudioStream : public Resource {
protected:
static void _bind_methods();
GDVIRTUAL0RC(Ref<AudioStreamPlayback>, _instantiate_playback)
GDVIRTUAL0RC_REQUIRED(Ref<AudioStreamPlayback>, _instantiate_playback)
GDVIRTUAL0RC(String, _get_stream_name)
GDVIRTUAL0RC(double, _get_length)
GDVIRTUAL0RC(bool, _is_monophonic)