Skip to content

Commit

Permalink
Fixed return type of network::connect in the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
TheQuinbox committed Jul 22, 2024
1 parent 56cd472 commit 40cc746
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# connect
Attempt to establish a connection with a server, only works when set up as a client.

`bool network::connect(string hostname, uint16 port);`
`uint64 network::connect(string hostname, uint16 port);`

## Arguments:
* string hostname: the hostname/IP address to connect to.
* uint16 port: the port to use.

## Returns:
bool: true if the connection was successful, false otherwise.
uint64: the peer ID of the connection, or 0 on error.

0 comments on commit 40cc746

Please sign in to comment.