diff --git a/scripts/anthill.gd b/scripts/anthill.gd index 0cace49..2937128 100644 --- a/scripts/anthill.gd +++ b/scripts/anthill.gd @@ -28,7 +28,7 @@ func space_left() -> int: return max_honeydew - honeydew -## Returns amount of honeydew that did not fit +## Returns amount of honeydew that did not fit. func deposit_honeydew(amount: int) -> int: var new_honeydew_amount := honeydew + amount var leftover: int = 0 diff --git a/scripts/bunch_spawner.gd b/scripts/bunch_spawner.gd index d3408e3..bd9bfb6 100644 --- a/scripts/bunch_spawner.gd +++ b/scripts/bunch_spawner.gd @@ -1,6 +1,6 @@ extends Marker3D class_name BunchSpawner -## Spawns a bunch of specified nodes upon entering the tree +## Spawns a bunch of specified nodes upon entering the tree. enum WhatToSpawn { APHID, diff --git a/scripts/globals/cursor_manager.gd b/scripts/globals/cursor_manager.gd index 3b2fca8..a22645c 100644 --- a/scripts/globals/cursor_manager.gd +++ b/scripts/globals/cursor_manager.gd @@ -1,5 +1,5 @@ extends Node -## Handles cursor confinement and animation +## Handles cursor confinement and animation. const CURSOR_HOTSPOT = Vector2(32, 32) diff --git a/scripts/globals/debug_manager.gd b/scripts/globals/debug_manager.gd index dfaf1bc..126b133 100644 --- a/scripts/globals/debug_manager.gd +++ b/scripts/globals/debug_manager.gd @@ -1,5 +1,5 @@ extends CanvasLayer -## Handles displaying debug info +## Handles displaying debug info. const LINE_WIDTH: float = 2 const MARKER_RADIUS: float = 0.2 diff --git a/scripts/globals/fullscreen_manager.gd b/scripts/globals/fullscreen_manager.gd index 9895fe8..14a7bfd 100644 --- a/scripts/globals/fullscreen_manager.gd +++ b/scripts/globals/fullscreen_manager.gd @@ -1,5 +1,5 @@ extends Node -## Handles fullscreen toggling +## Handles fullscreen toggling. var _is_fullscreen: bool = false diff --git a/scripts/globals/hovering_manager.gd b/scripts/globals/hovering_manager.gd index a98a471..7deb5d5 100644 --- a/scripts/globals/hovering_manager.gd +++ b/scripts/globals/hovering_manager.gd @@ -1,5 +1,5 @@ extends Node3D -## Handles mouse hovering over units +## Handles mouse hovering over units. var hovered_node: Variant diff --git a/scripts/globals/selection_manager.gd b/scripts/globals/selection_manager.gd index e40b4c0..21b265e 100644 --- a/scripts/globals/selection_manager.gd +++ b/scripts/globals/selection_manager.gd @@ -1,5 +1,5 @@ extends Node -## Handles selection of units +## Handles selection of units. const MIN_DRAG_DISTANCE: float = 15 const UNIT_SELECT_OFFSET: float = 0.25 diff --git a/scripts/globals/sound_manager.gd b/scripts/globals/sound_manager.gd index 962a4b7..6fea658 100644 --- a/scripts/globals/sound_manager.gd +++ b/scripts/globals/sound_manager.gd @@ -1,5 +1,5 @@ extends Node -## Holds all the sound effects for quick use +## Holds all the sound effects for quick use. var _pop_streams: Array[AudioStream] = [ preload("res://assets/audio/units/pop_1.wav"), diff --git a/scripts/globals/static_nodes_manager.gd b/scripts/globals/static_nodes_manager.gd index 6a44e51..e93edd3 100644 --- a/scripts/globals/static_nodes_manager.gd +++ b/scripts/globals/static_nodes_manager.gd @@ -1,10 +1,10 @@ extends Node -## Holds references to nodes that other scripts reference +## Holds references to nodes that other scripts reference. @onready var player_anthill: Anthill = $/root/World/Structures/Anthill @onready var main_camera: MainCamera = $/root/World/MainCamera -# Unit holders +# Unit holders. @onready var nitwits_holder: Node = $/root/World/Units/Nitwits @onready var gatherers_holder: Node = $/root/World/Units/Gatherers @onready var aphids_holder: Node = $/root/World/Units/Aphids diff --git a/scripts/globals/ui_manager.gd b/scripts/globals/ui_manager.gd index 7a53fcb..6e8bdc7 100644 --- a/scripts/globals/ui_manager.gd +++ b/scripts/globals/ui_manager.gd @@ -1,5 +1,5 @@ extends Node -## Holds references to all the menus +## Holds references to all the menus. @onready var anthill_info: AnthillInfo = $/root/World/UI/AnthillInfo @onready var buy_ants: BuyAnts = $/root/World/UI/BuyAnts diff --git a/scripts/main_camera.gd b/scripts/main_camera.gd index 98b3bd8..1214765 100644 --- a/scripts/main_camera.gd +++ b/scripts/main_camera.gd @@ -9,8 +9,8 @@ enum State { const ZOOM_STEP: float = 0.1 const ZOOM_DAMP: float = 5 const ZOOM_VALUE_DEFAULT: float = 0.3 -## How many pixels the mouse needs to be away -## from the screen edge to move the camera. +## How many pixels close to the screen edge +## the mouse needs to be to move the camera. const SCREEN_EDGE_THRESHOLD: float = 10 const HEADING_SPEED: float = 0.75 const WORLD_LIMIT_DISTANCE: float = 150 / 2 @@ -114,7 +114,7 @@ func _notification(what: int) -> void: _window_out_of_focus = true -## Start gradually moving camera towards a position +## Start gradually moving camera towards a position. func head_to(to: Vector3, zoom: float = ZOOM_VALUE_DEFAULT) -> void: _heading_to_position = to _heading_from_position = _target_position diff --git a/scripts/sound_effects_player.gd b/scripts/sound_effects_player.gd index 8c3d60d..04f6303 100644 --- a/scripts/sound_effects_player.gd +++ b/scripts/sound_effects_player.gd @@ -1,6 +1,6 @@ extends AudioStreamPlayer3D class_name SoundEffectsPlayer -## Wrapper of AudioStreamPlayer3D that has AudioStreamPlaybackPolyphonic +## Wrapper of AudioStreamPlayer3D that has AudioStreamPlaybackPolyphonic. var _playback: AudioStreamPlaybackPolyphonic