Skip to content

Commit d9cd770

Browse files
ChillerDragonChillerDragon
committed
Generate server hooks docs
1 parent a789574 commit d9cd770

File tree

2 files changed

+211
-4
lines changed

2 files changed

+211
-4
lines changed

‎docs/classes/TeeworldsServer.md

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
# TeeworldsServer
2+
3+
### <a name="on_tick"></a> #on_tick(&block)
4+
5+
**Parameter: block [Block |[context](../classes/Context.md)|]**
6+
7+
context.message is nil because there is no message payload.
8+
9+
**Example:**
10+
```ruby
11+
server = TeeworldsServer.new
12+
13+
server.on_tick do |context|
14+
# TODO: generated documentation
15+
end
16+
17+
server.run('127.0.0.1', 8377)
18+
```
19+
20+
### <a name="on_client_drop"></a> #on_client_drop(&block)
21+
22+
**Parameter: block [Block |[context](../classes/Context.md)|]**
23+
24+
context.message is a [SvClientDrop](../classes/messages/SvClientDrop.md)
25+
26+
**Example:**
27+
```ruby
28+
server = TeeworldsServer.new
29+
30+
server.on_client_drop do |context|
31+
# TODO: generated documentation
32+
end
33+
34+
server.run('127.0.0.1', 8377)
35+
```
36+
37+
### <a name="on_input"></a> #on_input(&block)
38+
39+
**Parameter: block [Block |[context](../classes/Context.md)|]**
40+
41+
TODO: generated documentation
42+
43+
**Example:**
44+
```ruby
45+
server = TeeworldsServer.new
46+
47+
server.on_input do |context|
48+
# TODO: generated documentation
49+
end
50+
51+
server.run('127.0.0.1', 8377)
52+
```
53+
54+
### <a name="on_enter_game"></a> #on_enter_game(&block)
55+
56+
**Parameter: block [Block |[context](../classes/Context.md)|]**
57+
58+
TODO: generated documentation
59+
60+
**Example:**
61+
```ruby
62+
server = TeeworldsServer.new
63+
64+
server.on_enter_game do |context|
65+
# TODO: generated documentation
66+
end
67+
68+
server.run('127.0.0.1', 8377)
69+
```
70+
71+
### <a name="on_start_info"></a> #on_start_info(&block)
72+
73+
**Parameter: block [Block |[context](../classes/Context.md)|]**
74+
75+
TODO: generated documentation
76+
77+
**Example:**
78+
```ruby
79+
server = TeeworldsServer.new
80+
81+
server.on_start_info do |context|
82+
# TODO: generated documentation
83+
end
84+
85+
server.run('127.0.0.1', 8377)
86+
```
87+
88+
### <a name="on_ready"></a> #on_ready(&block)
89+
90+
**Parameter: block [Block |[context](../classes/Context.md)|]**
91+
92+
TODO: generated documentation
93+
94+
**Example:**
95+
```ruby
96+
server = TeeworldsServer.new
97+
98+
server.on_ready do |context|
99+
# TODO: generated documentation
100+
end
101+
102+
server.run('127.0.0.1', 8377)
103+
```
104+
105+
### <a name="on_info"></a> #on_info(&block)
106+
107+
**Parameter: block [Block |[context](../classes/Context.md)|]**
108+
109+
TODO: generated documentation
110+
111+
**Example:**
112+
```ruby
113+
server = TeeworldsServer.new
114+
115+
server.on_info do |context|
116+
# TODO: generated documentation
117+
end
118+
119+
server.run('127.0.0.1', 8377)
120+
```
121+
122+
### <a name="on_emote"></a> #on_emote(&block)
123+
124+
**Parameter: block [Block |[context](../classes/Context.md)|]**
125+
126+
TODO: generated documentation
127+
128+
**Example:**
129+
```ruby
130+
server = TeeworldsServer.new
131+
132+
server.on_emote do |context|
133+
# TODO: generated documentation
134+
end
135+
136+
server.run('127.0.0.1', 8377)
137+
```
138+
139+
### <a name="on_shutdown"></a> #on_shutdown(&block)
140+
141+
**Parameter: block [Block |[context](../classes/Context.md)|]**
142+
143+
TODO: generated documentation
144+
145+
**Example:**
146+
```ruby
147+
server = TeeworldsServer.new
148+
149+
server.on_shutdown do |context|
150+
# TODO: generated documentation
151+
end
152+
153+
server.run('127.0.0.1', 8377)
154+
```
155+
156+
### <a name="on_rcon_cmd"></a> #on_rcon_cmd(&block)
157+
158+
**Parameter: block [Block |[context](../classes/Context.md)|]**
159+
160+
TODO: generated documentation
161+
162+
**Example:**
163+
```ruby
164+
server = TeeworldsServer.new
165+
166+
server.on_rcon_cmd do |context|
167+
# TODO: generated documentation
168+
end
169+
170+
server.run('127.0.0.1', 8377)
171+
```
172+
173+
### <a name="on_rcon_auth"></a> #on_rcon_auth(&block)
174+
175+
**Parameter: block [Block |[context](../classes/Context.md)|]**
176+
177+
TODO: generated documentation
178+
179+
**Example:**
180+
```ruby
181+
server = TeeworldsServer.new
182+
183+
server.on_rcon_auth do |context|
184+
# TODO: generated documentation
185+
end
186+
187+
server.run('127.0.0.1', 8377)
188+
```
189+
190+
### <a name="on_chat"></a> #on_chat(&block)
191+
192+
**Parameter: block [Block |[context](../classes/Context.md)|]**
193+
194+
context.message is nil because there is no message payload.
195+
196+
**Example:**
197+
```ruby
198+
server = TeeworldsServer.new
199+
200+
server.on_chat do |context|
201+
# TODO: generated documentation
202+
end
203+
204+
server.run('127.0.0.1', 8377)
205+
```
206+
207+

‎scripts/hooks.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ function check_file() {
220220
fi
221221
}
222222

223-
if check_file TeeworldsClient lib/teeworlds_client.rb # || check_file TeeworldsServer lib/teeworlds_server.rb
224-
then
225-
exit 1
226-
fi
223+
echo "[*] client"
224+
check_file TeeworldsClient lib/teeworlds_client.rb && exit 1
225+
echo "[*] server"
226+
check_file TeeworldsServer lib/teeworlds_server.rb && exit 1

0 commit comments

Comments
 (0)