Struct gdnative_bindings_lily::NetworkedMultiplayerPeer

pub struct NetworkedMultiplayerPeer { /* fields omitted */ }

core class NetworkedMultiplayerPeer inherits PacketPeer (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

NetworkedMultiplayerPeer inherits methods from:

• PacketPeer
• 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 NetworkedMultiplayerPeer

Constants

pub const CONNECTION_CONNECTED: i64

pub const CONNECTION_CONNECTING: i64

pub const CONNECTION_DISCONNECTED: i64

pub const TARGET_PEER_BROADCAST: i64

pub const TARGET_PEER_SERVER: i64

pub const TRANSFER_MODE_RELIABLE: i64

pub const TRANSFER_MODE_UNRELIABLE: i64

pub const TRANSFER_MODE_UNRELIABLE_ORDERED: i64

impl NetworkedMultiplayerPeer

pub fn get_connection_status(&self) -> ConnectionStatus

Returns the current state of the connection. See [enum ConnectionStatus].

pub fn get_packet_peer(&self) -> i64

Returns the ID of the NetworkedMultiplayerPeer who sent the most recent packet.

pub fn transfer_mode(&self) -> TransferMode

The manner in which to send packets to the target_peer. See [enum TransferMode].

pub fn get_unique_id(&self) -> i64

Returns the ID of this NetworkedMultiplayerPeer.

pub fn is_refusing_new_connections(&self) -> bool

If true, this NetworkedMultiplayerPeer refuses new connections.

pub fn poll(&self)

Waits up to 1 second to receive a new network event.

pub fn set_refuse_new_connections(&self, enable: bool)

If true, this NetworkedMultiplayerPeer refuses new connections.

pub fn set_target_peer(&self, id: i64)

Sets the peer to which packets will be sent. The id can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST].

pub fn set_transfer_mode(&self, mode: i64)

The manner in which to send packets to the target_peer. See [enum TransferMode].

Methods from Deref<Target = PacketPeer>

pub fn get_available_packet_count(&self) -> i64

Returns the number of packets currently available in the ring-buffer.

pub fn encode_buffer_max_size(&self) -> i64

Maximum buffer size allowed when encoding Variants. Raise this value to support heavier memory allocations. The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the Variant. If the Variant is bigger than encode_buffer_max_size, the method will error out with [constant ERR_OUT_OF_MEMORY].

pub fn get_packet(&self) -> ByteArray

Gets a raw packet.

pub fn get_packet_error(&self) -> GodotResult

Returns the error state of the last packet received (via [method get_packet] and [method get_var]).

pub fn get_var(&self, allow_objects: bool) -> Variant

Gets a Variant. If allow_objects (or [member allow_object_decoding]) is true, decoding objects is allowed. 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.

Default Arguments

• allow_objects - false

pub fn is_object_decoding_allowed(&self) -> bool

[i]Deprecated.[/i] Use get_var and put_var parameters instead. If true, the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. 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 put_packet(&self, buffer: ByteArray) -> GodotResult

Sends a raw packet.

pub fn put_var(
    &self,
    var: impl OwnedToVariant,
    full_objects: bool
) -> GodotResult

Sends a Variant as a packet. If full_objects (or [member allow_object_decoding]) is true, encoding objects is allowed (and can potentially include code).

Default Arguments

• full_objects - false

pub fn set_allow_object_decoding(&self, enable: bool)

[i]Deprecated.[/i] Use get_var and put_var parameters instead. If true, the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. 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_encode_buffer_max_size(&self, max_size: i64)

Maximum buffer size allowed when encoding Variants. Raise this value to support heavier memory allocations. The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the Variant. If the Variant is bigger than encode_buffer_max_size, the method will error out with [constant ERR_OUT_OF_MEMORY].

Trait Implementations

impl Debug for NetworkedMultiplayerPeer

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

Formats the value using the given formatter.

impl Deref for NetworkedMultiplayerPeer

type Target = PacketPeer

The resulting type after dereferencing.

fn deref(&self) -> &PacketPeer

Dereferences the value.

impl DerefMut for NetworkedMultiplayerPeer

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

Mutably dereferences the value.

impl GodotObject for NetworkedMultiplayerPeer

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 Sealed for NetworkedMultiplayerPeer

impl SubClass<NetworkedMultiplayerPeer> for WebSocketMultiplayerPeer

impl SubClass<NetworkedMultiplayerPeer> for NetworkedMultiplayerENet

impl SubClass<NetworkedMultiplayerPeer> for WebSocketServer

impl SubClass<NetworkedMultiplayerPeer> for WebRTCMultiplayer

impl SubClass<NetworkedMultiplayerPeer> for MultiplayerPeerGDNative

impl SubClass<NetworkedMultiplayerPeer> for WebSocketClient

impl SubClass<Object> for NetworkedMultiplayerPeer

impl SubClass<PacketPeer> for NetworkedMultiplayerPeer

impl SubClass<Reference> for NetworkedMultiplayerPeer