ChillerDragon/teeworlds_network
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Document on_disconnect hook

Browse source
This commit is contained in:
ChillerDragon 2023-09-17 13:14:12 +02:00
parent 4810628386
commit 8d01653b6f
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/v0.0.1/classes/TeeworldsClient.md
View file

@ -4,14 +4,21 @@
**Parameter: block [Block |[context](../classes/Context.md)|]**
context.message is nil because there is no message payload.
context.message is nil but there is a key `:reason` set in the context.data hash.
By default the following disconnect message is printed `puts "got disconnect. reason='#{context.data[:reason]}'"`
if you want to skip that behavior call the `context.cancel` method.
**Example:**
```ruby
client = TeeworldsClient.new
client.on_disconnect do |context|
# TODO: generated documentation
# remove default disconnect message
context.cancel
# implement custom disconnect message
puts "got disconnect. reason='#{context.data[:reason]}'"
end
client.connect('localhost', 8303, detach: false)