[][src]Struct gdnative::api::WebRTCMultiplayer

pub struct WebRTCMultiplayer { /* fields omitted */ }

core class WebRTCMultiplayer inherits NetworkedMultiplayerPeer (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

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

Class hierarchy

WebRTCMultiplayer 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

impl WebRTCMultiplayer[src]

pub fn new() -> Ref<WebRTCMultiplayer, Unique>[src]

Creates a new instance of this object.

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

pub fn add_peer(
    &self,
    peer: impl AsArg<WebRTCPeerConnection>,
    peer_id: i64,
    unreliable_lifetime: i64
) -> Result<(), GodotError>
[src]

pub fn close(&self)[src]

pub fn get_peer(&self, peer_id: i64) -> Dictionary<Shared>[src]

pub fn get_peers(&self) -> Dictionary<Shared>[src]

pub fn has_peer(&self, peer_id: i64) -> bool[src]

pub fn initialize(
    &self,
    peer_id: i64,
    server_compatibility: bool
) -> Result<(), GodotError>
[src]

pub fn remove_peer(&self, peer_id: i64)[src]

Methods from Deref<Target = NetworkedMultiplayerPeer>

pub fn get_connection_status(&self) -> ConnectionStatus[src]

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

pub fn get_packet_peer(&self) -> i64[src]

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

pub fn transfer_mode(&self) -> TransferMode[src]

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

pub fn get_unique_id(&self) -> i64[src]

Returns the ID of this [NetworkedMultiplayerPeer].

pub fn is_refusing_new_connections(&self) -> bool[src]

If [code]true[/code], this [NetworkedMultiplayerPeer] refuses new connections.

pub fn poll(&self)[src]

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

pub fn set_refuse_new_connections(&self, enable: bool)[src]

If [code]true[/code], this [NetworkedMultiplayerPeer] refuses new connections.

pub fn set_target_peer(&self, id: i64)[src]

Sets the peer to which packets will be sent.
				The [code]id[/code] 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)[src]

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

Trait Implementations

impl Debug for WebRTCMultiplayer[src]

impl Deref for WebRTCMultiplayer[src]

type Target = NetworkedMultiplayerPeer

The resulting type after dereferencing.

impl DerefMut for WebRTCMultiplayer[src]

impl GodotObject for WebRTCMultiplayer[src]

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. Read more

impl Instanciable for WebRTCMultiplayer[src]

impl SubClass<NetworkedMultiplayerPeer> for WebRTCMultiplayer[src]

impl SubClass<Object> for WebRTCMultiplayer[src]

impl SubClass<PacketPeer> for WebRTCMultiplayer[src]

impl SubClass<Reference> for WebRTCMultiplayer[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> SubClass<T> for T where
    T: GodotObject
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.