From a98295bc23ba5c0776467fd2ce6a761490e4f9cb Mon Sep 17 00:00:00 2001 From: ChillerDragon Date: Sun, 17 Sep 2023 11:03:40 +0200 Subject: [PATCH] Do not detach in sample code the sample code should be batteries included ready to go putting the detach sample in a ruby file and running it does not keep running --- docs/v0.0.1/classes/TeeworldsClient.md | 30 +++++++++++++------------- scripts/hooks.sh | 2 +- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/v0.0.1/classes/TeeworldsClient.md b/docs/v0.0.1/classes/TeeworldsClient.md index 0083992..64e1cf1 100644 --- a/docs/v0.0.1/classes/TeeworldsClient.md +++ b/docs/v0.0.1/classes/TeeworldsClient.md @@ -15,7 +15,7 @@ client.on_input_timing do |context| puts "time_left: #{context.message.time_left}" end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_maplist_entry_rem(&block) @@ -34,7 +34,7 @@ client.on_maplist_entry_rem do |context| puts context.message.name end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_maplist_entry_add(&block) @@ -53,7 +53,7 @@ client.on_maplist_entry_add do |context| puts context.message.name end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_rcon_cmd_rem(&block) @@ -70,7 +70,7 @@ client.on_rcon_cmd_rem do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_rcon_cmd_add(&block) @@ -87,7 +87,7 @@ client.on_rcon_cmd_add do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_auth_off(&block) @@ -104,7 +104,7 @@ client.on_auth_off do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_auth_on(&block) @@ -121,7 +121,7 @@ client.on_auth_on do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_snapshot(&block) @@ -138,7 +138,7 @@ client.on_snapshot do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_rcon_line(&block) @@ -155,7 +155,7 @@ client.on_rcon_line do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_disconnect(&block) @@ -172,7 +172,7 @@ client.on_disconnect do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_connected(&block) @@ -189,7 +189,7 @@ client.on_connected do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_client_info(&block) @@ -206,7 +206,7 @@ client.on_client_info do |context| # TODO: generated documentation end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_chat(&block) @@ -227,7 +227,7 @@ client.on_chat do |context, msg| puts "[chat] #{msg}" end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_map_change(&block) @@ -248,7 +248,7 @@ client.on_map_change do |context| context.cancel end -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) ``` ### #on_client_drop(&block) @@ -321,7 +321,7 @@ Send a chat message. Takes the chat message as String. ```ruby client = TeeworldsClient.new(verbose: true) -client.connect('localhost', 8303, detach: true) +client.connect('localhost', 8303, detach: false) client.send_chat('hello world!') ``` diff --git a/scripts/hooks.sh b/scripts/hooks.sh index e9f1c4b..154d71c 100755 --- a/scripts/hooks.sh +++ b/scripts/hooks.sh @@ -73,7 +73,7 @@ function add_hook_doc() { fi local tmpdoc local obj_var=client - local run="client.connect('localhost', 8303, detach: true)" + local run="client.connect('localhost', 8303, detach: false)" if [[ "$ruby_class" =~ Server ]] then obj_var=server