New: CogitoSnapSlot (WIP)

CogitoSnapSlot (WIP):
- This is a 3d object that represents a spot for another object to "snap" into place.
- Examples of it's first implementation can be found in the Laboratory demo scene in the systemic properties room, using the metal bar and a battery.
- Still needs more testing and tweaking of signals, save/load, etc.

COGITO/CogitoObjects/cogito_object.gd

@@ -3,6 +3,9 @@ extends Node3D
 class_name CogitoObject
 
 signal damage_received(damage_value:float)
+signal object_exits_tree()
+
+@export var cogito_name : String = self.name
 
 var interaction_nodes : Array[Node]
 var cogito_properties : CogitoProperties = null
@@ -31,7 +34,6 @@ func find_cogito_properties():
 	var property_nodes = find_children("","CogitoProperties",true) #Grabs all attached property components
 	if property_nodes:
 		cogito_properties = property_nodes[0]
-		#print(name, ": cogito_properties set to ", cogito_properties)
 
 
 # Function to handle persistence and saving
@@ -63,3 +65,7 @@ func _on_body_exited(body: Node) -> void:
 	# Using this check to only call interactions on other Cogito Objects. #TODO: could be a better check...
 	if body.has_method("save") and cogito_properties:
 		cogito_properties.check_for_reaction_timer_interrupt(body)
+
+
+func _exit_tree() -> void:
+	object_exits_tree.emit()

COGITO/CogitoObjects/cogito_snap_slot.gd

@@ -0,0 +1,206 @@
+@tool
+extends Node3D
+class_name CogitoSnapSlot
+
+signal object_placed
+signal object_removed
+signal object_state_updated(interaction_text:String)
+
+
+@onready var snap_area_3d: Area3D = $SnapArea3D
+@onready var snap_shape: Node3D = $SnapShape
+@onready var snap_position: Node3D = $SnapPosition
+
+enum SnapSlotType {
+  CARRYABLE,
+  ITEM,
+}
+
+@export var snap_slot_type := SnapSlotType.CARRYABLE:
+	set(value):
+		snap_slot_type = value
+		notify_property_list_changed()
+
+
+func _validate_property(property: Dictionary):
+	if property.name in ["expected_item", interaction_text_to_place] and snap_slot_type != SnapSlotType.ITEM:
+		property.usage = PROPERTY_USAGE_NO_EDITOR
+	elif property.name in ["expected_object"] and snap_slot_type != SnapSlotType.CARRYABLE:
+		property.usage = PROPERTY_USAGE_NO_EDITOR
+
+
+## PackedScene of the carryable object that this snapslot is expecting.
+@export var expected_object : PackedScene
+## Item resource  of the object that this snapslot is expecting.
+@export var expected_item : InventoryItemPD
+
+
+@export_group("Audio")
+## Plays when object is snapped into place.
+@export var object_placement_sound : AudioStream
+## Plays when object is removed from the slot.
+@export var object_removed_sound : AudioStream
+## Audio that is played continuiosly while object is placed.
+@export var active_sound_loop : AudioStream
+
+@export_group("Interaction Settings")
+## Is active or not. You might want to only activate this slot when another condition is met. Also used to deactivate after object is placed.
+@export var is_active : bool = true
+## Text that appears on the interaction prompt when an inventory item is expected.
+@export var interaction_text_to_place : String = "Place"
+## Text that appears on the interaction prompt when an object is placed that can be removed.
+@export var interaction_text_to_remove : String = "Remove"
+
+## Hint that is displayed if the player interacts while the snapslot is empty.
+@export var expected_object_hint : String = "Looks like an object could fit here."
+
+var instanced_expected_object
+var preloaded_expected_item
+var spawned_object = null
+var interaction_text = null
+var interaction_nodes : Array[Node]
+var cogito_properties : CogitoProperties = null
+var player_interaction_component : PlayerInteractionComponent
+
+var is_holding_object : bool:
+	set(value):
+		is_holding_object = value
+
+		if snap_shape:
+			snap_shape.visible = !is_holding_object
+
+		if is_holding_object:
+			object_placed.emit()
+			interaction_text = interaction_text_to_remove
+		else:
+			object_removed.emit()
+			interaction_text = interaction_text_to_place
+
+		object_state_updated.emit(interaction_text)
+
+
+func _ready() -> void:
+	set_state()
+
+	if expected_object:
+		instanced_expected_object = load(expected_object.resource_path).instantiate()
+		print("Cogito_snap_slot: expected object cogito_name=", instanced_expected_object.cogito_name)
+
+
+func interact(interactor: Node3D):
+	player_interaction_component = interactor
+
+	if snap_slot_type == SnapSlotType.ITEM:
+		if !is_holding_object:
+			check_for_item(player_interaction_component)
+
+
+func check_for_item(interactor: PlayerInteractionComponent):
+	var inventory = interactor.get_parent().inventory_data
+	for slot_data in inventory.inventory_slots:
+		if slot_data != null and slot_data.inventory_item == expected_item:
+			interactor.send_hint(null, expected_item.name + " placed.") # Sends a hint with the expected item name.
+			inventory.remove_item_from_stack(slot_data)
+			place_item()
+			return
+
+	if expected_object_hint != "":
+		interactor.send_hint(null,expected_object_hint) # Sends the hint with the default hint icon.
+
+
+func place_item():
+	#TODO PLACE ITEM LOGIC GOES HERE
+	Audio.play_sound_3d(object_placement_sound).global_position = self.global_position
+	spawned_object = preloaded_expected_item.instantiate()
+
+	is_holding_object = true
+
+	get_tree().current_scene.add_child(spawned_object)
+	if spawned_object.is_class("RigidBody3D"):
+		spawned_object.set_freeze_mode(0)
+		spawned_object.freeze = true
+	spawned_object.global_transform = snap_position.global_transform
+	spawned_object.object_exits_tree.connect(remove_object)
+
+
+func place_carryable(world_carryable: Node3D):
+	if !world_carryable:
+		return
+	if !world_carryable.is_class("RigidBody3D"):
+		print("Cogito_snap_slot: place_carryable(): body wasn't a RigidBody3D.")
+		return
+
+	Audio.play_sound_3d(object_placement_sound).global_position = self.global_position
+	if player_interaction_component and player_interaction_component.carried_object:
+		player_interaction_component.carried_object.leave()
+	is_holding_object = true
+	world_carryable.set_freeze_mode(0)
+	world_carryable.freeze = true
+	world_carryable.global_transform = snap_position.global_transform
+
+
+func remove_object():
+	Audio.play_sound_3d(object_removed_sound).global_position = self.global_position
+	is_holding_object = false
+	if spawned_object:
+		spawned_object = null
+
+
+func _on_body_entered_snap_area(body : Node3D):
+	if !expected_object:
+		return
+
+	if !player_interaction_component:
+		player_interaction_component = CogitoSceneManager._current_player_node.player_interaction_component
+
+	print("Cogito_snap_slot: _on_body_entered = ", body)
+	if body is CogitoObject:
+		print("Cogito_snap_slot: body is CogitoObject with cogito_name=", body.cogito_name)
+		if instanced_expected_object.cogito_name == body.cogito_name:
+			print("Cogito_snap_slot: Expected object detected: ", body.cogito_name)
+			place_carryable(body)
+	pass
+
+
+func _on_body_exited_snap_area(body: Node3D):
+	if !expected_object:
+		return
+	print("Cogito_snap_slot: _on_body_exited = ", body)
+	if body is CogitoObject and instanced_expected_object.cogito_name == body.cogito_name:
+		remove_object()
+
+
+func set_state():
+	add_to_group("interactable")
+	add_to_group("save_object_state")
+
+	if snap_slot_type == SnapSlotType.CARRYABLE:
+		if !snap_area_3d.body_entered.is_connected(_on_body_entered_snap_area):
+			snap_area_3d.body_entered.connect(_on_body_entered_snap_area)
+		if !snap_area_3d.body_exited.is_connected(_on_body_exited_snap_area):
+			snap_area_3d.body_exited.connect(_on_body_exited_snap_area)
+
+	if snap_slot_type == SnapSlotType.ITEM:
+		preloaded_expected_item = load(expected_item.drop_scene)
+
+	if snap_shape:
+		snap_shape.visible = is_active
+
+	interaction_text = interaction_text_to_place
+	object_state_updated.emit(interaction_text)
+	interaction_nodes = find_children("","InteractionComponent",true) #Grabs all attached interaction components
+
+
+func save():
+	var state_dict = {
+		"node_path" : self.get_path(),
+		"is_active" : is_active,
+		"pos_x" : position.x,
+		"pos_y" : position.y,
+		"pos_z" : position.z,
+		"rot_x" : rotation.x,
+		"rot_y" : rotation.y,
+		"rot_z" : rotation.z,
+
+	}
+	return state_dict

COGITO/CogitoObjects/cogito_static_interactable.gd

@@ -6,29 +6,37 @@ signal damage_received(damage_value:float)
 
 var interaction_nodes : Array[Node]
 var cogito_properties : CogitoProperties = null
+var properties : int
 
 func _ready():
 	self.add_to_group("interactable")
 	find_interaction_nodes()
+	find_cogito_properties()
 
 func find_interaction_nodes():
 	interaction_nodes = find_children("","InteractionComponent",true) #Grabs all attached interaction components
 
-#
-## Function to handle persistence and saving
-#func save():
-	#var node_data = {
-		#"filename" : get_scene_file_path(),
-		#"parent" : get_parent().get_path(),
-		##"slot_data" : slot_data,
-		##"item_charge" : slot_data.inventory_item.charge_current,
-		#"interaction_nodes" : interaction_nodes,
-		#"pos_x" : position.x,
-		#"pos_y" : position.y,
-		#"pos_z" : position.z,
-		#"rot_x" : rotation.x,
-		#"rot_y" : rotation.y,
-		#"rot_z" : rotation.z,
-		#
-	#}
-	#return node_data
+
+func find_cogito_properties():
+	var property_nodes = find_children("","CogitoProperties",true) #Grabs all attached property components
+	if property_nodes:
+		cogito_properties = property_nodes[0]
+
+
+# Future method to set object state when a scene state file is loaded.
+func set_state():	
+	#TODO: Find a way to possibly save health of health attribute.
+	find_cogito_properties()
+	pass
+
+
+func _on_body_entered(body: Node) -> void:
+	# Using this check to only call interactions on other Cogito Objects. #TODO: could be a better check...
+	if body.has_method("save") and cogito_properties:
+		cogito_properties.start_reaction_threshold_timer(body)
+
+
+func _on_body_exited(body: Node) -> void:
+	# Using this check to only call interactions on other Cogito Objects. #TODO: could be a better check...
+	if body.has_method("save") and cogito_properties:
+		cogito_properties.check_for_reaction_timer_interrupt(body)

COGITO/Components/Interactions/CarryableComponent.gd

@@ -74,6 +74,7 @@ func _exit_tree():
 func hold():
 	if lock_rotation_when_carried:
 		parent_object.set_lock_rotation_enabled(true)
+	parent_object.freeze = false
 	player_interaction_component.start_carrying(self)
 	player_interaction_component.interaction_raycast.add_exception(parent_object)