From bb2cac4515c5afdb53cb3c0fd4518c1f92c296b7 Mon Sep 17 00:00:00 2001 From: J08nY Date: Wed, 15 Jun 2016 20:21:15 +0200 Subject: [PATCH 1/3] Sync classref --- doc/base/classes.xml | 67 ++++++++++++++++++++++++-------------------- 1 file changed, 37 insertions(+), 30 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 4db81f487ca..cda9319b543 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -6883,6 +6883,12 @@ Return a rect containing the editable contents of the item. + + + + + + @@ -15837,6 +15843,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the duration of the current vibration effect in seconds. + + + + + + + + + + + + Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely). + + + + + + + Stops the vibration of the joystick. + + @@ -15879,26 +15906,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the mouse mode. See the constants for more information. - - - - - - - - - - - Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely). - - - - - - - Stops the vibration of the joystick. - - @@ -36925,16 +36932,16 @@ This method controls whether the position between two cached points is interpola - A status representing a [StreamPeerSSL] that is disconnected. + A status representing a [StreamPeerSSL] that is disconnected. - A status representing a [StreamPeerSSL] that is connected to a host. + A status representing a [StreamPeerSSL] that is connected to a host. - An errot status that shows the peer did not present a SSL certificate and validation was requested. + An errot status that shows the peer did not present a SSL certificate and validation was requested. - An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. + An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. @@ -36993,16 +37000,16 @@ This method controls whether the position between two cached points is interpola - The initial status of the [StreamPeerTCP], also the status after a disconnect. + The initial status of the [StreamPeerTCP], also the status after a disconnect. - A status representing a [StreamPeerTCP] that is connecting to a host. + A status representing a [StreamPeerTCP] that is connecting to a host. - A status representing a [StreamPeerTCP] that is connected to a host. + A status representing a [StreamPeerTCP] that is connected to a host. - A staus representing a [StreamPeerTCP] in error state. + A staus representing a [StreamPeerTCP] in error state. @@ -42931,7 +42938,7 @@ This method controls whether the position between two cached points is interpola - + @@ -45339,7 +45346,7 @@ This method controls whether the position between two cached points is interpola - + From 6bbc53ee18f273cd45a332847a9053a268b3937c Mon Sep 17 00:00:00 2001 From: J08nY Date: Wed, 15 Jun 2016 22:46:32 +0200 Subject: [PATCH 2/3] Fixed PacketPeer.get_var() return type in docs --- core/io/packet_peer.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/io/packet_peer.cpp b/core/io/packet_peer.cpp index 22b8bc0b39e..8e96697ac94 100644 --- a/core/io/packet_peer.cpp +++ b/core/io/packet_peer.cpp @@ -126,7 +126,7 @@ Error PacketPeer::_get_packet_error() const { void PacketPeer::_bind_methods() { - ObjectTypeDB::bind_method(_MD("get_var"),&PacketPeer::_bnd_get_var); + ObjectTypeDB::bind_method(_MD("get_var:Variant"),&PacketPeer::_bnd_get_var); ObjectTypeDB::bind_method(_MD("put_var", "var:Variant"),&PacketPeer::put_var); ObjectTypeDB::bind_method(_MD("get_packet"),&PacketPeer::_get_packet); ObjectTypeDB::bind_method(_MD("put_packet:Error", "buffer"),&PacketPeer::_put_packet); From 541a1226cd9fe136ef218d74a92a1d3ac6a76fab Mon Sep 17 00:00:00 2001 From: J08nY Date: Wed, 15 Jun 2016 22:54:21 +0200 Subject: [PATCH 3/3] Classref: added PacketPeer* --- doc/base/classes.xml | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index cda9319b543..63be9ca4177 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -23478,7 +23478,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + Get a Variant. @@ -23487,12 +23490,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Send a Variant as a packet. + Get a raw packet. @@ -23501,18 +23506,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Send a raw packet. + Return the error state of the last packet received (via [method get_packet] and [method get_var]). + Return the number of packets currently available in the ring-buffer. @@ -23540,8 +23548,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + UDP packet peer. + UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s. @@ -23552,40 +23562,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. + Close the UDP socket the [PacketPeerUDP] is currently listening on. + Wait for a packet to arrive on the listening port, see [method listen]. + Return whether this [PacketPeerUDP] is listening. + Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). @@ -23596,6 +23613,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Set the destination address and port for sending packets and variables, a hostname will be resolved if valid. @@ -36786,7 +36804,7 @@ This method controls whether the position between two cached points is interpola - Put a variable into the stream. + Put a Variant into the stream. @@ -36881,7 +36899,7 @@ This method controls whether the position between two cached points is interpola - Get a variable from the stream. + Get a Variant from the stream.