@2003scape/rsc-path-finder 中文文档教程

Question

rsc-path-finder

在 runescape 经典地图上的点之间生成路径。 每个瓷砖是 扩展为一个 2x2 的布尔值网格，描述了瓷砖是如何被阻挡的。 这 允许水平、垂直和完全阻塞的图块表示 （对角墙完全无法通过）。 一旦找到路径，步骤就是 平滑并转换为游戏坐标。

由于计算是异步的，因此可以安全地在游戏循环中使用该模块。

从 Lumbridge 到 Legend's Guild 的路径

从 Al Kharid 到 Bandit Camp 的路径

Tree Gnome Village 入口的路径

install

$ npm install @2003scape/rsc-path-finder

example

const fs = require('fs');
const { gunzipSync } = require('zlib');
const { Config } = require('@2003scape/rsc-config');
const { Landscape } = require('@2003scape/rsc-landscape');
const { PathFinder } = require('./src');

const config = new Config();
config.loadArchive(fs.readFileSync('./config85.jag'));

const landscape = new Landscape();
landscape.loadJag(fs.readFileSync('./land63.jag'),
    fs.readFileSync('./maps63.jag'));
landscape.loadMem(fs.readFileSync('./land63.mem'),
    fs.readFileSync('./maps63.mem'));
landscape.parseArchives();

const pathFinder = new PathFinder(config, landscape);
const objectLocations =
    JSON.parse(gunzipSync(fs.readFileSync('./object-locs.json.gz')));
objectLocations.forEach(obj => pathFinder.addObject(obj));

const wallObjectLocations = require('./wallObject-locs');
wallObjectLocations.forEach(obj => pathFinder.addWallObject(obj));

// replace the taverly gate with an open gate
pathFinder.addObject({ id: 58, x: 341, y: 487, direction: 4 });

// close the door in gertrude's house
pathFinder.addWallObject({ id: 2, x: 163, y: 513, direction: 1 });
// open it again
// pathFinder.addWallObject({ id: 1, x: 163, y: 513, direction: 1 });

pathFinder.start();

(async () => {
    const path = await pathFinder.findPath(
        { x: 126, y: 655 },
        { x: 513, y: 552 });
        //{ x: 72, y: 694 },
        //{ x: 320, y: 290 });
        //{ x: 672, y: 718 },
        //{ x: 634, y: 706 });
        //{ x: 138, y: 1594 },
        //{ x: 131, y: 1602 });
    console.log('found path to legends guild', path.length);

    fs.writeFileSync('./legends-path.png',
        pathFinder.toCanvas(path).toBuffer());

    pathFinder.stop();
})();

api

pathFinder = new PathFinder(config, landscape, tickRate = 80)

创建一个新的寻路实例。

config 第一个参数必须包含 game 和 wall 对象的定义 至少包含以下内容：

{
    // definitions for game objects (tree, altar, furnace, etc.)
    objects: [
        {
            type: 'unblocked' || 'blocked || 'closed-door' || 'open-door',
            width: Number,
            height: Number
        },
        // ...
    ],
    // definitions for wall objects (doors, walls, boundaries, etc.)
    wallObjects: [
        {
            blocked: true || false,
        }
        // ...
    ]
    // definitions for tiles (floors, water, roads, etc.)
    tiles: [
        {
            blocked: true || false,
        }
        // ...
    ]
}

对象， wallObjects 和 瓷砖 都是一个成员 rsc-config 实例。

landscape 是一个实例 rsc-landscape。

tickRate 是在 findPath 时轮询新路径的频率（以毫秒为单位） 不活跃。

pathFinder.addObject({ id, x, y, direction })

将游戏对象添加到位置。 id 对应于 config.objects 中的索引。 如果 添加了open-door 或closed-door 类型对象，将它们替换为 door 墙对象。

pathFinder.addWallObject({ id, x, y, direction })

将墙对象添加到位置。 id 对应于 config.wallObjects 中的索引 大批。 如果添加了未阻挡的墙对象，请移除所有现有障碍物 （带门框的门、带空白的蜘蛛网等）。

pathFinder.start()

pathFinder.stop()

启用和禁用寻路运行循环。

async pathFinder.findPath({ x, y }, { x, y })

找到 startPos 和 endPos 之间的路径。 返回游戏坐标数组。

pathFinder.isValidGameStep({ x, y }, { deltaX, deltaY })

如果我们可以在步进方向上从 startPos 步进，则返回 true。

pathFinder.getLineOfSight({ x, y }, { x, y })

找到两点之间的直接对角线直线路径。

pathFinder.toCanvas(path = undefined)

创建一个画布，所有障碍物都用白色填充。 如果路径是 指定，用红色填充路径图块。

license

版权所有 2020 2003Scape Team

该程序是免费软件：您可以重新分发它和/或修改它 GNU Affero 通用公共许可证的条款由 自由软件基金会，许可证的第 3 版，或（由您选择） 任何更高版本。

分发该程序是希望它有用，但没有任何 保修单; 甚至没有适销性或适用性的默示保证 特殊用途。 有关详细信息，请参阅 GNU Affero 通用公共许可证。

您应该已经收到 GNU Affero 通用公共许可证的副本 有了这个程序。 如果没有，请参阅 http://www.gnu.org/licenses/。