Struct godot::classes::WebSocketMultiplayerPeer

#[repr(C)]
pub struct WebSocketMultiplayerPeer { /* private fields */ }

Godot class WebSocketMultiplayerPeer.

Inherits MultiplayerPeer.

Related symbols:

• web_socket_multiplayer_peer: sidecar module with related enum/flag types
• IWebSocketMultiplayerPeer: 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

pub fn create_client(&mut self, url: GString) -> Error

pub fn create_client_ex(&mut self, url: GString) -> ExCreateClient<'_>

pub fn create_server(&mut self, port: i32) -> Error

pub fn create_server_ex(&mut self, port: i32) -> ExCreateServer<'_>

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) -> PackedStringArray

pub fn set_supported_protocols(&mut self, protocols: PackedStringArray)

pub fn get_handshake_headers(&self) -> PackedStringArray

pub fn set_handshake_headers(&mut self, protocols: PackedStringArray)

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 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_ex(&mut self, peer: i32) -> ExDisconnectPeer<'_>

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

pub const TARGET_PEER_BROADCAST: i32 = 0i32

pub const TARGET_PEER_SERVER: i32 = 1i32

Methods from Deref<Target = PacketPeer>

pub fn get_var(&mut self) -> Variant

pub fn get_var_ex(&mut self) -> ExGetVar<'_>

pub fn put_var(&mut self, var: Variant) -> Error

pub fn put_var_ex(&mut self, var: Variant) -> ExPutVar<'_>

pub fn get_packet(&mut self) -> PackedByteArray

pub fn put_packet(&mut self, buffer: PackedByteArray) -> 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_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)

pub fn get_indexed(&self, property_path: 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: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: 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: 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: 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: 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: 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: 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: StringName, value: Variant)

pub fn callv(&mut self, method: StringName, arg_array: OutArray) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> 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: StringName) -> GString

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

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)

⚠️ 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

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for WebSocketMultiplayerPeer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for WebSocketMultiplayerPeer

type Target = MultiplayerPeer

The resulting type after dereferencing.

fn deref(&self) -> &<WebSocketMultiplayerPeer as Deref>::Target

Dereferences the value.

impl DerefMut for WebSocketMultiplayerPeer

fn deref_mut(&mut self) -> &mut <WebSocketMultiplayerPeer as Deref>::Target

Mutably dereferences the value.

impl GodotClass for WebSocketMultiplayerPeer

type Base = MultiplayerPeer

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for WebSocketMultiplayerPeer

impl Inherits<MultiplayerPeer> for WebSocketMultiplayerPeer

impl Inherits<Object> for WebSocketMultiplayerPeer

impl Inherits<PacketPeer> for WebSocketMultiplayerPeer

impl Inherits<RefCounted> for WebSocketMultiplayerPeer