DropZone.ttslua

require('ge_tts.License')

local Class = require('ge_tts.Class')
local ObjectUtils = require('ge_tts.ObjectUtils')
local TableUtils = require('ge_tts.TableUtils')
local Vector3 = require('ge_tts.Vector3')
local Zone = require('ge_tts.Zone')

local MAX_DROP_VELOCITY_SQUARED = 5 * 5 -- 5 in/sec

---@class ge_tts__DropZone : ge_tts__Zone

---@shape ge_tts__DropZone_SavedState : ge_tts__Zone_SavedState
---@field occupantScale number
---@field rotationEnabled boolean
---@field rotationAxis number
---@field facing ge_tts__DropZone_Facing
---@field dropOffset tts__CharVectorShape
---@field fastMovementEnabled boolean
---@field fastRotationEnabled boolean

---@class ge_tts__static_DropZone : ge_tts__static_Zone
---@overload fun(position: tts__VectorShape, rotation: tts__VectorShape, scale: tts__VectorShape): ge_tts__DropZone
---@overload fun(position: tts__VectorShape, rotation: tts__VectorShape, scale: tts__VectorShape, occupantScale: nil | number): ge_tts__DropZone
---@overload fun(trigger: tts__ScriptingTrigger): ge_tts__DropZone
---@overload fun(trigger: tts__ScriptingTrigger, occupantScale: nil | number): ge_tts__DropZone
---@overload fun(savedState: ge_tts__DropZone_SavedState): ge_tts__DropZone
---@overload fun(positionTriggerOrSavedState: tts__VectorShape | tts__ScriptingTrigger | ge_tts__DropZone_SavedState, nilOrRotationOrOccupantScale: nil | number | tts__VectorShape, nilOrScale: nil | tts__VectorShape, nilOrOccupantScale: nil | number): ge_tts__DropZone
local DropZone = {}

DropZone.TYPE = 'DropZone'

DropZone.Facing = {
    UP = 1,
    DOWN = 2,
    DROPPED = 3,
}

DropZone.RotationAxis = {
    X = 1,
    Y = 2,
    Z = 4,
    All = 7
}

---@param colorName tts__PlayerColor
---@param object tts__Object
local function isInHand(object)
    for _, colorName in ipairs(Player.getAvailableColors()) do
        local player = Player[colorName]

        for i = 1, player.getHandCount() do
            for _, handObject in ipairs(player.getHandObjects(i)) do
                if object == handObject then
                    return true
                end
            end
        end
    end

    return false
end

---@alias ge_tts__DropZone_Facing 1 | 2 | 3

setmetatable(DropZone, TableUtils.merge(getmetatable(Zone), {
    ---@param class self
    ---@param positionTriggerOrSavedState tts__VectorShape | tts__ScriptingTrigger | ge_tts__DropZone_SavedState
    ---@param nilOrRotationOrOccupantScale nil | number | tts__VectorShape
    ---@param nilOrScale nil | tts__VectorShape
    ---@param nilOrOccupantScale nil | number @Optional - occupant's desired X-axis scale. When scaling is applied it is applied to all dimensions i.e. aspect ratio is preserved. `nil` means dropped objects will not have their scale altered.
    __call = function(class, positionTriggerOrSavedState, nilOrRotationOrOccupantScale, nilOrScale, nilOrOccupantScale)
        local triggerProvided = type(positionTriggerOrSavedState) == 'userdata'
        local self = --[[---@type ge_tts__DropZone]] Class.parentConstructor(class, Zone)(
            positionTriggerOrSavedState,
            not triggerProvided and --[[---@type nil | tts__VectorShape]] nilOrRotationOrOccupantScale or nil,
            nilOrScale
        )

        ---@type nil | number
        local occupantScale

        ---@type boolean
        local rotationEnabled = true

        ---@type number
        local rotationAxis = DropZone.RotationAxis.All

        ---@type ge_tts__DropZone_Facing
        local facing = DropZone.Facing.UP

        ---@type ge_tts__Vector3
        local dropOffset = Vector3()

        local fastMovementEnabled = false
        local fastRotationEnabled = false

        ---@return nil | number @occupant's desired X-axis scale
        function self.getOccupantScale()
            return occupantScale
        end

        ---@return number
        function self.getRotationAxis()
            return rotationAxis
        end

        ---@param axis number
        function self.setRotationAxis(axis)
            rotationAxis = axis
            self.invalidateSavedState()
        end

        ---@return boolean
        function self.getRotationEnabled()
            return rotationEnabled
        end

        ---@param enabled boolean
        function self.setRotationEnabled(enabled)
            rotationEnabled = enabled
            self.invalidateSavedState()
        end

        ---@return ge_tts__DropZone_Facing
        function self.getFacing()
            return facing
        end

        ---@param face ge_tts__DropZone_Facing
        function self.setFacing(face)
            facing = face
            self.invalidateSavedState()
        end

        ---@return ge_tts__Vector3
        function self.getDropOffset()
            return Vector3(dropOffset)
        end

        ---@param offset tts__VectorShape
        function self.setDropOffset(offset)
            dropOffset = Vector3(offset)
            self.invalidateSavedState()
        end

        ---@return boolean
        function self.isFastMovementEnabled()
            return fastMovementEnabled
        end

        ---@param fast boolean
        function self.setFastMovementEnabled(fast)
            fastMovementEnabled = fast
        end

        ---@return boolean
        function self.isFastRotationEnabled()
            return fastRotationEnabled
        end

        ---@param fast boolean
        function self.setFastRotationEnabled(fast)
            fastRotationEnabled = fast
        end

        --- Called when a player attempts to drop an object within this zone. A drop zone will
        --- ignore objects that are dropped whilst moving at a high velocity, as it's assumed the
        --- player is trying to throw the object, not drop it in this zone.
        ---@param colorName tts__PlayerColor @Color of the TTS player that dropped the TTS object.
        ---@param object tts__Object
        ---@return ge_tts__Zone_FilterResult
        function self.filterObject(colorName, object)
            -- TODO: Once released, use object.getSmoothMoveTargetPosition() API. For now, we assume if the object is
            -- smooth moving that it's explicitly doing so into the zone i.e. we shouldn't ignore it.
            if object.isSmoothMoving() or Vector3.lengthSquared(object.getVelocity()) < MAX_DROP_VELOCITY_SQUARED then
                return Zone.FilterResult.ACCEPT
            else
                return Zone.FilterResult.IGNORE
            end
        end

        local superOnDrop = self.onDrop

        --- Called when a TTS object is dropped within this DropZone.
        ---@param colorName nil | tts__PlayerColor @Color of the TTS player that dropped the TTS object.
        ---@param object tts__Object @The object that was dropped.
        function self.onDrop(colorName, object)
            superOnDrop(colorName, object)

            local objectRotation = object.getRotationSmooth() or object.getRotation()
            local position = self.getObject().positionToWorld(dropOffset)

            ObjectUtils.setPositionSmooth(object, { position.x, math.max(position.y, object.getPosition().y), position.z }, false, fastMovementEnabled)

            if isInHand(object) then
                local useHands = object.use_hands

                object.use_hands = false

                -- If an object was just dropped in a hand zone, it seems we're unable to smooth move it out this frame.
                Wait.frames(function()
                    if not object.isDestroyed() then
                        if Zone.getObjectOccupyingZone(object) == self then
                            ObjectUtils.setPositionSmooth(object, { position.x, math.max(position.y, object.getPosition().y), position.z }, false, fastMovementEnabled)
                        end

                        object.use_hands = useHands
                    end
                end)
            end

            if rotationEnabled then
                local rotation = self.getRotation()

                if bit32.band(rotationAxis, DropZone.RotationAxis.X) ~= 0 then
                    objectRotation.x = rotation.x
                end

                if bit32.band(rotationAxis, DropZone.RotationAxis.Y) ~= 0 then
                    objectRotation.y = rotation.y
                end

                if bit32.band(rotationAxis, DropZone.RotationAxis.Z) ~= 0 then
                    if facing == DropZone.Facing.DROPPED then
                        objectRotation.z = (objectRotation.z + 360) % 360

                        if objectRotation.z >= 270 then
                            objectRotation.z = 360
                        elseif objectRotation.z <= 90 then
                            objectRotation.z = 0
                        else
                            objectRotation.z = 180
                        end
                    else
                        objectRotation.z = facing == DropZone.Facing.UP and 0 or 180
                    end
                end

                ObjectUtils.setRotationSmooth(object, objectRotation, false, fastRotationEnabled)
            end

            if occupantScale then
                object.scale((--[[---@not nil]] occupantScale) / object.getScale()[1])
            end
        end

        local superInsertOccupyingObject = self.insertOccupyingObject

        --- Used programmatically when `object` should be made a direct occupant, but not dropped by a player.
        ---@param object tts__Object @The object that was dropped.
        function self.insertOccupyingObject(object)
            if occupantScale then
                object.scale((--[[---@not nil]] occupantScale) / object.getScale()[1])
            end

            superInsertOccupyingObject(object)
        end

        ---@type fun(): ge_tts__Zone_SavedState
        local superSave = self.save

        ---@return ge_tts__DropZone_SavedState
        function self.save()
            return --[[---@type ge_tts__DropZone_SavedState]] TableUtils.merge(superSave(), {
                occupantScale = occupantScale,
                rotationEnabled = rotationEnabled,
                rotationAxis = rotationAxis,
                facing = facing,
                dropOffset = dropOffset.toData(),
                fastMovementEnabled = fastMovementEnabled,
                fastRotationEnabled = fastRotationEnabled,
            })
        end

        if DropZone.isSavedState(positionTriggerOrSavedState) then
            local data = --[[---@type ge_tts__DropZone_SavedState]] positionTriggerOrSavedState

            occupantScale = data.occupantScale
            rotationEnabled = data.rotationEnabled
            rotationAxis = data.rotationAxis
            facing = data.facing
            dropOffset = Vector3(data.dropOffset)
            fastMovementEnabled = data.fastMovementEnabled
            fastRotationEnabled = data.fastRotationEnabled
        elseif triggerProvided then
            occupantScale = --[[---@type nil | number]] nilOrRotationOrOccupantScale
        else
            occupantScale = nilOrOccupantScale
        end

        return self
    end,
    __index = Zone,
}))

return DropZone