lua-enet

Available since LÖVE 0.9.0
This module is not supported in earlier versions.


Official documentation for lua-enet is available here. ENet's features are listed on its homepage. The official documentation may have typos. The documentation on this wiki reflects Löve's implementation, meaning it should be safe to follow what's written here.

lua-enet is simply some Lua bindings for ENet.

ENet's purpose is to provide a relatively thin, simple and robust network communication layer for games on top of UDP (User Datagram Protocol).The primary feature it provides is optional reliable, in-order delivery of packets.

ENet omits certain higher level networking features such as authentication, lobbying, server discovery, encryption, or other similar tasks that are particularly application specific so that the library remains flexible, portable, and easily embeddable.

Types

Type Description
host An ENet host for communicating with peers.
peer An ENet peer which data packets may be sent or received from.
event A simple table containing information on an event.

Functions

Function Description
host_create Returns a new host.
linked_version Returns the included ENet's version string.

Examples

server.lua

-- server.lua
require "enet"
local host = enet.host_create("localhost:6789")
while true do
  local event = host:service(100)
  while event do
    if event.type == "receive" then
      print("Got message: ", event.data, event.peer)
      event.peer:send( "pong" )
    elseif event.type == "connect" then
      print(event.peer, "connected.")
    elseif event.type == "disconnect" then
      print(event.peer, "disconnected.")
    end
    event = host:service()
  end
end

client.lua

-- client.lua
require "enet"
local host = enet.host_create()
local server = host:connect("localhost:6789")
while true do
  local event = host:service(100)
  while event do
    if event.type == "receive" then
      print("Got message: ", event.data, event.peer)
      event.peer:send( "ping" )
    elseif event.type == "connect" then
      print(event.peer, "connected.")
      event.peer:send( "ping" )
    elseif event.type == "disconnect" then
      print(event.peer, "disconnected.")
    end
    event = host:service()
  end
end

See Also


enet.host
  • References/Game Development/LÖVE/love/Third-party modules/lua-enet

enet.host Description An ENet host for communicating with peers. On creation it will bind to a port on an address, unless otherwise specified, which will keep other

2025-01-10 15:47:30
enet.peer:timeout
  • References/Game Development/LÖVE/love/Third-party modules/lua-enet

enet.peer:timeout Returns or sets the parameters when a timeout is detected. This is happens either after a fixed timeout or a variable timeout of time that takes the round trip time into

2025-01-10 15:47:30
enet.host:total sent data
  • References/Game Development/LÖVE/love/Third-party modules/lua-enet

enet.host:total sent data Returns the number of bytes that were sent through the given

2025-01-10 15:47:30
enet.host:compress with range coder
  • References/Game Development/LÖVE/love/Third-party modules/lua-enet

enet.host:compress with range coder Toggles an adaptive order-2 PPM

2025-01-10 15:47:30
enet.peer
  • References/Game Development/LÖVE/love/Third-party modules/lua-enet

enet.peer Description An ENet peer which data packets may be sent or received from. In most applications you'll manually keep track of connected peers.

2025-01-10 15:47:30