geep: add new gear

`suspended' is now for suspending a player's movement input keys;
`protected' is for preventing a player's death except for special cases
such as when health goes below 1 or the player drops out of the world.

To kill a player without checking `protected', use _die().

gears/ball.gd

@@ -2,8 +2,6 @@ class_name Ball extends "gear.gd"
 
 func gear_name():
 	return "Ball"
-func gear_id():
-	return 1
 func continuous():
 	return false
 	

gears/gear.gd

@@ -1,43 +1,47 @@
 @icon("./gear.png")
 class_name Gear extends Node3D
 
-var idle_basis = Basis(
-	Vector3(1, 0, 0),
-	Vector3(0, 1, 0),
-	Vector3(0, 0, 1))
-var use_basis = Basis(
-	Vector3(1, 0, 0),
-	Vector3(0, 0, -1),
-	Vector3(0, 1, 0))
-var pickup_basis = idle_basis
-
 func gear_name():
 	return "Gear"
-func gear_id():
-	return 0
 func model_file():
 	return "hammer.glb"
 func continuous():
 	return false
+func idle_basis():
+	return Basis(
+		Vector3(1, 0, 0),
+		Vector3(0, 1, 0),
+		Vector3(0, 0, 1))
+func use_basis():
+	return Basis(
+		Vector3(1, 0, 0),
+		Vector3(0, 0, -1),
+		Vector3(0, 1, 0))
+func pickup_basis():
+	return idle_basis()
 
-# this can be redefined to make a custom
-# gear mesh, e.g. a SphereMesh
 func use(player):
-	basis = use_basis
+	basis = use_basis()
 	$Timer.start()
 	on_use(player)
 
+func unequip(player):
+	on_unequip(player)
+
 func on_use(_player):
 	pass
 
+func on_unequip(_player):
+	pass
+
 func on_ready():
 	pass
 
 func _on_timer_timeout():
-	basis = idle_basis
+	basis = idle_basis()
 
 func _ready():
-	basis = idle_basis
+	basis = idle_basis()
 	if get_parent() is GearPickup:
-		basis = pickup_basis
+		basis = pickup_basis()
 	on_ready()

gears/geep.gd

@@ -0,0 +1,62 @@
+class_name Geep extends "gear.gd"
+
+func gear_name():
+	return "Geep"
+func continuous():
+	return false
+func use_basis():
+	return idle_basis()
+
+# multiplier of player's speed
+const speed = 2
+# how far the vehicle lifts the player off the ground
+const lift = 2
+
+var box = null
+var driver = null
+var active = false
+
+func init_driver(player):
+	driver = player
+	if not box:
+		box = Vector3(driver.get_node("CollisionShape3D").shape.size)
+
+func mount():
+	active = true
+	position = Vector3(-driver.get_node("Pivot/Container").position)
+	position.y += 1
+	driver.message(
+		"Press [%s] to exit the Geep"
+		% Util.input_action_string("gear_use"))
+	driver.get_node("CameraGimbal").position.y += lift
+	driver.get_node("Pivot/Mesh").position.y += lift
+	driver.get_node("CollisionShape3D").shape.size = $GearMesh/Vehicle/CollisionShape3D.shape.size
+	driver.protected = true
+	driver.suspended = true
+
+func unmount():
+	active = false
+	position = Vector3.ZERO
+	driver.message("")
+	driver.get_node("CameraGimbal").position = Vector3.ZERO
+	driver.get_node("Pivot/Mesh").position = Vector3.ZERO
+	driver.get_node("CollisionShape3D").shape.size = box
+	driver.protected = false
+	driver.suspended = false
+
+func on_use(player):
+	init_driver(player)
+	if active:
+		unmount()
+	else:
+		mount()
+
+func on_unequip(player):
+	init_driver(player)
+	unmount()
+
+func _physics_process(_delta):
+	if not active:
+		return
+
+	driver.move_player(0, -speed)

gears/geep.tscn

@@ -0,0 +1,87 @@
+[gd_scene load_steps=10 format=3 uid="uid://d3k7b6o56ue5k"]
+
+[ext_resource type="Script" uid="uid://fljad0m3jlt0" path="res://gears/geep.gd" id="1_8skgp"]
+[ext_resource type="Material" uid="uid://dpacu3e7vsks5" path="res://gears/geep_body.tres" id="2_rhiad"]
+[ext_resource type="Material" uid="uid://bt5aat64e478k" path="res://gears/geep_wheel.tres" id="3_lrfuo"]
+
+[sub_resource type="BoxShape3D" id="BoxShape3D_lrfuo"]
+size = Vector3(3, 3, 6)
+
+[sub_resource type="BoxMesh" id="BoxMesh_rhiad"]
+material = ExtResource("2_rhiad")
+size = Vector3(3, 0.5, 6)
+
+[sub_resource type="BoxMesh" id="BoxMesh_kyikt"]
+material = ExtResource("2_rhiad")
+size = Vector3(0.5, 1.75, 6)
+
+[sub_resource type="BoxMesh" id="BoxMesh_wm067"]
+material = ExtResource("2_rhiad")
+size = Vector3(3, 2, 2.5)
+
+[sub_resource type="BoxMesh" id="BoxMesh_lrfuo"]
+material = ExtResource("2_rhiad")
+size = Vector3(3, 2, 0.5)
+
+[sub_resource type="CylinderMesh" id="CylinderMesh_lrfuo"]
+material = ExtResource("3_lrfuo")
+top_radius = 1.0
+bottom_radius = 1.0
+height = 0.25
+
+[node name="Gear" type="Node3D"]
+rotation_edit_mode = 2
+script = ExtResource("1_8skgp")
+
+[node name="Timer" type="Timer" parent="."]
+one_shot = true
+
+[node name="GearMesh" type="Node3D" parent="."]
+
+[node name="Vehicle" type="StaticBody3D" parent="GearMesh"]
+transform = Transform3D(1, 0, 0, 0, 1.0000001, 0, 0, 0, 1.0000001, 0, 0, 0)
+collision_layer = 4
+
+[node name="CollisionShape3D" type="CollisionShape3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1.5, 0)
+shape = SubResource("BoxShape3D_lrfuo")
+
+[node name="BaseMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0.9997004, 0)
+mesh = SubResource("BoxMesh_rhiad")
+
+[node name="LeftSideMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(1, 0, 0, 0, 0.9999999, 0, 0, 0, 0.9999999, -1.25, 2.1247003, 0)
+mesh = SubResource("BoxMesh_kyikt")
+skeleton = NodePath("")
+
+[node name="RightSideMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(1, 0, 0, 0, 0.9999999, 0, 0, 0, 0.9999999, 1.25, 2.1247003, 0)
+mesh = SubResource("BoxMesh_kyikt")
+skeleton = NodePath("")
+
+[node name="BonnetMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1.9997005, -1.75)
+mesh = SubResource("BoxMesh_wm067")
+
+[node name="TailgateMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1.9997005, 2.75)
+mesh = SubResource("BoxMesh_lrfuo")
+
+[node name="WheelFLMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(-4.371139e-08, -1, 0, 1, -4.371139e-08, 0, 0, 0, 1, 1.65, 1, 2)
+mesh = SubResource("CylinderMesh_lrfuo")
+
+[node name="WheelFRMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(-4.371139e-08, -1, 0, 1, -4.371139e-08, 0, 0, 0, 1, -1.65, 1, 2)
+mesh = SubResource("CylinderMesh_lrfuo")
+
+[node name="WheelBLMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(-4.371139e-08, -1, 0, 1, -4.371139e-08, 0, 0, 0, 1, 1.65, 1, -2)
+mesh = SubResource("CylinderMesh_lrfuo")
+
+[node name="WheelBRMesh" type="MeshInstance3D" parent="GearMesh/Vehicle"]
+transform = Transform3D(-4.371139e-08, -1, 0, 1, -4.371139e-08, 0, 0, 0, 1, -1.65, 1, -2)
+mesh = SubResource("CylinderMesh_lrfuo")
+
+[connection signal="timeout" from="Timer" to="." method="_on_timer_timeout"]

gears/geep_body.tres

@@ -0,0 +1,4 @@
+[gd_resource type="StandardMaterial3D" load_steps=0 format=3 uid="uid://dpacu3e7vsks5"]
+
+[resource]
+albedo_color = Color(0.99607843, 0.99607843, 0.99607843, 1)

gears/geep_wheel.tres

@@ -0,0 +1,4 @@
+[gd_resource type="StandardMaterial3D" load_steps=0 format=3 uid="uid://bt5aat64e478k"]
+
+[resource]
+albedo_color = Color(0.1254902, 0.1254902, 0.1254902, 1)

main.tscn

@@ -42,6 +42,7 @@ glow_hdr_luminance_cap = 0.0
 [node name="Main" type="Node3D"]
 
 [node name="Player" parent="." instance=ExtResource("1_ig7tw")]
+transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 2, 0)
 
 [node name="Baseplate" type="StaticBody3D" parent="."]
 

player/player.gd

@@ -8,8 +8,10 @@ const gear_slots = ["1", "2", "3"]
 
 @onready var spawn = Vector3(position)
 
-var starting_gear = preload("res://gears/ball.tscn")
+var starting_gear = preload("res://gears/gear.tscn")
 
+var dead = false
+var protected = false
 var suspended = false
 var direction = Vector3.ZERO
 var target_velocity = Vector3.ZERO
@@ -45,6 +47,8 @@ func message(string):
 # State functions
 
 func harm(hp):
+	if protected:
+		return
 	assert(hp >= 0)
 	_health -= hp
 	make_hud()
@@ -57,7 +61,8 @@ func heal(hp):
 func health():
 	return _health
 
-func die():
+func _die():
+	dead = true
 	suspended = true
 	visible = false
 	$HUD.visible = false
@@ -65,17 +70,24 @@ func die():
 	# strip gears
 	for gear in $Backpack.get_children():
 		gear.queue_free()
+	if has_node("Pivot/Container/Gear"):
+		$Pivot/Container/Gear.unequip(self)
 		$Pivot/Container/Gear.queue_free()
 
 	$RespawnTimer.start()
 	message("Le gone")
 
+func die():
+	if protected:
+		return
+	_die()
+
 func respawn():
 	position = Vector3(spawn)
 	$CameraGimbal.reset()
 	_health = 100
 	visible = true
-	suspended = false
+	dead = false
 
 	# add starting gear
 	var gear = starting_gear.instantiate()
@@ -103,6 +115,7 @@ func use_backpack_slot(n):
 	# place current gear in first free slot
 	var slot = find_free_slot()
 	if slot:
+		old.unequip(self)
 		old.name = slot
 		old.reparent($Backpack, false)
 		get_node(gear_node).reparent($Pivot/Container, false)
@@ -112,6 +125,7 @@ func use_backpack_slot(n):
 	# couldn't find a free slot, so replace
 	# the new slot with the current gear
 	get_node(gear_node).reparent($Pivot/Container, false)
+	old.unequip(self)
 	old.reparent($Backpack, false)
 	old.name = n
 	get_node("Pivot/Container/" + n).name = "Gear"
@@ -119,6 +133,8 @@ func use_backpack_slot(n):
 	return
 
 func equip(gear: Gear):
+	if suspended:
+		return
 	var gear_name = gear.gear_name()
 	# do we have the gear equipped?
 	if gear_name == $Pivot/Container/Gear.gear_name():
@@ -135,6 +151,7 @@ func equip(gear: Gear):
 	# place current gear in first free slot
 	var slot = find_free_slot()
 	if slot:
+		old.unequip(self)
 		old.name = slot
 		old.reparent($Backpack, false)
 		new_gear = gear.duplicate()
@@ -180,6 +197,7 @@ func do_movement(delta):
 	var mx = 0
 	var mz = 0
 
+	if not suspended:
 		if Input.is_action_pressed("move_forward"):
 			mz -= 1
 		if Input.is_action_pressed("move_back"):
@@ -222,12 +240,12 @@ func _ready():
 	respawn()
 
 func _physics_process(delta):
-	if health() < 1 or position.y <= -1000:
+	if dead:
-		die()
-
-	if suspended:
 		return
 
+	if health() < 1 or position.y <= -1000:
+		_die()
+
 	# Backpack keys
 	do_backpack_keys()
 	# Movement

player/player.tscn

@@ -58,7 +58,9 @@ shape = SubResource("BoxShape3D_onrkg")
 
 [node name="Pivot" type="Node3D" parent="."]
 
-[node name="PlayerMesh" type="MeshInstance3D" parent="Pivot"]
+[node name="Mesh" type="Node3D" parent="Pivot"]
+
+[node name="MeshInstance3D" type="MeshInstance3D" parent="Pivot/Mesh"]
 transform = Transform3D(1, 0, 0, 0, -4.371139e-08, 1, 0, -1, -4.371139e-08, 0, -100, 0)
 mesh = SubResource("ArrayMesh_sweqy")
 skeleton = NodePath("")

util/util.gd

@@ -0,0 +1,4 @@
+class_name Util extends Node
+
+static func input_action_string(action):
+	return InputMap.action_get_events(action)[0].as_text()