Struct WebSocketMultiplayerPeer
#[repr(C)]pub struct WebSocketMultiplayerPeer { /* private fields */ }
Expand description
Godot class WebSocketMultiplayerPeer.
Inherits MultiplayerPeer
.
Related symbols:
web_socket_multiplayer_peer
: sidecar module with related enum/flag typesIWebSocketMultiplayerPeer
: virtual methods
See also Godot docs for WebSocketMultiplayerPeer
.
§Construction
This class is reference-counted. You can create a new instance using WebSocketMultiplayerPeer::new_gd()
.
Implementations§
§impl WebSocketMultiplayerPeer
impl WebSocketMultiplayerPeer
pub fn create_client(&mut self, url: impl AsArg<GString>) -> Error
pub fn create_client(&mut self, url: impl AsArg<GString>) -> Error
To set the default parameters, use Self::create_client_ex
and its builder methods. See the book for detailed usage instructions.
pub fn create_client_ex<'a>( &'a mut self, url: impl AsArg<GString> + 'a, ) -> ExCreateClient<'a>
pub fn create_server(&mut self, port: i32) -> Error
pub fn create_server(&mut self, port: i32) -> Error
To set the default parameters, use Self::create_server_ex
and its builder methods. See the book for detailed usage instructions.
pub fn create_server_ex<'a>(&'a mut self, port: i32) -> ExCreateServer<'a>
pub fn get_peer(&self, peer_id: i32) -> Option<Gd<WebSocketPeer>>
pub fn get_peer_address(&self, id: i32) -> GString
pub fn get_peer_port(&self, id: i32) -> i32
pub fn get_supported_protocols(&self) -> PackedArray<GString>
pub fn set_supported_protocols(&mut self, protocols: &PackedArray<GString>)
pub fn get_handshake_headers(&self) -> PackedArray<GString>
pub fn set_handshake_headers(&mut self, protocols: &PackedArray<GString>)
pub fn get_inbound_buffer_size(&self) -> i32
pub fn set_inbound_buffer_size(&mut self, buffer_size: i32)
pub fn get_outbound_buffer_size(&self) -> i32
pub fn set_outbound_buffer_size(&mut self, buffer_size: i32)
pub fn get_handshake_timeout(&self) -> f32
pub fn set_handshake_timeout(&mut self, timeout: f32)
pub fn set_max_queued_packets(&mut self, max_queued_packets: i32)
pub fn get_max_queued_packets(&self) -> i32
Methods from Deref<Target = MultiplayerPeer>§
pub const TARGET_PEER_BROADCAST: i32 = 0i32
pub const TARGET_PEER_SERVER: i32 = 1i32
pub fn set_transfer_channel(&mut self, channel: i32)
pub fn get_transfer_channel(&self) -> i32
pub fn set_transfer_mode(&mut self, mode: TransferMode)
pub fn get_transfer_mode(&self) -> TransferMode
pub fn set_target_peer(&mut self, id: i32)
pub fn get_packet_peer(&self) -> i32
pub fn get_packet_channel(&self) -> i32
pub fn get_packet_mode(&self) -> TransferMode
pub fn poll(&mut self)
pub fn close(&mut self)
pub fn disconnect_peer(&mut self, peer: i32)
pub fn disconnect_peer(&mut self, peer: i32)
To set the default parameters, use Self::disconnect_peer_ex
and its builder methods. See the book for detailed usage instructions.
pub fn disconnect_peer_ex<'a>(&'a mut self, peer: i32) -> ExDisconnectPeer<'a>
pub fn get_connection_status(&self) -> ConnectionStatus
pub fn get_unique_id(&self) -> i32
pub fn generate_unique_id(&self) -> u32
pub fn set_refuse_new_connections(&mut self, enable: bool)
pub fn is_refusing_new_connections(&self) -> bool
pub fn is_server_relay_supported(&self) -> bool
Methods from Deref<Target = PacketPeer>§
pub fn get_var(&mut self) -> Variant
pub fn get_var(&mut self) -> Variant
To set the default parameters, use Self::get_var_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_var_ex<'a>(&'a mut self) -> ExGetVar<'a>
pub fn put_var(&mut self, var: &Variant) -> Error
pub fn put_var(&mut self, var: &Variant) -> Error
To set the default parameters, use Self::put_var_ex
and its builder methods. See the book for detailed usage instructions.
pub fn put_var_ex<'a>(&'a mut self, var: &'a Variant) -> ExPutVar<'a>
pub fn get_packet(&mut self) -> PackedArray<u8>
pub fn put_packet(&mut self, buffer: &PackedArray<u8>) -> Error
pub fn get_packet_error(&self) -> Error
pub fn get_available_packet_count(&self) -> i32
pub fn get_encode_buffer_max_size(&self) -> i32
pub fn set_encode_buffer_max_size(&mut self, max_size: i32)
Methods from Deref<Target = RefCounted>§
pub fn get_reference_count(&self) -> i32
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for WebSocketMultiplayerPeer
impl Bounds for WebSocketMultiplayerPeer
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for WebSocketMultiplayerPeer
impl Debug for WebSocketMultiplayerPeer
§impl Deref for WebSocketMultiplayerPeer
impl Deref for WebSocketMultiplayerPeer
§type Target = MultiplayerPeer
type Target = MultiplayerPeer
§fn deref(&self) -> &<WebSocketMultiplayerPeer as Deref>::Target
fn deref(&self) -> &<WebSocketMultiplayerPeer as Deref>::Target
§impl DerefMut for WebSocketMultiplayerPeer
impl DerefMut for WebSocketMultiplayerPeer
§fn deref_mut(&mut self) -> &mut <WebSocketMultiplayerPeer as Deref>::Target
fn deref_mut(&mut self) -> &mut <WebSocketMultiplayerPeer as Deref>::Target
§impl GodotClass for WebSocketMultiplayerPeer
impl GodotClass for WebSocketMultiplayerPeer
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§type Base = MultiplayerPeer
type Base = MultiplayerPeer
T
. This is always a Godot engine class.§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<MultiplayerPeer> for WebSocketMultiplayerPeer
impl Inherits<MultiplayerPeer> for WebSocketMultiplayerPeer
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<Object> for WebSocketMultiplayerPeer
impl Inherits<Object> for WebSocketMultiplayerPeer
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<PacketPeer> for WebSocketMultiplayerPeer
impl Inherits<PacketPeer> for WebSocketMultiplayerPeer
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<RefCounted> for WebSocketMultiplayerPeer
impl Inherits<RefCounted> for WebSocketMultiplayerPeer
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for WebSocketMultiplayerPeer
impl WithSignals for WebSocketMultiplayerPeer
§type SignalCollection<'c, C: WithSignals> = SignalsOfMultiplayerPeer<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfMultiplayerPeer<'c, C>
impl GodotDefault for WebSocketMultiplayerPeer
Auto Trait Implementations§
impl Freeze for WebSocketMultiplayerPeer
impl RefUnwindSafe for WebSocketMultiplayerPeer
impl !Send for WebSocketMultiplayerPeer
impl !Sync for WebSocketMultiplayerPeer
impl Unpin for WebSocketMultiplayerPeer
impl UnwindSafe for WebSocketMultiplayerPeer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more