Merge pull request #492 from V-Sekai/code-style

Add code gdformat.

Author: fire

.github/workflows/code_style.yaml

@@ -0,0 +1,22 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  pre-commit-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: local
+    hooks:
+      # vsk_importer_exporter is ignored due to broken code.
+      # VRM and godot_state_charts are ignored because upstream changes are complicated
+      - id: gdformat
+        name: gdformat
+        entry: gdformat
+        language: python
+        additional_dependencies: [gdtoolkit==4.3.3]
+        types: [gdscript]
+        exclude: |
+          (?x)^(
+            addons/vsk_importer_exporter/.*|
+            addons/godot_state_charts/.* |
+            addons/vrm/.* |
+            addons/Godot-MToon-Shader/.* 
+          )$

addons/actor/actor_state_machine.gd

@@ -116,6 +116,16 @@ func update(p_delta: float) -> void:
 func start() -> void:
 	super.start()
 	if !Engine.is_editor_hint():
-		states_map = {"Spawned": get_node_or_null("Spawned"), "Idle": get_node_or_null("Idle"), "Locomotion": get_node_or_null("Locomotion"), "Falling": get_node_or_null("Falling"), "Stop": get_node_or_null("Stop"), "Landed": get_node_or_null("Landed"), "Pre-Jump": get_node_or_null("Pre-Jump"), "Networked": get_node_or_null("Networked"), "Noclip": get_node_or_null("Noclip")}
+		states_map = {
+			"Spawned": get_node_or_null("Spawned"),
+			"Idle": get_node_or_null("Idle"),
+			"Locomotion": get_node_or_null("Locomotion"),
+			"Falling": get_node_or_null("Falling"),
+			"Stop": get_node_or_null("Stop"),
+			"Landed": get_node_or_null("Landed"),
+			"Pre-Jump": get_node_or_null("Pre-Jump"),
+			"Networked": get_node_or_null("Networked"),
+			"Noclip": get_node_or_null("Noclip")
+		}
 
 		actor_controller = get_node_or_null(actor_controller_path)

addons/actor/controller_helpers.gd

@@ -10,7 +10,9 @@ static func get_direction_to(p_start: Vector3, p_end: Vector3) -> Vector3:
 
 
 static func convert_euler_to_normal(p_euler: Vector3) -> Vector3:
-	return Vector3(cos(p_euler.x) * sin(p_euler.y), -sin(p_euler.x), cos(p_euler.y) * cos(p_euler.x))
+	return Vector3(
+		cos(p_euler.x) * sin(p_euler.y), -sin(p_euler.x), cos(p_euler.y) * cos(p_euler.x)
+	)
 
 
 static func convert_normal_to_euler(p_normal: Vector3) -> Vector2:
@@ -26,7 +28,9 @@ static func get_absolute_basis(p_basis: Basis) -> Basis:
 	return m
 
 
-static func get_spatial_relative_movement_velocity(p_spatial: Node3D, p_input_direction: Vector2) -> Vector3:
+static func get_spatial_relative_movement_velocity(
+	p_spatial: Node3D, p_input_direction: Vector2
+) -> Vector3:
 	var new_direction: Vector3 = Vector3()
 
 	if p_spatial:

addons/actor/movement_controller.gd

@@ -44,7 +44,9 @@ func get_character_body() -> CharacterBody3D:
 func set_direction_normal(p_normal: Vector3) -> void:
 	if p_normal == Vector3():
 		return
-	set_global_transform(get_global_transform().looking_at(get_global_origin() + p_normal, Vector3(0, 1, 0)))
+	set_global_transform(
+		get_global_transform().looking_at(get_global_origin() + p_normal, Vector3(0, 1, 0))
+	)
 
 
 func get_direction_normal() -> Vector3:
@@ -57,7 +59,9 @@ func move(p_target_velocity: Vector3) -> void:
 			_character_body.velocity = p_target_velocity
 			_character_body.move_and_slide()
 			motion_vector = _character_body.velocity
-		set_global_transform(Transform3D(get_global_transform().basis, _character_body.global_transform.origin))
+		set_global_transform(
+			Transform3D(get_global_transform().basis, _character_body.global_transform.origin)
+		)
 
 
 func set_movement_vector(p_target_velocity: Vector3) -> void:

addons/actor/player_camera_controller.gd

@@ -42,7 +42,9 @@ var origin_offset: Vector3 = Vector3()
 signal camera_mode_changed(p_camera_mode)
 
 
-func test_collision_point(p_ds: PhysicsDirectSpaceState3D, p_distance: float, p_start: Vector3, p_end: Vector3) -> float:
+func test_collision_point(
+	p_ds: PhysicsDirectSpaceState3D, p_distance: float, p_start: Vector3, p_end: Vector3
+) -> float:
 	var param: PhysicsRayQueryParameters3D = PhysicsRayQueryParameters3D.new()
 	param.from = p_start
 	param.to = p_end
@@ -85,15 +87,19 @@ func get_camera_clip_distance(_camera) -> float:
 
 func update() -> void:
 	if InputManager.is_ingame_action_just_pressed("toggle_camera_mode"):
-		camera_mode = CAMERA_THIRD_PERSON if camera_mode == CAMERA_FIRST_PERSON else CAMERA_FIRST_PERSON
+		camera_mode = (
+			CAMERA_THIRD_PERSON if camera_mode == CAMERA_FIRST_PERSON else CAMERA_FIRST_PERSON
+		)
 		camera_mode_changed.emit(camera_mode)
 
 	var corrected_pitch: float = 0.0
 	if is_active and !VRManager.is_xr_active():
 		corrected_pitch = clamp(rotation_pitch, rotation_pitch_min, rotation_pitch_max)
 
 	var pitch_basis: Basis = Basis().rotated(Vector3(-1.0, 0.0, 0.0), corrected_pitch)
-	var yaw_basis: Basis = Basis().rotated(Vector3(0.0, 1.0, 0.0), rotation_yaw + rotation_yaw_snap_offset - PI)
+	var yaw_basis: Basis = Basis().rotated(
+		Vector3(0.0, 1.0, 0.0), rotation_yaw + rotation_yaw_snap_offset - PI
+	)
 
 	transform.origin = Vector3()
 	transform.basis = yaw_basis

addons/actor/player_controller.gd

@@ -39,7 +39,8 @@ var _collider: CollisionShape3D = null
 @export_flags_3d_physics var local_player_collision: int = 1
 @export_flags_3d_physics var other_player_collision: int = 1
 
-@onready var physics_fps: int = ProjectSettings.get_setting("physics/common/physics_ticks_per_second")
+@onready
+var physics_fps: int = ProjectSettings.get_setting("physics/common/physics_ticks_per_second")
 
 @export var ik_space_path: NodePath = NodePath()
 var _ik_space: Node3D = null
@@ -138,7 +139,10 @@ func _master_movement(p_delta: float) -> void:
 
 func update_origin() -> void:
 	# There is a slight delay in the movement, but this allows framerate independent movement
-	if entity_node.hierarchy_component_node and entity_node.hierarchy_component_node.get_entity_parent():
+	if (
+		entity_node.hierarchy_component_node
+		and entity_node.hierarchy_component_node.get_entity_parent()
+	):
 		current_origin = entity_node.global_transform.origin
 	else:
 		current_origin = entity_node.transform.origin
@@ -192,7 +196,9 @@ func _on_transform_changed() -> void:
 
 
 func _get_desired_direction() -> Basis:
-	var camera_controller_yaw_basis = Basis().rotated(Vector3(0, 1, 0), _camera_controller_node.rotation_yaw)
+	var camera_controller_yaw_basis = Basis().rotated(
+		Vector3(0, 1, 0), _camera_controller_node.rotation_yaw
+	)
 
 	var basis: Basis = camera_controller_yaw_basis
 
@@ -201,15 +207,35 @@ func _get_desired_direction() -> Basis:
 		match VRManager.vr_user_preferences.movement_orientation:
 			VRManager.vr_user_preferences_const.movement_orientation_enum.HEAD_ORIENTED_MOVEMENT:
 				basis = camera_controller_yaw_basis * _camera_controller_node.camera.transform.basis
-			VRManager.vr_user_preferences_const.movement_orientation_enum.PLAYSPACE_ORIENTED_MOVEMENT:
+			(
+				VRManager
+				. vr_user_preferences_const
+				. movement_orientation_enum
+				. PLAYSPACE_ORIENTED_MOVEMENT
+			):
 				basis = camera_controller_yaw_basis
 			VRManager.vr_user_preferences_const.movement_orientation_enum.HAND_ORIENTED_MOVEMENT:
-				basis = camera_controller_yaw_basis * _player_input.vr_locomotion_component.get_controller_direction()
+				basis = (
+					camera_controller_yaw_basis
+					* _player_input.vr_locomotion_component.get_controller_direction()
+				)
 
 	if using_flight_controls():
-		return Basis(Vector3(-cos(basis.get_euler().y), 0.0, sin(basis.get_euler().y)), Vector3(), Vector3(sin(basis.get_euler().y) * cos(basis.get_euler().x), sin(basis.get_euler().x), cos(basis.get_euler().y) * cos(basis.get_euler().x)))
+		return Basis(
+			Vector3(-cos(basis.get_euler().y), 0.0, sin(basis.get_euler().y)),
+			Vector3(),
+			Vector3(
+				sin(basis.get_euler().y) * cos(basis.get_euler().x),
+				sin(basis.get_euler().x),
+				cos(basis.get_euler().y) * cos(basis.get_euler().x)
+			)
+		)
 	else:
-		return Basis(Vector3(-cos(basis.get_euler().y), 0.0, sin(basis.get_euler().y)), Vector3(), Vector3(sin(basis.get_euler().y), 0.0, cos(basis.get_euler().y)))
+		return Basis(
+			Vector3(-cos(basis.get_euler().y), 0.0, sin(basis.get_euler().y)),
+			Vector3(),
+			Vector3(sin(basis.get_euler().y), 0.0, cos(basis.get_euler().y))
+		)
 
 
 func _on_touched_by_body(p_body) -> void:
@@ -249,7 +275,9 @@ func _setup_target() -> void:
 
 
 func _update_master_transform() -> void:
-	var camera_controller_yaw_basis = Basis().rotated(Vector3(0, 1, 0), _camera_controller_node.rotation_yaw)
+	var camera_controller_yaw_basis = Basis().rotated(
+		Vector3(0, 1, 0), _camera_controller_node.rotation_yaw
+	)
 
 	set_transform(Transform3D(camera_controller_yaw_basis, get_origin()))
 
@@ -287,7 +315,10 @@ func _entity_physics_process(p_delta: float) -> void:
 	update_origin()
 
 	# There is a slight delay in the movement, but this allows framerate independent movement
-	if entity_node.hierarchy_component_node and entity_node.hierarchy_component_node.get_entity_parent():
+	if (
+		entity_node.hierarchy_component_node
+		and entity_node.hierarchy_component_node.get_entity_parent()
+	):
 		current_origin = entity_node.global_transform.origin
 	else:
 		current_origin = entity_node.transform.origin
@@ -361,7 +392,12 @@ func _puppet_ready() -> void:
 	_state_machine.start_state = NodePath("Networked")
 
 	### Avatar ###
-	if VSKNetworkManager.player_avatar_path_updated.connect(self._player_network_avatar_path_updated) != OK:
+	if (
+		VSKNetworkManager.player_avatar_path_updated.connect(
+			self._player_network_avatar_path_updated
+		)
+		!= OK
+	):
 		push_error("Failed to connect player_avatar_path_updated signal.")
 		return
 	if VSKNetworkManager.player_avatar_paths.has(get_multiplayer_authority()):

addons/actor/senses.gd

@@ -22,8 +22,12 @@ func get_actor_eye_transform() -> Transform3D:
 	#	return get_global_origin() + Transform(Basis(), extended_kinematic_body.up * eye_height)
 
 
-func can_see_collider_point(p_point: Vector3, p_exclusion_array: Array = [], p_collision_bits: int = 1) -> bool:
-	var dss: PhysicsDirectSpaceState3D = entity_node.PhysicsServer3D.space_get_direct_state(entity_node.get_world_3d().get_space())
+func can_see_collider_point(
+	p_point: Vector3, p_exclusion_array: Array = [], p_collision_bits: int = 1
+) -> bool:
+	var dss: PhysicsDirectSpaceState3D = entity_node.PhysicsServer3D.space_get_direct_state(
+		entity_node.get_world_3d().get_space()
+	)
 	if dss:
 		camera_planes = camera_matrix.get_projection_planes(get_actor_eye_transform())
 
@@ -42,8 +46,12 @@ func can_see_collider_point(p_point: Vector3, p_exclusion_array: Array = [], p_c
 	return false
 
 
-func can_see_collider_aabb(p_aabb: AABB, p_exclusion_array: Array = [], p_collision_bits: int = 1) -> bool:
-	var dss = entity_node.PhysicsServer3D.space_get_direct_state(entity_node.get_world_3d().get_space())
+func can_see_collider_aabb(
+	p_aabb: AABB, p_exclusion_array: Array = [], p_collision_bits: int = 1
+) -> bool:
+	var dss = entity_node.PhysicsServer3D.space_get_direct_state(
+		entity_node.get_world_3d().get_space()
+	)
 	if dss:
 		camera_planes = camera_matrix.get_projection_planes(get_actor_eye_transform())
 
@@ -64,6 +72,8 @@ func can_see_collider_aabb(p_aabb: AABB, p_exclusion_array: Array = [], p_collis
 	return false
 
 
-func setup_camera_matrix(p_fovy_degrees: float, p_aspect: float, p_z_near: float, p_z_far: float, p_flip_fov: float) -> void:
+func setup_camera_matrix(
+	p_fovy_degrees: float, p_aspect: float, p_z_near: float, p_z_far: float, p_flip_fov: float
+) -> void:
 	camera_matrix = camera_matrix_const.new()
 	camera_matrix.set_perspective(p_fovy_degrees, p_aspect, p_z_near, p_z_far, p_flip_fov)

addons/actor/states/actor_state_falling.gd

@@ -17,8 +17,12 @@ func update(p_delta: float) -> void:
 		if state_machine.is_grounded():
 			change_state("Landed")
 
-		var gravity_delta: float = state_machine.get_actor_controller().get_gravity_speed() * p_delta
-		var gravity_direction: Vector3 = state_machine.get_actor_controller().get_gravity_direction()
+		var gravity_delta: float = (
+			state_machine.get_actor_controller().get_gravity_speed() * p_delta
+		)
+		var gravity_direction: Vector3 = (
+			state_machine.get_actor_controller().get_gravity_direction()
+		)
 
 		state_machine.set_velocity(state_machine.get_velocity() + gravity_direction * gravity_delta)
 		state_machine.set_movement_vector(state_machine.get_velocity())

addons/actor/states/actor_state_locomotion.gd

@@ -19,7 +19,13 @@ func locomotion() -> void:
 
 	var input_direction: Vector3 = state_machine.get_input_direction()
 
-	state_machine.set_velocity(input_direction * state_machine.actor_controller.walk_speed * state_machine.get_input_magnitude())
+	state_machine.set_velocity(
+		(
+			input_direction
+			* state_machine.actor_controller.walk_speed
+			* state_machine.get_input_magnitude()
+		)
+	)
 
 	if state_machine.is_attempting_jumping():
 		change_state("Pre-Jump")