SocketPlugin

VERY WORK-IN-PROGRESS

A figura addon that allows you to open and use TCP sockets.

You can contact me at ktzukii on Discord if the mod crashes your game, or doesn't work as intended.

(please attach the logs on the message, if not you're getting a "invalid, read description")

Documentation:

SocketAPI (global socket)

These functions WILL return nil if the client (game) running the avatar (your scripts and model) is not the host (eg. your game will return a LuaSocket instance, others will return nil.)
So please add host checks on your socket scripts, otherwise your avatar will error on other clients, and will cause unneccesary trouble and confusion.

SocketAPI:newSocket(String host, Number port) -> LuaSocket
Opens a new socket, will print errors in log or throw vm error.

SocketAPI:newWebsocket(String host, Number port) -> LuaWebsocket
Opens a new websocket, will print errors in log or throw vm error.

SocketAPI:closeAllSocket( -> nil) Close all sockets on the current avatar

SocketAPI:closeAllWebsocket() -> nil Close all websockets on the current avatar

SocketAPI:closeAll() -> nil
Closes all sockets and/or websockets on the current avatar

LuaSockets

LuaSocket:hasData() -> boolean
Returns whether there's data to be recv'd or not

LuaSocket:recv() -> string
Returns any data that was sent

LuaSocket:close() -> nil
Closes the LuaSocket cleanly instead of disconnecting weirdly.

LuaSocket:isClosed() -> boolean
Returns whether the LuaSocket is closed or not.

LuaSocket:isConnected() -> boolean
Returns whether the LuaSocket is still open or not.

LuaWebsockets

These are known to be unstable and not trustworthy. I've decided to remove their documentation here since they shouldn't really be used. Documentation will remain on the Github WIKI.

Examples:

REMOVED: My examples suck :3 I'll try to add some examples on the Github WIKI, but no promises.