Documentation
¶
Overview ¶
A MultiplayerPeer implementation that should be passed to graphics.gd/classdb/MultiplayerAPI.Instance.MultiplayerPeer after being initialized as either a client, server, or mesh. Events can then be handled by connecting to graphics.gd/classdb/MultiplayerAPI signals. See graphics.gd/classdb/ENetConnection for more information on the ENet library wrapper.
Note: ENet only uses UDP, not TCP. When forwarding the server port to make your server accessible on the public Internet, you only need to forward the server port in UDP. You can use the graphics.gd/classdb/UPNP class to try to forward the server port automatically when starting the server.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) AddMeshPeer(peer_id int, host ENetConnection.Instance) error
- func (self Instance) AsENetMultiplayerPeer() Instance
- func (self Instance) AsMultiplayerPeer() MultiplayerPeer.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPacketPeer() PacketPeer.Instance
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) CreateClient(address string, port int) error
- func (self Instance) CreateMesh(unique_id int) error
- func (self Instance) CreateServer(port int) error
- func (self Instance) GetPeer(id int) ENetPacketPeer.Instance
- func (self Instance) Host() ENetConnection.Instance
- func (self Instance) ID() ID
- func (self Instance) SetBindIp(ip string)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Expanded ¶
type Expanded [1]gdclass.ENetMultiplayerPeer
func (Expanded) CreateClient ¶
func (self Expanded) CreateClient(address string, port int, channel_count int, in_bandwidth int, out_bandwidth int, local_port int) error
Create client that connects to a server at 'address' using specified 'port'. The given address needs to be either a fully qualified domain name (e.g. "www.example.com") or an IP address in IPv4 or IPv6 format (e.g. "192.168.1.1"). The 'port' is the port the server is listening on. The 'channel_count' parameter can be used to specify the number of ENet channels allocated for the connection. The 'in_bandwidth' and 'out_bandwidth' parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [Ok] if a client was created, [ErrAlreadyInUse] if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call graphics.gd/classdb/MultiplayerPeer.Instance.Close first) or [ErrCantCreate] if the client could not be created. If 'local_port' is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques.
func (Expanded) CreateServer ¶
func (self Expanded) CreateServer(port int, max_clients int, max_channels int, in_bandwidth int, out_bandwidth int) error
Create server that listens to connections via 'port'. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use Instance.SetBindIp. The default IP is the wildcard "*", which listens on all available interfaces. 'max_clients' is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see Instance.CreateClient. Returns [Ok] if a server was created, [ErrAlreadyInUse] if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call graphics.gd/classdb/MultiplayerPeer.Instance.Close first) or [ErrCantCreate] if the server could not be created.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsENetMultiplayerPeer ¶
func (*Extension[T]) AsMultiplayerPeer ¶
func (self *Extension[T]) AsMultiplayerPeer() MultiplayerPeer.Instance
func (*Extension[T]) AsPacketPeer ¶
func (self *Extension[T]) AsPacketPeer() PacketPeer.Instance
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.ENetMultiplayerPeer
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddMeshPeer ¶
func (self Instance) AddMeshPeer(peer_id int, host ENetConnection.Instance) error
Add a new remote peer with the given 'peer_id' connected to the given 'host'.
Note: The 'host' must have exactly one peer in the [Enetpacketpeer.StateConnected] state.
func (Instance) AsENetMultiplayerPeer ¶
func (Instance) AsMultiplayerPeer ¶
func (self Instance) AsMultiplayerPeer() MultiplayerPeer.Instance
func (Instance) AsPacketPeer ¶
func (self Instance) AsPacketPeer() PacketPeer.Instance
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) CreateClient ¶
Create client that connects to a server at 'address' using specified 'port'. The given address needs to be either a fully qualified domain name (e.g. "www.example.com") or an IP address in IPv4 or IPv6 format (e.g. "192.168.1.1"). The 'port' is the port the server is listening on. The 'channel_count' parameter can be used to specify the number of ENet channels allocated for the connection. The 'in_bandwidth' and 'out_bandwidth' parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [Ok] if a client was created, [ErrAlreadyInUse] if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call graphics.gd/classdb/MultiplayerPeer.Instance.Close first) or [ErrCantCreate] if the client could not be created. If 'local_port' is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques.
func (Instance) CreateMesh ¶
Initialize this graphics.gd/classdb/MultiplayerPeer in mesh mode. The provided 'unique_id' will be used as the local peer network unique ID once assigned as the graphics.gd/classdb/MultiplayerAPI.Instance.MultiplayerPeer. In the mesh configuration you will need to set up each new peer manually using graphics.gd/classdb/ENetConnection before calling Instance.AddMeshPeer. While this technique is more advanced, it allows for better control over the connection process (e.g. when dealing with NAT punch-through) and for better distribution of the network load (which would otherwise be more taxing on the server).
func (Instance) CreateServer ¶
Create server that listens to connections via 'port'. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use Instance.SetBindIp. The default IP is the wildcard "*", which listens on all available interfaces. 'max_clients' is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see Instance.CreateClient. Returns [Ok] if a server was created, [ErrAlreadyInUse] if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call graphics.gd/classdb/MultiplayerPeer.Instance.Close first) or [ErrCantCreate] if the server could not be created.
func (Instance) GetPeer ¶
func (self Instance) GetPeer(id int) ENetPacketPeer.Instance
Returns the graphics.gd/classdb/ENetPacketPeer associated to the given 'id'.
func (Instance) Host ¶
func (self Instance) Host() ENetConnection.Instance
Source Files