NetworkedMultiplayerENet

PacketPeer implementation using the ENet library.

A PacketPeer implementation that should be passed to SceneTree.setNetworkPeer after being initialized as either a client or server. Events can then be handled by connecting to SceneTree signals.

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

CompressionMode
enum CompressionMode
Constants
enum Constants

Functions

closeConnection
void closeConnection(long wait_usec)

Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server.

createClient
GodotError createClient(StringArg0 address, long port, long in_bandwidth, long out_bandwidth, long client_port)

Create client that connects to a server at address using specified port. The given address needs to be either a fully qualified domain nome (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 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, ERR_ALREADY_IN_USE if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call closeConnection first) or ERR_CANT_CREATE if the client could not be created. If client_port is specified, the client will also listen to the given port, this is useful in some NAT traversal technique.

createServer
GodotError createServer(long port, long max_clients, long in_bandwidth, long out_bandwidth)

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 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 4096 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 createClient. Returns OK if a server was created, ERR_ALREADY_IN_USE if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call closeConnection first) or ERR_CANT_CREATE if the server could not be created.

disconnectPeer
void disconnectPeer(long id, bool now)

Disconnect the given peer. If "now" is set to true, the connection will be closed immediately without flushing queued messages.

getChannelCount
long getChannelCount()
getCompressionMode
NetworkedMultiplayerENet.CompressionMode getCompressionMode()
getLastPacketChannel
long getLastPacketChannel()

Returns the channel of the last packet fetched via PacketPeer.getPacket

getPacketChannel
long getPacketChannel()

Returns the channel of the next packet that will be retrieved via PacketPeer.getPacket

getPeerAddress
String getPeerAddress(long id)

Returns the IP address of the given peer.

getPeerPort
long getPeerPort(long id)

Returns the remote port of the given peer.

getTransferChannel
long getTransferChannel()
isAlwaysOrdered
bool isAlwaysOrdered()
opAssign
NetworkedMultiplayerENet opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(NetworkedMultiplayerENet other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setAlwaysOrdered
void setAlwaysOrdered(bool ordered)
setBindIp
void setBindIp(StringArg0 ip)

The IP used when creating a server. This is set to the wildcard * by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: 192.168.1.1.

setChannelCount
void setChannelCount(long channels)
setCompressionMode
void setCompressionMode(long mode)
setTransferChannel
void setTransferChannel(long channel)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

alwaysOrdered
bool alwaysOrdered [@property getter]
bool alwaysOrdered [@property setter]

Always use TRANSFER_MODE_ORDERED in place of TRANSFER_MODE_UNRELIABLE. This is the only way to use ordering with the RPC system.

channelCount
long channelCount [@property getter]
long channelCount [@property setter]

The number of channels to be used by ENet. Default: 3. Channels are used to separate different kinds of data. In realiable or ordered mode, for example, the packet delivery order is ensured on a per channel basis.

compressionMode
NetworkedMultiplayerENet.CompressionMode compressionMode [@property getter]
long compressionMode [@property setter]

The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all.

transferChannel
long transferChannel [@property getter]
long transferChannel [@property setter]

Set the default channel to be used to transfer data. By default this value is -1 which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel 0 is reserved, and cannot be used. Setting this member to any value between 0 and channelCount (excluded) will force ENet to use that channel for sending data.

Static functions

_new
NetworkedMultiplayerENet _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta