Skip to content

Commit 39f6059

Browse files
KANAjetztKANAjetzt
authored
fix: 🐛 log spam on tool scripts (#543)
* fix: 🐛 log spam on tool scripts Moved `any_mod_hooked` to `_ModLoaderHooks` and made it a tool script. closes #519 * test: ♻️ don't forget to update the test!
1 parent 5698a12 commit 39f6059

File tree

5 files changed

+41
-39
lines changed

5 files changed

+41
-39
lines changed

‎addons/mod_loader/internal/hooks.gd

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
@tool
12
class_name _ModLoaderHooks
23
extends Object
34

@@ -7,10 +8,13 @@ extends Object
78

89
const LOG_NAME := "ModLoader:Hooks"
910

11+
static var any_mod_hooked := false
12+
13+
1014
## Internal ModLoader method. [br]
1115
## To add hooks from a mod use [method ModLoaderMod.add_hook].
1216
static func add_hook(mod_callable: Callable, script_path: String, method_name: String) -> void:
13-
ModLoaderStore.any_mod_hooked = true
17+
any_mod_hooked = true
1418
var hash := get_hook_hash(script_path, method_name)
1519
if not ModLoaderStore.modding_hooks.has(hash):
1620
ModLoaderStore.modding_hooks[hash] = []

‎addons/mod_loader/internal/mod_hook_preprocessor.gd

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func process_script_verbose(path: String, enable_hook_check := false, method_mas
6060

6161

6262
## [param path]: File path to the script to be processed.[br]
63-
## [param enable_hook_check]: Adds a check that ModLoaderStore.any_mod_hooked is [code]true[/code] to the processed method, reducing hash checks.[br]
63+
## [param enable_hook_check]: Adds a check that _ModLoaderHooks.any_mod_hooked is [code]true[/code] to the processed method, reducing hash checks.[br]
6464
## [param method_mask]: If provided, only methods in this [Array] will be processed.[br]
6565
func process_script(path: String, enable_hook_check := false, method_mask: Array[String] = []) -> String:
6666
var current_script := load(path) as GDScript
@@ -396,7 +396,7 @@ static func build_mod_hook_string(
396396
var static_string := "static " if is_static else ""
397397
var await_string := "await " if is_async else ""
398398
var async_string := "_async" if is_async else ""
399-
var hook_check := "if ModLoaderStore.any_mod_hooked:\n\t\t" if enable_hook_check else ""
399+
var hook_check := "if _ModLoaderHooks.any_mod_hooked:\n\t\t" if enable_hook_check else ""
400400
var hook_check_else := get_hook_check_else_string(
401401
return_string, await_string, method_prefix, method_name, method_arg_string_names_only
402402
) if enable_hook_check else ""

‎addons/mod_loader/mod_loader.gd

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ func _init() -> void:
212212
func _ready():
213213
# Hooks must be generated after all autoloads are available.
214214
# Variables initialized with an autoload property cause errors otherwise.
215-
if ModLoaderStore.any_mod_hooked:
215+
if _ModLoaderHooks.any_mod_hooked:
216216
if OS.has_feature("editor"):
217217
_ModLoaderModHookPacker.start()
218218
ModLoaderLog.hint("No mod hooks .zip will be created when running from the editor.", LOG_NAME)

‎addons/mod_loader/mod_loader_store.gd

-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ const MOD_LOADER_DEV_TOOL_URL := "https://github.com/GodotModding/godot-mod-tool
3232
# =============================================================================
3333

3434

35-
var any_mod_hooked := false
36-
3735
# Stores arrays of hook callables that will be applied to a function,
3836
# associated by a hash of the function name and script path
3937
# Example:

‎test/test_mod_hook_preprocessor/test_script_C_processed.gd

+33-33
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ func vanilla_2078531418_definitely_a_coroutine7(args := []):
222222

223223

224224
func _ready():
225-
if ModLoaderStore.any_mod_hooked:
225+
if _ModLoaderHooks.any_mod_hooked:
226226
_ModLoaderHooks.call_hooks(vanilla_2078531418__ready, [], 2330625102)
227227
else:
228228
vanilla_2078531418__ready()
@@ -231,225 +231,225 @@ func _ready():
231231
func method(one, #Somecomment
232232
two, three: int, #Morecomments
233233
four):
234-
if ModLoaderStore.any_mod_hooked:
234+
if _ModLoaderHooks.any_mod_hooked:
235235
return _ModLoaderHooks.call_hooks(vanilla_2078531418_method, [one, two, three, four], 2863650651)
236236
else:
237237
return vanilla_2078531418_method(one, two, three, four)
238238

239239

240240
func super_something():
241-
if ModLoaderStore.any_mod_hooked:
241+
if _ModLoaderHooks.any_mod_hooked:
242242
return _ModLoaderHooks.call_hooks(vanilla_2078531418_super_something, [], 561212438)
243243
else:
244244
return vanilla_2078531418_super_something()
245245

246246

247247
func super_something_else():
248-
if ModLoaderStore.any_mod_hooked:
248+
if _ModLoaderHooks.any_mod_hooked:
249249
return _ModLoaderHooks.call_hooks(vanilla_2078531418_super_something_else, [], 683196062)
250250
else:
251251
return vanilla_2078531418_super_something_else()
252252

253253

254254
func sup_func_two():
255-
if ModLoaderStore.any_mod_hooked:
255+
if _ModLoaderHooks.any_mod_hooked:
256256
return _ModLoaderHooks.call_hooks(vanilla_2078531418_sup_func_two, [], 1626900374)
257257
else:
258258
return vanilla_2078531418_sup_func_two()
259259

260260

261261
func sup_func():
262-
if ModLoaderStore.any_mod_hooked:
262+
if _ModLoaderHooks.any_mod_hooked:
263263
return _ModLoaderHooks.call_hooks(vanilla_2078531418_sup_func, [], 1698024413)
264264
else:
265265
return vanilla_2078531418_sup_func()
266266

267267

268268
func other_test_func():
269-
if ModLoaderStore.any_mod_hooked:
269+
if _ModLoaderHooks.any_mod_hooked:
270270
return _ModLoaderHooks.call_hooks(vanilla_2078531418_other_test_func, [], 124073286)
271271
else:
272272
return vanilla_2078531418_other_test_func()
273273

274274

275275
func hello_hello():
276-
if ModLoaderStore.any_mod_hooked:
276+
if _ModLoaderHooks.any_mod_hooked:
277277
_ModLoaderHooks.call_hooks(vanilla_2078531418_hello_hello, [], 2008108737)
278278
else:
279279
vanilla_2078531418_hello_hello()
280280

281281

282282
func hellohello(hello: String):
283-
if ModLoaderStore.any_mod_hooked:
283+
if _ModLoaderHooks.any_mod_hooked:
284284
_ModLoaderHooks.call_hooks(vanilla_2078531418_hellohello, [hello], 1633231170)
285285
else:
286286
vanilla_2078531418_hellohello(hello)
287287

288288

289289
func hello_hello_2(testing: String) -> String:
290-
if ModLoaderStore.any_mod_hooked:
290+
if _ModLoaderHooks.any_mod_hooked:
291291
return _ModLoaderHooks.call_hooks(vanilla_2078531418_hello_hello_2, [testing], 692064114)
292292
else:
293293
return vanilla_2078531418_hello_hello_2(testing)
294294

295295

296296
func hello():
297-
if ModLoaderStore.any_mod_hooked:
297+
if _ModLoaderHooks.any_mod_hooked:
298298
_ModLoaderHooks.call_hooks(vanilla_2078531418_hello, [], 1772795918)
299299
else:
300300
vanilla_2078531418_hello()
301301

302302

303303
func hello_again():
304-
if ModLoaderStore.any_mod_hooked:
304+
if _ModLoaderHooks.any_mod_hooked:
305305
_ModLoaderHooks.call_hooks(vanilla_2078531418_hello_again, [], 1999867085)
306306
else:
307307
vanilla_2078531418_hello_again()
308308

309309

310310
func more_comment_testing():
311-
if ModLoaderStore.any_mod_hooked:
311+
if _ModLoaderHooks.any_mod_hooked:
312312
_ModLoaderHooks.call_hooks(vanilla_2078531418_more_comment_testing, [], 502348540)
313313
else:
314314
vanilla_2078531418_more_comment_testing()
315315

316316

317317
static func static_super():
318-
if ModLoaderStore.any_mod_hooked:
318+
if _ModLoaderHooks.any_mod_hooked:
319319
return _ModLoaderHooks.call_hooks(vanilla_2078531418_static_super, [], 1720709936)
320320
else:
321321
return vanilla_2078531418_static_super()
322322

323323

324324
func this_is_so_cursed():
325-
if ModLoaderStore.any_mod_hooked:
325+
if _ModLoaderHooks.any_mod_hooked:
326326
return _ModLoaderHooks.call_hooks(vanilla_2078531418_this_is_so_cursed, [], 1705479347)
327327
else:
328328
return vanilla_2078531418_this_is_so_cursed()
329329

330330

331331
func this_too():
332-
if ModLoaderStore.any_mod_hooked:
332+
if _ModLoaderHooks.any_mod_hooked:
333333
return _ModLoaderHooks.call_hooks(vanilla_2078531418_this_too, [], 1507098083)
334334
else:
335335
return vanilla_2078531418_this_too()
336336

337337

338338
func please_stop():
339-
if ModLoaderStore.any_mod_hooked:
339+
if _ModLoaderHooks.any_mod_hooked:
340340
return _ModLoaderHooks.call_hooks(vanilla_2078531418_please_stop, [], 2851245561)
341341
else:
342342
return vanilla_2078531418_please_stop()
343343

344344

345345
func why_would_you(put: int, \
346346
backslashes: ="\\", in_here: ="?!\n"):
347-
if ModLoaderStore.any_mod_hooked:
347+
if _ModLoaderHooks.any_mod_hooked:
348348
return _ModLoaderHooks.call_hooks(vanilla_2078531418_why_would_you, [put, backslashes, in_here], 1414126584)
349349
else:
350350
return vanilla_2078531418_why_would_you(put, backslashes, in_here)
351351

352352

353353
func param_super(one: int, two: String) -> int:
354-
if ModLoaderStore.any_mod_hooked:
354+
if _ModLoaderHooks.any_mod_hooked:
355355
return _ModLoaderHooks.call_hooks(vanilla_2078531418_param_super, [one, two], 2371788505)
356356
else:
357357
return vanilla_2078531418_param_super(one, two)
358358

359359

360360
func other_param_super(one: int, two: String) -> int:
361-
if ModLoaderStore.any_mod_hooked:
361+
if _ModLoaderHooks.any_mod_hooked:
362362
return _ModLoaderHooks.call_hooks(vanilla_2078531418_other_param_super, [one, two], 2009491482)
363363
else:
364364
return vanilla_2078531418_other_param_super(one, two)
365365

366366

367367
func get_something():
368-
if ModLoaderStore.any_mod_hooked:
368+
if _ModLoaderHooks.any_mod_hooked:
369369
return _ModLoaderHooks.call_hooks(vanilla_2078531418_get_something, [], 3887992391)
370370
else:
371371
return vanilla_2078531418_get_something()
372372

373373

374374
func set_something():
375-
if ModLoaderStore.any_mod_hooked:
375+
if _ModLoaderHooks.any_mod_hooked:
376376
return _ModLoaderHooks.call_hooks(vanilla_2078531418_set_something, [], 2687664211)
377377
else:
378378
return vanilla_2078531418_set_something()
379379

380380

381381
func set_exclude_me():
382-
if ModLoaderStore.any_mod_hooked:
382+
if _ModLoaderHooks.any_mod_hooked:
383383
return _ModLoaderHooks.call_hooks(vanilla_2078531418_set_exclude_me, [], 1755202272)
384384
else:
385385
return vanilla_2078531418_set_exclude_me()
386386

387387

388388
func get_exclude_me():
389-
if ModLoaderStore.any_mod_hooked:
389+
if _ModLoaderHooks.any_mod_hooked:
390390
return _ModLoaderHooks.call_hooks(vanilla_2078531418_get_exclude_me, [], 2711326548)
391391
else:
392392
return vanilla_2078531418_get_exclude_me()
393393

394394

395395
func definitely_a_coroutine(args: =[]):
396-
if ModLoaderStore.any_mod_hooked:
396+
if _ModLoaderHooks.any_mod_hooked:
397397
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine, [args], 1072984126)
398398
else:
399399
return await vanilla_2078531418_definitely_a_coroutine(args)
400400

401401

402402
func definitely_a_coroutine2(args: =[]):
403-
if ModLoaderStore.any_mod_hooked:
403+
if _ModLoaderHooks.any_mod_hooked:
404404
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine2, [args], 1048737840)
405405
else:
406406
return await vanilla_2078531418_definitely_a_coroutine2(args)
407407

408408

409409
func definitely_a_coroutine3(args: =[]):
410-
if ModLoaderStore.any_mod_hooked:
410+
if _ModLoaderHooks.any_mod_hooked:
411411
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine3, [args], 1048737841)
412412
else:
413413
return await vanilla_2078531418_definitely_a_coroutine3(args)
414414

415415

416416
func definitely_a_coroutine4(args: =[]):
417-
if ModLoaderStore.any_mod_hooked:
417+
if _ModLoaderHooks.any_mod_hooked:
418418
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine4, [args], 1048737842)
419419
else:
420420
return await vanilla_2078531418_definitely_a_coroutine4(args)
421421

422422

423423
func absolutely_not_a_coroutine(args: =[]):
424-
if ModLoaderStore.any_mod_hooked:
424+
if _ModLoaderHooks.any_mod_hooked:
425425
return _ModLoaderHooks.call_hooks(vanilla_2078531418_absolutely_not_a_coroutine, [args], 2502244037)
426426
else:
427427
return vanilla_2078531418_absolutely_not_a_coroutine(args)
428428

429429

430430
func definitely_a_coroutine5(args: =[]):
431-
if ModLoaderStore.any_mod_hooked:
431+
if _ModLoaderHooks.any_mod_hooked:
432432
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine5, [args], 1048737843)
433433
else:
434434
return await vanilla_2078531418_definitely_a_coroutine5(args)
435435

436436

437437
func definitely_a_coroutine6(args: =[]):
438-
if ModLoaderStore.any_mod_hooked:
438+
if _ModLoaderHooks.any_mod_hooked:
439439
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine6, [args], 1048737844)
440440
else:
441441
return await vanilla_2078531418_definitely_a_coroutine6(args)
442442

443443

444444
func absolutely_not_a_coroutine2(args: =[]):
445-
if ModLoaderStore.any_mod_hooked:
445+
if _ModLoaderHooks.any_mod_hooked:
446446
return _ModLoaderHooks.call_hooks(vanilla_2078531418_absolutely_not_a_coroutine2, [args], 969674647)
447447
else:
448448
return vanilla_2078531418_absolutely_not_a_coroutine2(args)
449449

450450

451451
func definitely_a_coroutine7(args: =[]):
452-
if ModLoaderStore.any_mod_hooked:
452+
if _ModLoaderHooks.any_mod_hooked:
453453
return await _ModLoaderHooks.call_hooks_async(vanilla_2078531418_definitely_a_coroutine7, [args], 1048737845)
454454
else:
455455
return await vanilla_2078531418_definitely_a_coroutine7(args)

0 commit comments

Comments
 (0)