diff options
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/ArrayMesh.xml | 18 | ||||
-rw-r--r-- | doc/classes/AudioServer.xml | 18 | ||||
-rw-r--r-- | doc/classes/AudioStreamPlayer.xml | 9 | ||||
-rw-r--r-- | doc/classes/TranslationServer.xml | 6 |
4 files changed, 42 insertions, 9 deletions
diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 00bd72d4a5..db0fc77b25 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -205,31 +205,31 @@ Amount of weights/bone indices per vertex (always 4). </constant> <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> - Vertex array (array of [Vector3] vertices). + [PoolVector3Array], [PoolVector2Array], or [Array] of vertex positions. </constant> <constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> - Normal array (array of [Vector3] normals). + [PoolVector3Array] of vertex normals. </constant> <constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> - Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. + [PoolRealArray] of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. </constant> <constant name="ARRAY_COLOR" value="3" enum="ArrayType"> - Vertex array (array of [Color] colors). + [PoolColorArray] of vertex colors. </constant> <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> - UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + [PoolVector2Array] for UV coordinates. </constant> <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> - Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + [PoolVector2Array] for second UV coordinates. </constant> <constant name="ARRAY_BONES" value="6" enum="ArrayType"> - Array of bone indices, as a float array. Each element in groups of 4 floats. + [PoolRealArray] or [PoolIntArray] of bone indices. Each element in groups of 4 floats. </constant> <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> - Array of bone weights, as a float array. Each element in groups of 4 floats. + [PoolRealArray] of bone weights. Each element in groups of 4 floats. </constant> <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> - [Array] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. + [PoolIntArray] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line. </constant> <constant name="ARRAY_MAX" value="9" enum="ArrayType"> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 83fbd28152..6dc1600cf2 100644 --- a/doc/classes/AudioServer.xml +++ b/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> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index c6ec45f15e..07d7c875db 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/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> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index a3acc2c659..05774635b8 100644 --- a/doc/classes/TranslationServer.xml +++ b/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> |