npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

forgottenserver-ts-declarations

v1.4.2-1

Published

TypeScript declaration files for The Forgotten Server, bridging C++ and Lua codebases for enhanced development efficiency.

Downloads

5

Readme

The Forgotten Server - TypeScript Declarations

GitHub license

Typescript declaration files for The Forgotten Server 1.4.2.

Installation

npm install --save-dev forgottenserver-ts-declarations

In your project modify tsconfig.json to include the following:

{
  "include": [
    "<your other packages>",
    "node_modules/forgottenserver-ts-declarations"
  ]
}

Example

A talkaction /kill_player that instantly kills a player when you are a God.

const talkAction = TalkAction('/kill_player', '/kp');

talkAction.onSay((player, words, param) => {
  const potentialPlayer = Player(param.trim());
  if (!potentialPlayer) {
    player.sendTextMessage(MessageClasses.MESSAGE_STATUS_WARNING, `Player ${param} not found.`);
    return false;
  }
  potentialPlayer.addHealth(-potentialPlayer.getHealth());
  potentialPlayer.getPosition().sendMagicEffect(MagicEffectClasses.CONST_ME_MORTAREA);
  potentialPlayer.sendTextMessage(
      MessageClasses.MESSAGE_STATUS_CONSOLE_BLUE,
      `You were instantly killed by god`
  );

  player.sendTextMessage(
      MessageClasses.MESSAGE_STATUS_CONSOLE_BLUE,
      `Killed ${potentialPlayer.getName()}`
  );

  return false;
});

talkAction.separator(' ');
talkAction.access(true);
talkAction.accountType(AccountType.ACCOUNT_TYPE_GOD);
talkAction.register();

export {};

Good to know

  • Typescript code is transpiled to Lua, so there is no browser or Node.js specific APIs. Treat it as a templating language for Lua.
  • All the structures are defined in a global scope. No importing is required.
  • By default all root level variables are not scoped, for example:
      // file A.ts
      const a = 1;
      
      // file B.ts
      const a = 2; // Error: Variable 'a' is already defined in the global scope.
    To avoid this, use export {} at the end of the file to create a module scope.
      // file A.ts
      const a = 1;
      export {};
      
      // file B.ts
      const a = 2; // No error
      export {};
  • All the enums are treated in a special way. See example:
    // A.ts
    print(MessageClasses.MESSAGE_STATUS_WARNING);
    is transpiled to:
    # A.lua
    print(MESSAGE_STATUS_WARNING);

Overview

This project includes TypeScript declaration files in two directories for type definitions:

  • cpp: Contains declarations for structures defined in src/luascript.cpp.
  • lua: Contains declarations for structures defined in the data directory with Lua scripts.

Contributing

Pull requests are welcome.