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

Regenerate some docs

Browse source
This commit is contained in:
ChillerDragon 2022-11-26 11:46:30 +01:00
parent 4b62df1051
commit e4cd8956be
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,7 +4,7 @@
**Parameter: block [Block |[context](../classes/Context.md)|]**
TODO: generated documentation
context.message is a [MaplistEntryRem](../classes/messages/MaplistEntryRem.md)
**Example:**
```ruby
@ -28,9 +28,7 @@ context.message is a [MaplistEntryAdd](../classes/messages/MaplistEntryAdd.md)
client = TeeworldsClient.new
client.on_maplist_entry_add do |context|
# print all map names the server
# sends to the client
puts context.message.name
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: true)
@ -40,16 +38,14 @@ client.connect('localhost', 8303, detach: true)
**Parameter: block [Block |[context](../classes/Context.md)|]**
context.message is a [MaplistEntryRem](../classes/messages/MaplistEntryRem.md)
context.message is a [RconCmdRem](../classes/messages/RconCmdRem.md)
**Example:**
```ruby
client = TeeworldsClient.new
client.on_maplist_entry_rem do |context|
# print all map names the server
# sends to the client
puts context.message.name
client.on_rcon_cmd_rem do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: true)
@ -59,7 +55,7 @@ client.connect('localhost', 8303, detach: true)
**Parameter: block [Block |[context](../classes/Context.md)|]**
TODO: generated documentation
context.message is a [RconCmdAdd](../classes/messages/RconCmdAdd.md)
**Example:**
```ruby