Skip to content

Commit eb0c665

Browse files
docs: auto-generate game API [no bump] [no docs]
1 parent aa44fce commit eb0c665

File tree

1,260 files changed

+12743
-2427
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,260 files changed

+12743
-2427
lines changed

docs/game/INDEX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Game API Reference
22

3-
*Generated on:* 2025-11-15 12:51
3+
*Generated on:* 2025-12-13 22:11
44

55
### Navigation
66

docs/game/_index/by-folder.md

Lines changed: 72 additions & 52 deletions
Large diffs are not rendered by default.

docs/game/_index/classes.md

Lines changed: 75 additions & 52 deletions
Large diffs are not rendered by default.

docs/game/_index/functions.md

Lines changed: 339 additions & 20 deletions
Large diffs are not rendered by default.

docs/game/scripts/ai/AIController.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,15 @@ into runner-friendly dictionaries.
4848
- [`func refresh_unit_index_cache() -> void`](AIController/functions/refresh_unit_index_cache.md) — Rebuild the ScenarioUnit id -> index cache for quick lookups.
4949
- [`func apply_trigger_sync(per_unit: Dictionary, triggers: Array) -> void`](AIController/functions/apply_trigger_sync.md) — Register trigger/task sync so tasks stay blocked until trigger activates.
5050
- [`func bind_trigger_engine(engine: TriggerEngine) -> void`](AIController/functions/bind_trigger_engine.md) — Bind TriggerEngine to receive trigger_activated notifications.
51+
- [`func bind_env_behavior_system(_env_sys: Node) -> void`](AIController/functions/bind_env_behavior_system.md) — Bind environment behaviour system signals (placeholder).
52+
- [`func _on_unit_lost(_unit_id: String) -> void`](AIController/functions/_on_unit_lost.md) — Handle unit lost event (placeholder).
53+
- [`func _on_unit_recovered(_unit_id: String) -> void`](AIController/functions/_on_unit_recovered.md) — Handle unit recovered event (placeholder).
54+
- [`func _on_unit_bogged(_unit_id: String) -> void`](AIController/functions/_on_unit_bogged.md) — Handle unit bogged event (placeholder).
55+
- [`func _on_unit_unbogged(_unit_id: String) -> void`](AIController/functions/_on_unit_unbogged.md) — Handle unit unbogged event (placeholder).
56+
- [`func apply_navigation_bias_from_order(_unit_id: String, _bias: StringName) -> void`](AIController/functions/apply_navigation_bias_from_order.md) — Apply navigation bias intent from orders (placeholder).
57+
- [`func _uid_to_index(uid: String) -> int`](AIController/functions/_uid_to_index.md)
58+
- [`func _request_engineer_if_available(unit_index: int) -> void`](AIController/functions/_request_engineer_if_available.md) — Locate an engineer-capable unit and log a support request.
59+
- [`func _emit_radio(level: String, msg: String) -> void`](AIController/functions/_emit_radio.md)
5160

5261
## Public Attributes
5362

@@ -76,6 +85,7 @@ into runner-friendly dictionaries.
7685
- `OrdersRouter _orders_router`
7786
- `Node _agents_root`
7887
- `Dictionary _unit_index_cache` — ScenarioUnit id -> index cache for quick lookup.
88+
- `Node _env_behavior_system`
7989

8090
## Member Function Documentation
8191

@@ -266,6 +276,74 @@ func bind_trigger_engine(engine: TriggerEngine) -> void
266276

267277
Bind TriggerEngine to receive trigger_activated notifications.
268278

279+
### bind_env_behavior_system
280+
281+
```gdscript
282+
func bind_env_behavior_system(_env_sys: Node) -> void
283+
```
284+
285+
Bind environment behaviour system signals (placeholder).
286+
287+
### _on_unit_lost
288+
289+
```gdscript
290+
func _on_unit_lost(_unit_id: String) -> void
291+
```
292+
293+
Handle unit lost event (placeholder).
294+
295+
### _on_unit_recovered
296+
297+
```gdscript
298+
func _on_unit_recovered(_unit_id: String) -> void
299+
```
300+
301+
Handle unit recovered event (placeholder).
302+
303+
### _on_unit_bogged
304+
305+
```gdscript
306+
func _on_unit_bogged(_unit_id: String) -> void
307+
```
308+
309+
Handle unit bogged event (placeholder).
310+
311+
### _on_unit_unbogged
312+
313+
```gdscript
314+
func _on_unit_unbogged(_unit_id: String) -> void
315+
```
316+
317+
Handle unit unbogged event (placeholder).
318+
319+
### apply_navigation_bias_from_order
320+
321+
```gdscript
322+
func apply_navigation_bias_from_order(_unit_id: String, _bias: StringName) -> void
323+
```
324+
325+
Apply navigation bias intent from orders (placeholder).
326+
327+
### _uid_to_index
328+
329+
```gdscript
330+
func _uid_to_index(uid: String) -> int
331+
```
332+
333+
### _request_engineer_if_available
334+
335+
```gdscript
336+
func _request_engineer_if_available(unit_index: int) -> void
337+
```
338+
339+
Locate an engineer-capable unit and log a support request.
340+
341+
### _emit_radio
342+
343+
```gdscript
344+
func _emit_radio(level: String, msg: String) -> void
345+
```
346+
269347
## Member Data Documentation
270348

271349
### sim_world_ref
@@ -439,3 +517,9 @@ var _unit_index_cache: Dictionary
439517
```
440518

441519
ScenarioUnit id -> index cache for quick lookup.
520+
521+
### _env_behavior_system
522+
523+
```gdscript
524+
var _env_behavior_system: Node
525+
```

docs/game/scripts/ai/AIController/functions/_apply_initial_blocks_for_unit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AIController::_apply_initial_blocks_for_unit Function Reference
22

3-
*Defined at:* `scripts/ai/AIController.gd` (lines 357–368)</br>
3+
*Defined at:* `scripts/ai/AIController.gd` (lines 358–369)</br>
44
*Belongs to:* [AIController](../../AIController.md)
55

66
**Signature**

docs/game/scripts/ai/AIController/functions/_cmp_by_src_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AIController::_cmp_by_src_index Function Reference
22

3-
*Defined at:* `scripts/ai/AIController.gd` (lines 188–191)</br>
3+
*Defined at:* `scripts/ai/AIController.gd` (lines 189–192)</br>
44
*Belongs to:* [AIController](../../AIController.md)
55

66
**Signature**

docs/game/scripts/ai/AIController/functions/_ensure_adapter_cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AIController::_ensure_adapter_cache Function Reference
22

3-
*Defined at:* `scripts/ai/AIController.gd` (lines 417–440)</br>
3+
*Defined at:* `scripts/ai/AIController.gd` (lines 418–441)</br>
44
*Belongs to:* [AIController](../../AIController.md)
55

66
**Signature**

docs/game/scripts/ai/AIController/functions/_get_node_from_path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AIController::_get_node_from_path Function Reference
22

3-
*Defined at:* `scripts/ai/AIController.gd` (lines 441–446)</br>
3+
*Defined at:* `scripts/ai/AIController.gd` (lines 442–447)</br>
44
*Belongs to:* [AIController](../../AIController.md)
55

66
**Signature**

docs/game/scripts/ai/AIController/functions/_on_engagement_reported.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AIController::_on_engagement_reported Function Reference
22

3-
*Defined at:* `scripts/ai/AIController.gd` (lines 284–332)</br>
3+
*Defined at:* `scripts/ai/AIController.gd` (lines 285–333)</br>
44
*Belongs to:* [AIController](../../AIController.md)
55

66
**Signature**

0 commit comments

Comments
 (0)