refactor: create strongly typed `metadata` property on `Actor` and `Player` - Githubissues

runejs / server

RuneJS is a RuneScape game server written in TypeScript and JavaScript. The goal of the project is to create a comprehensive game engine, while also providing simple and easy to use content development systems and APIs.

GNU General Public License v3.0

244 stars 83 forks source link

refactor: create strongly typed `metadata` property on `Actor` and `Player` #376

Closed Jameskmonger closed 2 years ago

Jameskmonger commented 2 years ago

defines types for all metadata properties which were currently in use
splits the metadata into Actor and Player -focused types
adds documentation on the purpose of each property as well as metadata in general
adds some TODOs for future consideration around deprecation etc

Notes for reviewer:

the first commit (8dd93322de0a6ded569e94c91008b4934ebb30c4) is responsible for setting up the typed metadata system
the remaining commits are for creating types
the final commit (60cdb68f03edb138f4930b85fa95ffe57753eeae) is deleting some unused code