فهرست منبع

Added docs to AudioStreamPlayer for get_mix_time

Juan Linietsky 6 سال پیش
والد
کامیت
11fb4ffbf8
3فایلهای تغییر یافته به همراه33 افزوده شده و 0 حذف شده
  1. 18 0
      doc/classes/AudioServer.xml
  2. 9 0
      doc/classes/AudioStreamPlayer.xml
  3. 6 0
      doc/classes/TranslationServer.xml

+ 18 - 0
doc/classes/AudioServer.xml

@@ -184,6 +184,12 @@
 				Returns the sample rate at the output of the audioserver.
 			</description>
 		</method>
+		<method name="get_output_latency" qualifiers="const">
+			<return type="float">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_speaker_mode" qualifiers="const">
 			<return type="int" enum="AudioServer.SpeakerMode">
 			</return>
@@ -191,6 +197,18 @@
 				Returns the speaker configuration.
 			</description>
 		</method>
+		<method name="get_time_since_last_mix" qualifiers="const">
+			<return type="float">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="get_time_to_next_mix" qualifiers="const">
+			<return type="float">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="is_bus_bypassing_effects" qualifiers="const">
 			<return type="bool">
 			</return>

+ 9 - 0
doc/classes/AudioStreamPlayer.xml

@@ -10,6 +10,15 @@
 		<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
 	</tutorials>
 	<methods>
+		<method name="get_mix_time" qualifiers="const">
+			<return type="float">
+			</return>
+			<description>
+			Returns the actual amount of time this stream player was mixing since play() was pressed.
+			To know the exact position this song is mixing right now, add the value to [method AudioServer.get_time_since_last_mix].
+			Also consider substracting [method AudioServer.get_output_latency] to that result.			
+			</description>
+		</method>
 		<method name="get_playback_position">
 			<return type="float">
 			</return>

+ 6 - 0
doc/classes/TranslationServer.xml

@@ -27,6 +27,12 @@
 				Clears the server from all translations.
 			</description>
 		</method>
+		<method name="get_loaded_locales" qualifiers="const">
+			<return type="Array">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_locale" qualifiers="const">
 			<return type="String">
 			</return>