The library module

Importing

library is an additional library for TERA modules. Its folder must be named library, not library-master. Declare it as a dependency in module.json; access the interface through mod.require.library.

module.exports = function LibraryExample(mod) {
    const lib = mod.require.library;
    mod.command.add('lib-position', () => {
        if (!mod.game.isIngame) return;
        mod.command.message(JSON.stringify(lib.player.loc));
    });
};

Public components are entity, player, effect, packet and library. mods contains references to loaded components. Call utilities through lib.library, for example lib.library.dist3D(a, b). lib.command and lib.cmd reference the command interface.

Entity

lib.entity maintains players, mobs, npcs, unknown and entities objects indexed by gameId. State is cleared on zone loading; check that an entry exists before using it.

Entries in players/mobs/npcs/unknown expose pos with x/y/z/w coordinates/direction, info.huntingZoneId, info.templateId, name, job and race. The entities collection contains instances of the newer Entity class: huntingZoneId and templateId are direct properties and getLocation() retrieves the position. That class's info and loc getters throw; do not mix the two entry formats.

The historical README describes appearance aliases outfit, app, apperance, appearance and fields weapon, body, hand, feet, underwear, head, face, styleHead, styleFace, styleBack, styleWeapon, styleBody, styleFootprint, styleBodyDye, bodyDye. The inspected implementation does not populate those aliases: do not treat them as an available API for new development.

Despite its name, isNearBoss iterates over mobs. Proximity uses positionsIntersect, whose geometry is described below; it is not a universal point-within-radius test.

Player

lib.player.isMe(gameId) checks the current character. Main properties:

race = Math.floor((templateId - 10101) / 100) and job = (templateId - 10101) % 100. Player appearance aliases from the older README are also absent from the inspected implementation. Do not assume other properties are populated before their game packets arrive.

Effect

lib.effect stores abnormals, glyphs and permanentBuffs as ID → state objects. hasAbnormality(id), hasGlyph(id) and hasBuff(id) test === true. hasEffect(id) returns the first truthy state from the three stores; absent entries can produce undefined, so use it as a condition rather than expecting literal false.

getAbnormalities(), getGlyphs() and getBuffs() return the actual stores, not copies. Expired effects may leave keys with false values: check the value rather than key existence. State resets on S_LOGIN.

Coordinates and skills

Methods of lib.library:

positionsIntersect ignores Z and excludes complete containment when radii differ. For “within R”, use dist2D <= R or Vec3.sqrDist2D.

getSkillInfo returns raw, id, skill, sub and level; methods setValues, getBaseId(skill = 1, level = 1, sub = 0) and setValuesTo(skill, level, sub) update/construct the numeric form. This legacy format using mask 0x4000000 does not replace the modern parser's skillid object.

Packets and DataCenter

lib.packet chooses definitions using an internal patch table. The library uses lib.packet.get_all(name) to return arguments for mod.hook(...result, callback). This is a compatibility table for the installed library version, not automatic support for every server.

For predictable result control in new code, prefer direct mod.queryData. version/protocolVersion on lib.library refer to the network protocol, not the npm package version; command is the command interface and sp is the result of an attempt to detect Skill Prediction.

Utilities

Explicitly pass your module directory for file operations: saveFile defaults to a directory inside the library itself. Ordinary JSON.stringify does not support BigInt; the library's custom encoding differs from Toolbox settings encoding.

Inheritance and deprecated API

You can directly import a class for specialized inheritance, but this couples your module to library internals. In the current version Player, like Entity, uses the second mods argument; the old super(mod) example is insufficient.

const Player = require('../library/class/player');
class CustomPlayer extends Player {
    constructor(mod, mods) {
        super(mod, mods);
    }
}
module.exports = CustomPlayer;

Additional instances register their own hooks. Usually the existing lib.player is sufficient. emptyLong() and long() throw in the current implementation: use BigInt. opositeDirection (with that spelling) and getDirectionTo are deprecated and log warnings. startSkillsPackets from the README is absent from current class/library.js; do not depend on it.

Sources: mods/library/README.md, mods/library/index.js, mods/library/class/{library,entity,player,effect,packet}.js.