From fee29570d0a5ee2de5b6b8e28621636489ac9bb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 19 Feb 2018 10:47:16 +0100 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/@GDScript.xml | 8 +- doc/classes/ArrayMesh.xml | 10 + doc/classes/AudioStream.xml | 6 + doc/classes/AudioStreamPlayer.xml | 2 + doc/classes/AudioStreamPlayer2D.xml | 2 + doc/classes/AudioStreamPlayer3D.xml | 2 + doc/classes/OS.xml | 26 + doc/classes/StreamPeerTCP.xml | 20 +- doc/classes/Viewport.xml | 2 +- doc/classes/VisualServer.xml | 1850 ++++++++++++++++++++++ doc/classes/WebSocketClient.xml | 53 + doc/classes/WebSocketMultiplayerPeer.xml | 31 + doc/classes/WebSocketPeer.xml | 51 + doc/classes/WebSocketServer.xml | 69 + 14 files changed, 2117 insertions(+), 15 deletions(-) create mode 100644 doc/classes/WebSocketClient.xml create mode 100644 doc/classes/WebSocketMultiplayerPeer.xml create mode 100644 doc/classes/WebSocketPeer.xml create mode 100644 doc/classes/WebSocketServer.xml diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index f12e300e4bb..2444dc4cba4 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -20,7 +20,7 @@ - + Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. @@ -38,7 +38,7 @@ - + Returns a color according to the standardised [code]name[/code] with [code]alpha[/code] ranging from 0 to 1. @@ -1131,9 +1131,9 @@ - + - + Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index e4fee6a45fa..9ea76e2702a 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -66,6 +66,16 @@ Return the amount of surfaces that the [code]ArrayMesh[/code] holds. + + + + + + + + + + diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 2c7546ebb1a..cbb16c31986 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -12,6 +12,12 @@ + + + + + + diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 6bf985640cf..f7c8f761827 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -56,6 +56,8 @@ If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants. + + If [code]true[/code] audio is playing. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index c0584eb811d..6594c9c8b91 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -62,6 +62,8 @@ Maximum distance from which audio is still hearable. + + If [code]true[/code] audio is playing. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index a9090db8d44..7eb1ff2b918 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -86,6 +86,8 @@ Decides if audio should pause when source is outside of 'max_distance' range. + + If [code]true[/code], audio is playing. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index ec01fbc32ae..f37c80efc99 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -36,6 +36,12 @@ Returns [code]true[/code] if the current host platform is using multiple threads. + + + + + + @@ -232,6 +238,12 @@ Returns the number of cores available in the host machine. + + + + + + @@ -458,6 +470,12 @@ If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. + + + + + + @@ -586,6 +604,14 @@ Enables backup saves if [code]enabled[/code] is [code]true[/code]. + + + + + + + + diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 942aa9d27af..ef856551bbe 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -29,16 +29,6 @@ Disconnect from host. - - - - - - - Disable Nagle algorithm to improve latency for small packets. - Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth. - - @@ -66,6 +56,16 @@ + + + + + + + Disable Nagle algorithm to improve latency for small packets. + Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth. + + diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 0ec4eb9cfdc..b3568321ad0 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -302,7 +302,7 @@ Amount of objects in frame. - Amount of vertices in frame. + Amount of vertices in frame. Amount of material changes in frame. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index b9034205f26..204a4a6704d 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -42,6 +42,80 @@ Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -881,6 +955,12 @@ Modulates all colors in the given canvas. + + + + + + @@ -890,6 +970,290 @@ Draws a frame. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -952,6 +1316,210 @@ Returns the id of a white texture. Creates one if none exists. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -976,6 +1544,128 @@ Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -983,6 +1673,476 @@ Initializes the visual server. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1327,6 +2487,472 @@ Sets a mesh's surface's material. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1341,6 +2967,54 @@ The callback method must use only 1 argument which will be called with 'userdata'. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1430,6 +3104,76 @@ Sets a shader's default texture. Overwrites the texture given by name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1450,6 +3194,12 @@ Sets a sky's texture. + + + + + + @@ -2214,6 +3964,24 @@ The light parameters endpoint. Used internally. + + + + + + + + + + + + + + + + + + @@ -2323,6 +4091,18 @@ A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). + + + + + + + + + + + + The nine patch gets stretched where needed. @@ -2398,5 +4178,75 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/WebSocketClient.xml b/doc/classes/WebSocketClient.xml new file mode 100644 index 00000000000..9c0685031c0 --- /dev/null +++ b/doc/classes/WebSocketClient.xml @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/WebSocketMultiplayerPeer.xml b/doc/classes/WebSocketMultiplayerPeer.xml new file mode 100644 index 00000000000..b49d4c48e0e --- /dev/null +++ b/doc/classes/WebSocketMultiplayerPeer.xml @@ -0,0 +1,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/WebSocketPeer.xml b/doc/classes/WebSocketPeer.xml new file mode 100644 index 00000000000..fba83228894 --- /dev/null +++ b/doc/classes/WebSocketPeer.xml @@ -0,0 +1,51 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/WebSocketServer.xml b/doc/classes/WebSocketServer.xml new file mode 100644 index 00000000000..887df696ff7 --- /dev/null +++ b/doc/classes/WebSocketServer.xml @@ -0,0 +1,69 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +