Struct gdnative_bindings_lily::MultiplayerPeerGDNative [−][src]
pub struct MultiplayerPeerGDNative { /* fields omitted */ }
Expand description
core class MultiplayerPeerGDNative
inherits NetworkedMultiplayerPeer
(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
MultiplayerPeerGDNative inherits methods from:
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
Methods from Deref<Target = NetworkedMultiplayerPeer>
Returns the current state of the connection. See [enum ConnectionStatus].
Returns the ID of the NetworkedMultiplayerPeer who sent the most recent packet.
The manner in which to send packets to the target_peer
. See [enum TransferMode].
Returns the ID of this NetworkedMultiplayerPeer.
If true
, this NetworkedMultiplayerPeer refuses new connections.
If true
, this NetworkedMultiplayerPeer refuses new connections.
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].
The manner in which to send packets to the target_peer
. See [enum TransferMode].
Trait Implementations
type Target = NetworkedMultiplayerPeer
type Target = NetworkedMultiplayerPeer
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for MultiplayerPeerGDNative
impl !Send for MultiplayerPeerGDNative
impl !Sync for MultiplayerPeerGDNative
impl Unpin for MultiplayerPeerGDNative
impl UnwindSafe for MultiplayerPeerGDNative