factorio-scenario-ExpCluster/exp_legacy/module/modules/commands/teleport.lua

--[[-- Commands Module - Teleport
    - Adds a command that allows players to teleport to other players
    @commands Teleport
]]

local Commands = require("modules.exp_legacy.expcore.commands") --- @dep expcore.commands
require("modules.exp_legacy.config.expcore.command_general_parse")

local function teleport(from_player, to_player)
    local surface = to_player.physical_surface
    local position = surface.find_non_colliding_position("character", to_player.physical_position, 32, 1)

    -- return false if no new position
    if not position then
        return false
    end

    if from_player.vehicle then
        -- Teleport the entity
        local entity = from_player.vehicle
        local goto_position = surface.find_non_colliding_position(entity.name, position, 32, 1)

        -- Surface teleport can only be done for players and cars at the moment. (with surface as an peramitor it gives this error)
        if entity.type == "car" then
            entity.teleport(goto_position, surface)
        elseif surface.index == entity.surface.index then
            -- Try teleport the entity
            if not entity.teleport(goto_position) then
                from_player.driving = false
                from_player.teleport(position, surface)
            end
        end
    else
        -- Teleport the player
        from_player.teleport(position, surface)
    end
    return true
end

--- Teleports a player to another player.
-- @command teleport
-- @tparam LuaPlayer from_player the player that will be teleported, must be alive
-- @tparam LuaPlayer to_player the player to teleport to, must be online (if dead goes to where they died)
Commands.new_command("teleport", { "expcom-tp.description-tp" }, "Teleports a player to another player.")
    :add_param("from_player", false, "player-alive")
    :add_param("to_player", false, "player-online")
    :add_alias("tp")
    :set_flag("admin_only")
    :register(function(_, from_player, to_player)
        if from_player.index == to_player.index then
            -- return if attempting to teleport to self
            return Commands.error{ "expcom-tp.to-self" }
        end
        if not teleport(from_player, to_player) then
            -- return if the teleport failed
            return Commands.error{ "expcom-tp.no-position-found" }
        end
    end)

--- Teleports a player to you.
-- @command bring
-- @tparam LuaPlayer player the player that will be teleported, must be alive
Commands.new_command("bring", { "expcom-tp.description-bring" }, "Teleports a player to you.")
    :add_param("player", false, "player-alive")
    :set_flag("admin_only")
    :register(function(player, from_player)
        if from_player.index == player.index then
            -- return if attempting to teleport to self
            return Commands.error{ "expcom-tp.to-self" }
        end
        if not teleport(from_player, player) then
            -- return if the teleport failed
            return Commands.error{ "expcom-tp.no-position-found" }
        end
        from_player.print("Come here my friend")
    end)

--- Teleports you to a player.
-- @command goto
-- @tparam LuaPlayer player the player to teleport to, must be online (if dead goes to where they died)
Commands.new_command("goto", { "expcom-tp.description-goto" }, "Teleports you to a player.")
    :add_param("player", false, "player-online")
    :add_alias("tp-me", "tpme")
    :register(function(player, to_player)
        if to_player.index == player.index then
            -- return if attempting to teleport to self
            return Commands.error{ "expcom-tp.to-self" }
        end
        if not teleport(player, to_player) then
            -- return if the teleport failed
            return Commands.error{ "expcom-tp.no-position-found" }
        end
    end)