doc/client.md

   1 # Client interface
   2 Source code: [client.go](../client.go)
   3
   4 A client represents a connection state. A client may not yet be connected, or it may be already disconnected.
   5 After being disconnect, a client cannot be reconnected.
   6
   7 ## Functions
   8
   9 - `self:address()`: Returns address passed to `hydra.client` upon creation as a string.
  10 - `self:state()`: Returns current connection state as a string ("new", "connected", "disconnected")
  11 - `self:connect()`: Connects to server. Throws an error if the client is not in "new" state OR address resolution / dial fails (Note: If required, you can use `pcall` to catch and handle errors instead of crashing the script). Connection failure (= host found, but no minetest server running on port) is equivalent to an immediate disconnect and does not cause an error to be thrown.
  12 - `self:poll([timeout])`: Polls packets from client. See [poll.md](poll.md) for behavior and return values.
  13 - `self:close()`: Closes the network connection if in `connected` state. The client remains in `connected` state until passed to poll.
  14 - `self:enable(component)`: Enables the component with the name `component` (string), if not already enabled. By default, no components are enabled. See Components section.
  15 - `self:subscribe(pkt1, [pkt2, ...])`: Subscribes to all packet passed as arguments (strings). For available packets, see [client_pkts.md](client_pkts.md). By default, the client is not subscribed to any packets.
  16 - `self:unsubscribe(pkt1, [pkt2, ...])`: Unsubscribes from all packet passed as arguments (strings).
  17 - `self:wildcard(wildcard)`: Sets wildcard mode to `wildcard` (boolean). If wildcard is enabled, ALL packets are returned by poll, even those that the client did not subscribe to. It is not recommended to use this without a reason since converting packets to Lua costs performance and creates and overhead due to poll returning more often. `wildcard` is unnecessary if only certain packets are handled anyway, but it is useful for traffic inspection and debugging.
  18 - `self:send(pkt_name, pkt_data, [ack])`: Sends a packet to server. Throws an error if the client is not connected. `pkt_name` is the type of the packet as string. `pkt_data` is a table containing packet parameters. Some packets don't have parameters (e.g. `respawn`) - in this case, `pkt_data` can be omitted. See [server_pkts.md](server_pkts.md) for available packets. If `ack` is true, this function will block until acknowledgement from server is received.
  19
  20 ## Components
  21
  22 Enabled components can be accessed by using `self.<component name>`.
  23
  24 - `self.auth`: Handles authentication. Recommended for the vast majority of scripts. See [auth.md](auth.md).
  25 - `self.map`: Stores MapBlocks received from server. See [map.md](map.md).