MultiplayerPeerExtension

Documentation

Overview

Package MultiplayerPeerExtension provides methods for working with MultiplayerPeerExtension object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AsMultiplayerPeer() MultiplayerPeer.Instance
  • func (self Instance) AsMultiplayerPeerExtension() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPacketPeer() PacketPeer.Instance
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsMultiplayerPeerExtension() Instance
}

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.MultiplayerPeerExtension

This class is designed to be inherited from a GDExtension plugin to implement custom networking layers for the multiplayer API (such as WebRTC). All the methods below [b]must[/b] be implemented to have a working custom multiplayer implementation. See also [MultiplayerAPI].

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=MultiplayerPeerExtension)

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsMultiplayerPeer

func (self Instance) AsMultiplayerPeer() MultiplayerPeer.Instance

func (Instance) AsMultiplayerPeerExtension

func (self Instance) AsMultiplayerPeerExtension() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPacketPeer

func (self Instance) AsPacketPeer() PacketPeer.Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	//Called when a packet needs to be received by the [MultiplayerAPI], with [param r_buffer_size] being the size of the binary [param r_buffer] in bytes.
	GetPacket(r_buffer unsafe.Pointer, r_buffer_size *int32) error
	//Called when a packet needs to be sent by the [MultiplayerAPI], with [param p_buffer_size] being the size of the binary [param p_buffer] in bytes.
	PutPacket(p_buffer unsafe.Pointer, p_buffer_size int) error
	//Called when the available packet count is internally requested by the [MultiplayerAPI].
	GetAvailablePacketCount() int
	//Called when the maximum allowed packet size (in bytes) is requested by the [MultiplayerAPI].
	GetMaxPacketSize() int
	//Called when a packet needs to be received by the [MultiplayerAPI], if [method _get_packet] isn't implemented. Use this when extending this class via GDScript.
	GetPacketScript() []byte
	//Called when a packet needs to be sent by the [MultiplayerAPI], if [method _put_packet] isn't implemented. Use this when extending this class via GDScript.
	PutPacketScript(p_buffer []byte) error
	//Called to get the channel over which the next available packet was received. See [method MultiplayerPeer.get_packet_channel].
	GetPacketChannel() int
	//Called to get the transfer mode the remote peer used to send the next available packet. See [method MultiplayerPeer.get_packet_mode].
	GetPacketMode() gdclass.MultiplayerPeerTransferMode
	//Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]).
	SetTransferChannel(p_channel int)
	//Called when the transfer channel to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]).
	GetTransferChannel() int
	//Called when the transfer mode is set on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]).
	SetTransferMode(p_mode gdclass.MultiplayerPeerTransferMode)
	//Called when the transfer mode to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]).
	GetTransferMode() gdclass.MultiplayerPeerTransferMode
	//Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]).
	SetTargetPeer(p_peer int)
	//Called when the ID of the [MultiplayerPeer] who sent the most recent packet is requested (see [method MultiplayerPeer.get_packet_peer]).
	GetPacketPeer() int
	//Called when the "is server" status is requested on the [MultiplayerAPI]. See [method MultiplayerAPI.is_server].
	IsServer() bool
	//Called when the [MultiplayerAPI] is polled. See [method MultiplayerAPI.poll].
	Poll()
	//Called when the multiplayer peer should be immediately closed (see [method MultiplayerPeer.close]).
	Close()
	//Called when the connected [param p_peer] should be forcibly disconnected (see [method MultiplayerPeer.disconnect_peer]).
	DisconnectPeer(p_peer int, p_force bool)
	//Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]). The value must be between [code]1[/code] and [code]2147483647[/code].
	GetUniqueId() int
	//Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]).
	SetRefuseNewConnections(p_enable bool)
	//Called when the "refuse new connections" status is requested on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]).
	IsRefusingNewConnections() bool
	//Called to check if the server can act as a relay in the current configuration. See [method MultiplayerPeer.is_server_relay_supported].
	IsServerRelaySupported() bool
	//Called when the connection status is requested on the [MultiplayerPeer] (see [method MultiplayerPeer.get_connection_status]).
	GetConnectionStatus() gdclass.MultiplayerPeerConnectionStatus
}