Refactor camera so it can be included in the Player scene

I changed the README accordingly

Author: NathanLovato

Game.tscn

@@ -1,6 +1,5 @@
-[gd_scene load_steps=11 format=2]
+[gd_scene load_steps=10 format=2]
 
-[ext_resource path="res://src/Camera/Camera.tscn" type="PackedScene" id=1]
 [ext_resource path="res://src/Player/Player.tscn" type="PackedScene" id=2]
 
 [sub_resource type="SpatialMaterial" id=1]
@@ -32,7 +31,6 @@ points = PoolVector3Array( -1, 1, 1, 1, 1, -1, 1, 1, 1, -1, 1, -1, -1, -1, 1, 1,
 [node name="TestMap" type="Spatial" parent="."]
 
 [node name="Ground" type="MeshInstance" parent="TestMap"]
-editor/display_folded = true
 mesh = SubResource( 2 )
 material/0 = null
 
@@ -42,10 +40,8 @@ material/0 = null
 shape = SubResource( 3 )
 
 [node name="Obstacles" type="Spatial" parent="TestMap"]
-editor/display_folded = true
 
 [node name="MeshInstance" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -7, 0, -8 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -56,7 +52,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance4" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 9, 0, -9 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -67,7 +62,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance5" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -2, 0, -2 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -78,7 +72,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance6" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -6, 1, -2 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -89,7 +82,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance7" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -6, 1, -4 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -100,7 +92,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance8" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -6, 2, -6 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -111,7 +102,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance9" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -6, 3.99933, -6 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -122,7 +112,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance10" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -6, 11.8311, -6 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -133,7 +122,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance11" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 3.9415, 8.03339, -6 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -144,7 +132,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 6 )
 
 [node name="MeshInstance2" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, -4, 1, -2 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -155,7 +142,6 @@ material/0 = SubResource( 5 )
 shape = SubResource( 7 )
 
 [node name="MeshInstance3" type="MeshInstance" parent="TestMap/Obstacles"]
-editor/display_folded = true
 transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 9, 1, -11 )
 mesh = SubResource( 4 )
 material/0 = SubResource( 5 )
@@ -169,7 +155,4 @@ shape = SubResource( 8 )
 transform = Transform( 0.766044, 0.166366, -0.620885, 0.271654, 0.791635, 0.547283, 0.582563, -0.587909, 0.561234, 0, 12, 0 )
 shadow_enabled = true
 
-[node name="CameraAnchor" parent="." instance=ExtResource( 1 )]
-transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1.6, 0 )
-
 [node name="Player" parent="." instance=ExtResource( 2 )]

README.md

@@ -1,64 +1,72 @@
-- [Credits](#credits)
-- [Quick Start Usage](#quick-start-usage)
-- [Inner Workings](#inner-workings)
-	- [Player](#player)
-	- [Camera](#camera)
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
+**Table of Contents**
+
+- [Quick Start Guide](#quick-start-guide)
+    - [Controls](#controls)
+- [How it works](#how-it-works)
+    - [Player](#player)
+    - [Camera](#camera)
 - [Configuration](#configuration)
 - [Customization](#customization)
+- [Credits](#credits)
 - [Support our work](#support-our-work)
 
+<!-- markdown-toc end -->
+
 An Open Source 3d character and character controller for the Godot game engine.
 
 ![The mannequin in-game](./assets/screenshots/prototype-1.png)
 
 This is a third person character controller designed to work both with the keyboard and a gamepad. It features a camera that can auto-rotate or that can be controlled with a joystick.
 
-## Credits
-
-1. The Godot mannequin is a character made by [Luciano Muñoz](https://twitter.com/lucianomunoz_) In blender 2.80.
-1. Godot code by Josh aka [Cheeseness](https://twitter.com/ValiantCheese)
-1. Additional code by Francois Belair aka [Razoric480](https://twitter.com/Razoric480)
+# Quick Start Guide #
 
-## Quick Start Usage
+The 3D Third Person Character Controller is made of two scenes:
 
-The 3D Third Person Character Controller is composed of two scenes:
+* `Camera.tscn` - A 3D camera rig with a state machine for aiming
+* `Player.tscn` - A `KinematicBody` with a state machine for player movement. Contains an instance of `Camera`. It also includes the animated 3D mannequin.
 
-* Camera.tscn - Holds a 3D camera rig with a state machine for aiming
-* Player.tscn - Holds the player's kinematic body and state machine for movement and functions, and holds the player's animation rig.
+To use the default character, instance `Player` in your game. See `Game.tscn` for an example. In this demo, the obstacles are mesh instances with static body collisions making up a cube world.
 
-The procedure to use the controller as-is, then, is to add both the Camera and Player scenes as instanced children to your 3D scene.
+## Controls ##
 
-See `Game.tscn` for a simple example - the obstacles are mesh instances with static body collisions making up a cube world, and has the Camera and Player as instanced children. The camera, additionally, has been moved up to head level.
+The game supports both mouse and keyboard, and the gamepad.
 
-In short, the Player scene holds the 3D model and its animations, and the movement logic of the game character. What constitutes as 'forwards' is based on the Camera scene's orientation.
+# How it works #
 
-## Inner Workings
+## Player ##
 
-### Player
+The scene that deals with the movement, collision, and logic of the player. The player is a KinematicBody with a capsule collision shape, and the movement logic is within a [Finite State Machine](http://gameprogrammingpatterns.com/state.html).
 
-The scene that deals with the movement, collision, and logic of the player. The player is a KinematicBody with a capsule collision shape, and the movement logic is within a Finite State Machine.
+The scene also holds an instance of the `PlayerMesh` for animation purposes. This scene lives in the `PlayerMesh.tscn` scene. It holds the skeletal rig for the mesh's animation, the 3D model of the body and head sepearately, and the animation tree and player to control the animation workflow of the model. The lot is wrapped up in a spatial node with some logic to transition to which animation based on which state the player is in.
 
-The scene also holds an instance of the PlayerMesh for animation purposes. This scene lives in the `PlayerMesh.tscn` scene. It holds the skeletal rig for the mesh's animation, the 3D model of the body and head sepearately, and the animation tree and player to actually control the animation workflow of the model. The lot is wrapped up in a spatial node with some logic to transition to which animation based on which state the player is in.
+## Camera ##
 
-### Camera
+The scene that deals with the Camera movement. It follows the Player in the game, but in code it moves and rotates separately from it. It has a `SpringArm` node to help with preventing collision with level geometry - moving the viewpoint forwards to prevent moving the camera inside geometry. It also has a system that holds the raycast for aiming-mode, and the 3D sprite that is a projected reticule. The logic is held in a finite state machine.
 
-The scene that deals with the Camera movement. It is separate from the player, though keeps track of it and follows it. It has a SpringArm node to help with preventing collision with level geometry - moving the viewpoint forwards to prevent moving the camera inside geometry. It also has a system that holds the raycast for aiming-mode, and the 3D sprite that is a projected reticule. The logic is held in a finite state machine.
+# Configuration #
 
-## Configuration
+To change the player and the camera's behavior, you need to change properties on the corresponding states in their state machine.
 
-Most of the configuration available for player movement are located on the Move state in the Player scene - the player speed and the rotational speed.
+Most of the configuration available for player movement are located on the `Move` state in the Player scene - the player speed and the rotational speed.
 
 The Camera has more options. On the main Camera state in the Camera scene are items like the default field of view, whether Y is inverted, and sensitivity.
 
 In addition, the Aim state allows some finer-tuned changes, like whether the aiming camera is first or third person, and by how much it should be offset over-the-shoulder of the character.
 
-## Customization
+# Customization #
 
 While the scenes can be modified extensively with new nodes and raw code, the state machine model allow for some simple, new functionality with relative ease.
 
 As an example, there is the `Extensions` folder which contains additional player states for using the aiming view to fire a hookshot that pulls you towards the reticle. Once those states have been added to the Player's `Move` state, you only need to replace the `pass` in Move's `enter` with code like `owner.camera.connect("aim_fired", self, "on_Camera_aim_fired")` and Move's `exit` with code like `owner.camera.disconnect("aim_fired", self, "on_Camera_aim_fired")`
 
-## Support our work
+# Credits #
+
+1. The Godot mannequin is a character made by [Luciano Muñoz](https://twitter.com/lucianomunoz_) In blender 2.80.
+1. Godot code by Josh aka [Cheeseness](https://twitter.com/ValiantCheese)
+1. Additional code by Francois Belair aka [Razoric480](https://twitter.com/Razoric480)
+
+# Support our work #
 
 This free series is sponsored by our [platformer game creation course](https://gdquest.mavenseed.com).
 

src/Camera/Camera.gd

@@ -1,3 +1,4 @@
+tool
 extends Spatial
 """
 Simple accessor class to let the nodes in the Camera scene access the player
@@ -10,9 +11,14 @@ signal aim_fired(target_vector)
 onready var camera_state: State = $StateMachine/Camera
 onready var aim_ray: RayCast = get_node("AimRay")
 
-var player: Player
+var player: KinematicBody
 
 
 func _ready() -> void:
-	player = get_tree().root.find_node("Player", true, false)
-	assert(player)
+	set_as_toplevel(true)
+	yield(owner, "ready")
+	player = owner
+
+
+func _get_configuration_warning() -> String:
+	return "Missing player node" if not player else ""

src/Camera/Camera.tscn

@@ -7,7 +7,7 @@
 [ext_resource path="res://src/Camera/CameraStates/CameraDefault.gd" type="Script" id=5]
 [ext_resource path="res://src/Camera/CameraStates/Aim.gd" type="Script" id=6]
 
-[node name="CameraAnchor" type="Spatial"]
+[node name="Camera" type="Spatial"]
 script = ExtResource( 1 )
 
 [node name="SpringArm" type="SpringArm" parent="."]
@@ -29,7 +29,7 @@ texture = ExtResource( 2 )
 
 [node name="StateMachine" type="Node" parent="."]
 script = ExtResource( 3 )
-initial_state = NodePath("../../CameraAnchor/StateMachine/Camera/Default")
+initial_state = NodePath("Camera/Default")
 
 [node name="Camera" type="Node" parent="StateMachine"]
 script = ExtResource( 4 )

src/Camera/CameraStates/Camera.gd

@@ -141,4 +141,4 @@ static func get_move_direction() -> Vector3:
 			Input.get_action_strength("move_right") - Input.get_action_strength("move_left"),
 			0,
 			Input.get_action_strength("move_back") - Input.get_action_strength("move_front")
-		)
+		)

src/Player/Player.gd

@@ -1,3 +1,4 @@
+tool
 extends KinematicBody
 class_name Player
 """
@@ -6,9 +7,8 @@ camera and its orientation.
 """
 
 
-var camera: Spatial
+onready var camera: Spatial = $Camera
 
 
-func _ready() -> void:
-	camera = get_tree().root.find_node("CameraAnchor", true, false)
-	assert(camera)
+func _get_configuration_warning() -> String:
+	return "Missing camera node" if not camera else ""

src/Player/Player.tscn

@@ -1,4 +1,4 @@
-[gd_scene load_steps=9 format=2]
+[gd_scene load_steps=10 format=2]
 
 [ext_resource path="res://src/Player/Player.gd" type="Script" id=1]
 [ext_resource path="res://src/Player/PlayerMesh.tscn" type="PackedScene" id=2]
@@ -7,6 +7,7 @@
 [ext_resource path="res://src/Player/MoveStates/Idle.gd" type="Script" id=5]
 [ext_resource path="res://src/Player/MoveStates/Air.gd" type="Script" id=6]
 [ext_resource path="res://src/Player/MoveStates/Run.gd" type="Script" id=7]
+[ext_resource path="res://src/Camera/Camera.tscn" type="PackedScene" id=8]
 
 [sub_resource type="CapsuleShape" id=1]
 radius = 0.25
@@ -16,10 +17,10 @@ height = 1.5239
 script = ExtResource( 1 )
 
 [node name="PlayerMesh" parent="." instance=ExtResource( 2 )]
-transform = Transform( -1, 0, -1.50996e-007, 0, 1, 0, 1.50996e-007, 0, -1, 0, 0, 0 )
+transform = Transform( -1, 0, -1.50996e-07, 0, 1, 0, 1.50996e-07, 0, -1, 0, 0, 0 )
 
 [node name="CollisionShape" type="CollisionShape" parent="."]
-transform = Transform( 1, 0, 0, 0, -4.37114e-008, -1, 0, 1, -4.37114e-008, 0, 1, 0 )
+transform = Transform( 1, 0, 0, 0, -4.37114e-08, -1, 0, 1, -4.37114e-08, 0, 1, 0 )
 shape = SubResource( 1 )
 
 [node name="StateMachine" type="Node" parent="."]
@@ -41,4 +42,7 @@ script = ExtResource( 6 )
 
 [node name="Run" type="Node" parent="StateMachine/Move"]
 script = ExtResource( 7 )
+
+[node name="Camera" parent="." instance=ExtResource( 8 )]
+transform = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1.38644, 0 )
 [connection signal="transitioned" from="StateMachine" to="PlayerMesh" method="_on_StateMachine_transitioned"]