Struct SceneMultiplayer

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

Expand description

Godot class SceneMultiplayer.

Inherits MultiplayerApi.

Related symbols:

scene_multiplayer: sidecar module with related enum/flag types
ISceneMultiplayer: virtual methods

§Construction

This class is reference-counted. You can create a new instance using SceneMultiplayer::new_gd().

Implementations§

§

impl SceneMultiplayer

pub fn set_root_path(&mut self, path: NodePath)

pub fn get_root_path(&self) -> NodePath

pub fn clear(&mut self)

pub fn disconnect_peer(&mut self, id: i32)

pub fn get_authenticating_peers(&mut self) -> PackedInt32Array

pub fn send_auth(&mut self, id: i32, data: &PackedByteArray) -> Error

pub fn complete_auth(&mut self, id: i32) -> Error

pub fn set_auth_callback(&mut self, callback: Callable)

pub fn get_auth_callback(&self) -> Callable

pub fn set_auth_timeout(&mut self, timeout: f64)

pub fn get_auth_timeout(&self) -> f64

pub fn set_refuse_new_connections(&mut self, refuse: bool)

pub fn is_refusing_new_connections(&self) -> bool

pub fn set_allow_object_decoding(&mut self, enable: bool)

pub fn is_object_decoding_allowed(&self) -> bool

pub fn set_server_relay_enabled(&mut self, enabled: bool)

pub fn is_server_relay_enabled(&self) -> bool

pub fn send_bytes<'a>(&mut self, bytes: &'a PackedByteArray) -> Error

To set the default parameters, use Self::send_bytes_ex and its builder methods. See the book for detailed usage instructions.

pub fn send_bytes_ex<'a>( &'a mut self, bytes: &'a PackedByteArray, ) -> ExSendBytes<'a>

pub fn get_max_sync_packet_size(&self) -> i32

pub fn set_max_sync_packet_size(&mut self, size: i32)

pub fn get_max_delta_packet_size(&self) -> i32

pub fn set_max_delta_packet_size(&mut self, size: i32)

Methods from Deref<Target = MultiplayerApi>§

pub fn has_multiplayer_peer(&mut self) -> bool

pub fn get_multiplayer_peer(&mut self) -> Option<Gd<MultiplayerPeer>>

pub fn set_multiplayer_peer(&mut self, peer: impl AsObjectArg<MultiplayerPeer>)

pub fn get_unique_id(&mut self) -> i32

pub fn is_server(&mut self) -> bool

pub fn get_remote_sender_id(&mut self) -> i32

pub fn poll(&mut self) -> Error

pub fn rpc( &mut self, peer: i32, object: impl AsObjectArg<Object>, method: StringName, ) -> Error

To set the default parameters, use Self::rpc_ex and its builder methods. See the book for detailed usage instructions.

pub fn rpc_ex<'a>( &'a mut self, peer: i32, object: impl AsObjectArg<Object>, method: StringName, ) -> ExRpc<'a>

pub fn object_configuration_add( &mut self, object: impl AsObjectArg<Object>, configuration: &Variant, ) -> Error

pub fn object_configuration_remove( &mut self, object: impl AsObjectArg<Object>, configuration: &Variant, ) -> Error

pub fn get_peers(&mut self) -> PackedInt32Array

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

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: StringName) -> ExGetMeta<'a>

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)

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: GString, ) -> ExAddUserSignal<'a>

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: &Array<Variant>, ) -> 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

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

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

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

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: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: 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: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>

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.