Merge pull request #204 from peter-kish/dev_v2.4.8

GLoot 2.4.8

Author: peter-kish

addons/gloot/plugin.cfg

@@ -3,5 +3,5 @@
 name="GLoot"
 description="A universal inventory system for the Godot game engine"
 author="Peter Kish"
-version="2.4.7"
+version="2.4.8"
 script="gloot.gd"

addons/gloot/ui/ctrl_dragable.gd

@@ -23,60 +23,11 @@ static var dragable_dropped: Signal = (func():
 
 signal grabbed(position)
 signal dropped(zone, position)
-signal clicked
-
-# Embedded Windows are placed on layer 1024. CanvasItems on layers 1025 and higher appear in front of embedded windows.
-# (https://docs.godotengine.org/en/stable/classes/class_canvaslayer.html#description)
-const EMBEDDED_WINDOWS_LAYER = 1024
 
 static var _grabbed_dragable: CtrlDragable = null
 static var _grab_offset: Vector2
 
-var drag_preview: Control
-var _preview_canvas_layer := CanvasLayer.new()
-var drag_z_index := 1
-var enabled: bool = true
-var _show_queued := false
-var _clicked := false
-var _click_position := Vector2.ZERO
-
-
-static func grab(dragable: CtrlDragable) -> void:
-    _grabbed_dragable = dragable
-    _grab_offset = dragable.get_grab_position()
-
-    dragable.mouse_filter = Control.MOUSE_FILTER_IGNORE
-    dragable.grabbed.emit(_grab_offset)
-    dragable_grabbed.emit(dragable, _grab_offset)
-    dragable.drag_start()
-
-
-static func release() -> void:
-    _drop(null)
-
-
-static func release_on(zone: CtrlDropZone) -> void:
-    _drop(zone)
-
-
-static func _drop(zone: CtrlDropZone) -> void:
-    var grabbed_dragable := _grabbed_dragable
-    grabbed_dragable.mouse_filter = Control.MOUSE_FILTER_PASS
-    var local_drop_position := Vector2.ZERO
-    if zone != null:
-        local_drop_position = zone.get_drop_position()
-    else:
-        local_drop_position = _grabbed_dragable.get_drop_position()
-
-    _grabbed_dragable = null
-    _grab_offset = Vector2.ZERO
-    grabbed_dragable.drag_end()
-    grabbed_dragable.dropped.emit(zone, local_drop_position)
-    dragable_dropped.emit(grabbed_dragable, zone, local_drop_position)
-
-
-func get_drop_position() -> Vector2:
-    return get_local_mouse_position() - (get_grab_offset() / get_global_transform().get_scale())
+var _enabled: bool = true
 
 
 static func get_grabbed_dragable() -> CtrlDragable:
@@ -87,91 +38,41 @@ static func get_grab_offset() -> Vector2:
     return _grab_offset
 
 
-func get_grab_position() -> Vector2:
-    return get_local_mouse_position() * get_global_transform().get_scale()
-
-
-func drag_start() -> void:
-    if !is_instance_valid(drag_preview):
-        return
-
-    drag_preview.mouse_filter = Control.MOUSE_FILTER_IGNORE
-    drag_preview.global_position = _get_global_preview_position()
-    get_viewport().add_child(_preview_canvas_layer)
-    _preview_canvas_layer.add_child(drag_preview)
-    # Make sure the preview is drawn above the embedded windows
-    _preview_canvas_layer.layer = EMBEDDED_WINDOWS_LAYER + 1
-    hide()
+static func get_grab_offset_local_to(control: Control) -> Vector2:
+    return CtrlDragable.get_grab_offset() / control.get_global_transform().get_scale()
 
 
-func _get_global_preview_position() -> Vector2:
-    return get_global_mouse_position() - _grab_offset
+func _get_drag_data(at_position: Vector2):
+    if !_enabled:
+        return null
 
+    _grabbed_dragable = self
+    _grab_offset = at_position * get_global_transform().get_scale()
+    dragable_grabbed.emit(_grabbed_dragable, _grab_offset)
+    grabbed.emit(_grab_offset)
 
-func drag_end() -> void:
-    if !is_instance_valid(drag_preview):
-        return
+    var preview = Control.new()
+    var sub_preview = create_preview()
+    sub_preview.position = -get_grab_offset()
+    preview.add_child(sub_preview)
+    set_drag_preview(preview)
+    return self
 
-    _preview_canvas_layer.remove_child(drag_preview)
-    _preview_canvas_layer.get_parent().remove_child(_preview_canvas_layer)
-    drag_preview.mouse_filter = Control.MOUSE_FILTER_PASS
-    # HACK: Queue the show() call for later to avoid glitching
-    _queue_show()
 
-
-func _queue_show() -> void:
-    _show_queued = true
-
-
-func _notification(what) -> void:
-    if what == NOTIFICATION_PREDELETE && is_instance_valid(_preview_canvas_layer):
-        _preview_canvas_layer.queue_free()
-
-
-func _process(_delta) -> void:
-    if is_instance_valid(drag_preview) && is_instance_valid(drag_preview.get_parent()):
-        drag_preview.scale = get_global_transform().get_scale()
-        drag_preview.global_position = _get_global_preview_position()
-    if _show_queued:
-        _show_queued = false
-        show()
-
-
-func _gui_input(event: InputEvent) -> void:
-    if !enabled:
-        return
-
-    if event is InputEventMouseMotion:
-        _handle_mouse_motion(event as InputEventMouseMotion)
-    elif event is InputEventMouseButton:
-        _handle_mouse_button(event as InputEventMouseButton)
-
-
-func _handle_mouse_motion(event: InputEventMouseMotion) -> void:
-    var deadzone_radius = ProjectSettings.get_setting("gloot/item_dragging_deadzone_radius", 8.0)
-    if _clicked && (get_local_mouse_position() - _click_position).length() > deadzone_radius:
-        _clicked = false
-        grab(self)
-
-
-func _handle_mouse_button(event: InputEventMouseButton) -> void:
-    if event.button_index != MOUSE_BUTTON_LEFT:
-        return
-
-    if event.is_pressed():
-        _clicked = true
-        _click_position = get_local_mouse_position()
-        clicked.emit()
-    else:
-        _clicked = false
+func create_preview() -> Control:
+    return null
 
 
 func activate() -> void:
-    enabled = true
+    _enabled = true
 
 
 func deactivate() -> void:
-    enabled = false
+    _enabled = false
+
+
+func is_active() -> bool:
+    return _enabled
 
 
 func is_dragged() -> bool:

addons/gloot/ui/ctrl_drop_zone.gd

@@ -4,49 +4,6 @@ extends Control
 signal dragable_dropped(dragable, position)
 
 const CtrlDragable = preload("res://addons/gloot/ui/ctrl_dragable.gd")
-const CtrlDropZone = preload("res://addons/gloot/ui/ctrl_drop_zone.gd")
-
-var _mouse_inside := false
-static var _drop_event: Dictionary = {}
-
-
-func _process(_delta) -> void:
-    if _drop_event.is_empty():
-        return
-    
-    if _drop_event.zone == null:
-        CtrlDragable.release()
-    else:
-        if _drop_event.zone != self:
-            return
-        _drop_event.zone.dragable_dropped.emit(CtrlDragable.get_grabbed_dragable(), get_drop_position())
-        CtrlDragable.release_on(self)
-
-    _drop_event = {}
-
-
-func _input(event: InputEvent) -> void:
-    if !(event is InputEventMouseButton):
-        return
-
-    var mb_event: InputEventMouseButton = event
-    if mb_event.is_pressed() || mb_event.button_index != MOUSE_BUTTON_LEFT:
-        return
-
-    if CtrlDragable.get_grabbed_dragable() == null:
-        return
-
-    if _mouse_inside:
-        _drop_event = {zone = self}
-    elif _drop_event.is_empty():
-        _drop_event = {zone = null}
-
-
-func get_drop_position() -> Vector2:
-    # This check prevents some assertions when get_local_mouse_position() is called while get_viewport() is null.
-    if get_viewport() == null:
-        return Vector2.ZERO
-    return get_local_mouse_position() - (CtrlDragable.get_grab_offset() / get_global_transform().get_scale())
 
 
 func activate() -> void:
@@ -55,14 +12,19 @@ func activate() -> void:
 
 func deactivate() -> void:
     mouse_filter = Control.MOUSE_FILTER_IGNORE
-    _mouse_inside = false
 
 
 func is_active() -> bool:
     return (mouse_filter != Control.MOUSE_FILTER_IGNORE)
 
 
-func _ready() -> void:
-    mouse_entered.connect(func(): _mouse_inside = true)
-    mouse_exited.connect(func(): _mouse_inside = false)
+func _can_drop_data(at_position: Vector2, data) -> bool:
+    return data is CtrlDragable
+
+
+func _drop_data(at_position: Vector2, data) -> void:
+    var local_offset := CtrlDragable.get_grab_offset_local_to(self)
+    dragable_dropped.emit(data, at_position - local_offset)
+    CtrlDragable.dragable_dropped.emit(data, self, at_position - local_offset)
+
 

addons/gloot/ui/ctrl_inventory_grid_basic.gd

@@ -117,6 +117,11 @@ func _ready() -> void:
     _queue_refresh()
 
 
+func _notification(what: int) -> void:
+    if what == NOTIFICATION_DRAG_END:
+        _ctrl_drop_zone.deactivate()
+
+
 func _connect_inventory_signals() -> void:
     if !is_instance_valid(inventory):
         return

addons/gloot/ui/ctrl_inventory_grid_ex.gd

@@ -12,6 +12,7 @@ signal item_mouse_exited(item)
 
 const Verify = preload("res://addons/gloot/core/verify.gd")
 const CtrlInventoryGridBasic = preload("res://addons/gloot/ui/ctrl_inventory_grid_basic.gd")
+const CtrlInventoryItemRect = preload("res://addons/gloot/ui/ctrl_inventory_item_rect.gd")
 const CtrlDragable = preload("res://addons/gloot/ui/ctrl_dragable.gd")
 
 
@@ -271,6 +272,11 @@ func _ready() -> void:
     _queue_refresh()
 
 
+func _notification(what: int) -> void:
+    if what == NOTIFICATION_DRAG_END:
+        _fill_background(field_style, PriorityPanel.StylePriority.LOW)
+
+
 func _update_size() -> void:
     custom_minimum_size = _ctrl_inventory_grid_basic.size
     size = _ctrl_inventory_grid_basic.size
@@ -330,10 +336,13 @@ func _highlight_grabbed_item(style: StyleBox):
         _fill_background(field_style, PriorityPanel.StylePriority.LOW)
         return
 
+    _fill_background(field_style, PriorityPanel.StylePriority.LOW)
+
     var grabbed_item_coords := _ctrl_inventory_grid_basic.get_field_coords(global_grabbed_item_pos + (field_dimensions / 2))
     var item_size := inventory.get_item_size(grabbed_item)
     var rect := Rect2i(grabbed_item_coords, item_size)
-    _fill_background(field_style, PriorityPanel.StylePriority.LOW)
+    if !Rect2i(Vector2i.ZERO, inventory.size).encloses(rect):
+        return
     _set_rect_background(rect, style, PriorityPanel.StylePriority.LOW)
 
 
@@ -370,7 +379,7 @@ func _get_global_grabbed_item() -> InventoryItem:
 
 func _get_global_grabbed_item_local_pos() -> Vector2:
     if CtrlDragable.get_grabbed_dragable():
-        return get_local_mouse_position() - CtrlDragable.get_grab_offset()
+        return get_local_mouse_position() - CtrlDragable.get_grab_offset_local_to(self)
     return Vector2(-1, -1)