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

Generate docs

Browse source
This commit is contained in:
ChillerDragon 2023-09-17 11:51:46 +02:00
parent 49b2806966
commit 84e0bd67de
2 changed files with 57 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,5 +1,56 @@
# TeeworldsClient # TeeworldsClient
### <a name="on_rcon_line"></a> #on_rcon_line(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]**
context.message is a [RconLine](../classes/messages/RconLine.md)
**Example:**
```ruby
client = TeeworldsClient.new
client.on_rcon_line do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: false)
```
### <a name="on_auth_off"></a> #on_auth_off(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]**
context.message is nil because there is no message payload.
**Example:**
```ruby
client = TeeworldsClient.new
client.on_auth_off do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: false)
```
### <a name="on_auth_on"></a> #on_auth_on(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]**
context.message is nil because there is no message payload.
**Example:**
```ruby
client = TeeworldsClient.new
client.on_auth_on do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: false)
```
### <a name="on_input_timing"></a> #on_input_timing(&block) ### <a name="on_input_timing"></a> #on_input_timing(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]** **Parameter: block [Block |[context](../classes/Context.md)|]**
@ -90,40 +141,6 @@ end
client.connect('localhost', 8303, detach: false) client.connect('localhost', 8303, detach: false)
``` ```
### <a name="on_auth_off"></a> #on_auth_off(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]**
TODO: generated documentation
**Example:**
```ruby
client = TeeworldsClient.new
client.on_auth_off do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: false)
```
### <a name="on_auth_on"></a> #on_auth_on(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]**
TODO: generated documentation
**Example:**
```ruby
client = TeeworldsClient.new
client.on_auth_on do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: false)
```
### <a name="on_snapshot"></a> #on_snapshot(&block) ### <a name="on_snapshot"></a> #on_snapshot(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]** **Parameter: block [Block |[context](../classes/Context.md)|]**
@ -141,23 +158,6 @@ end
client.connect('localhost', 8303, detach: false) client.connect('localhost', 8303, detach: false)
``` ```
### <a name="on_rcon_line"></a> #on_rcon_line(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]**
TODO: generated documentation
**Example:**
```ruby
client = TeeworldsClient.new
client.on_rcon_line do |context|
# TODO: generated documentation
end
client.connect('localhost', 8303, detach: false)
```
### <a name="on_disconnect"></a> #on_disconnect(&block) ### <a name="on_disconnect"></a> #on_disconnect(&block)
**Parameter: block [Block |[context](../classes/Context.md)|]** **Parameter: block [Block |[context](../classes/Context.md)|]**

6
docs/v0.0.1/classes/messages/RconLine.md Normal file
View file

@ -0,0 +1,6 @@
# RconLine
Server -> Client
### @command [String]