Struct gdnative_bindings_lily::MultiplayerAPI

pub struct MultiplayerAPI { /* fields omitted */ }

core class MultiplayerAPI inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

MultiplayerAPI inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl MultiplayerAPI

Constants

pub const RPC_MODE_DISABLED: i64

pub const RPC_MODE_MASTER: i64

pub const RPC_MODE_MASTERSYNC: i64

pub const RPC_MODE_PUPPET: i64

pub const RPC_MODE_PUPPETSYNC: i64

pub const RPC_MODE_REMOTE: i64

pub const RPC_MODE_REMOTESYNC: i64

pub const RPC_MODE_SLAVE: i64

pub const RPC_MODE_SYNC: i64

impl MultiplayerAPI

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn clear(&self)

Clears the current MultiplayerAPI network state (you shouldn’t call this unless you know what you are doing).

pub fn get_network_connected_peers(&self) -> Int32Array

Returns the peer IDs of all connected peers of this MultiplayerAPI’s [member network_peer].

pub fn network_peer(&self) -> Option<Ref<NetworkedMultiplayerPeer, Shared>>

The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node’s network mode to master, or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI’s signals.

pub fn get_network_unique_id(&self) -> i64

Returns the unique peer ID of this MultiplayerAPI’s [member network_peer].

pub fn root_node(&self) -> Option<Ref<Node, Shared>>

pub fn get_rpc_sender_id(&self) -> i64

Returns the sender’s peer ID for the RPC currently being executed. Note: If not inside an RPC this method will return 0.

pub fn has_network_peer(&self) -> bool

Returns true if there is a [member network_peer] set.

pub fn is_network_server(&self) -> bool

Returns true if this MultiplayerAPI’s [member network_peer] is in server mode (listening for connections).

pub fn is_object_decoding_allowed(&self) -> bool

If true (or if the [member network_peer] has [member PacketPeer.allow_object_decoding] set to true), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn is_refusing_new_network_connections(&self) -> bool

If true, the MultiplayerAPI’s [member network_peer] refuses new incoming connections.

pub fn poll(&self)

Method used for polling the MultiplayerAPI. You only need to worry about this if you are using [member Node.custom_multiplayer] override or you set [member SceneTree.multiplayer_poll] to false. By default, SceneTree will poll its MultiplayerAPI for you. Note: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. _process, physics, Thread).

pub fn send_bytes(&self, bytes: ByteArray, id: i64, mode: i64) -> GodotResult

Sends the given raw bytes to a specific peer identified by id (see [method NetworkedMultiplayerPeer.set_target_peer]). Default ID is 0, i.e. broadcast to all peers.

Default Arguments

• id - 0
• mode - 2

pub fn set_allow_object_decoding(&self, enable: bool)

If true (or if the [member network_peer] has [member PacketPeer.allow_object_decoding] set to true), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn set_network_peer(&self, peer: impl AsArg<NetworkedMultiplayerPeer>)

The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node’s network mode to master, or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI’s signals.

pub fn set_refuse_new_network_connections(&self, refuse: bool)

If true, the MultiplayerAPI’s [member network_peer] refuses new incoming connections.

pub fn set_root_node(&self, node: impl AsArg<Node>)

Sets the base root node to use for RPCs. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful.

Trait Implementations

impl Debug for MultiplayerAPI

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

Formats the value using the given formatter.

impl Deref for MultiplayerAPI

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for MultiplayerAPI

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for MultiplayerAPI

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for MultiplayerAPI

fn construct() -> Ref<Self, Unique>

impl Sealed for MultiplayerAPI

impl SubClass<Object> for MultiplayerAPI

impl SubClass<Reference> for MultiplayerAPI