API Reference FLHook Client v1.0.0
Modules
FLHook is a community-managed tool for managing Freelancer game servers. Freelancer is a pretty old game that has been released in 2003 by Microsoft, but it still has a very committed community.
A GenServer that connects to a FLHook socket.
A module that is responsible for decoding and encoding data streams from and to the FLHook socket.
An error indicating that decoding or encoding did not work.
A protocol to implement custom commands.
An error indicating a command returned unsuccessfully.
A struct containing configuration for a client.
An error that indicates that configuration of the client is invalid.
A struct that represents a duration.
An event that is sent by the client in event mode when something happens on the server.
An error that indicates that the socket connection is not a valid FLHook socket or the encoding is wrong.
An error indicating an invalid or missing param.
A behavior that can be implemented by custom param types.
A module that provides helpers to decode command response and event params.
A struct that contains result data and provides helpers to decode the contained data.
An error that indicates that the socket connection has a problem.
The XML text module allows composing formatted text to be sent via a chat command.