wuzi/altv-decorators

A useful lightweight library which helps to registry server-side events, commands via decorators for ALTV API

altv-decorators

A useful lightweight library which helps to registry server-side/client-side events via decorators for AltvMP

• Installation
• Examples
• API

Installation

Via npm: `$ npm i https://github.com/wuzi/altv-decorators.git

Via yarn: `$ yarn add https://github.com/wuzi/altv-decorators.git

Examples

NinjaEvents.ts event example

import { event, eventable } from 'altv-decorators'

@eventable()
class NinjaEvents {
  @event("playerJoin")
  ninjaJoin(player: PlayerMp) {
    console.log(`Ninja ${player.name} has just joined.`))
  }
}

NinjaKeys.ts key example

import { key, keyable } from 'altv-decorators'

@keyable()
class NinjaKeys {
  @key('release', 82)
  ninjaReleaseT(player: PlayerMp) {
    console.log(`Ninja ${player.name} released T key.`))
  }
}

API

eventable()

Resolve any events which passed to classes with decorator eventable

event(eventName)

Parameters

• eventName string | string[] - event(s) name, which will be added to alt.on('eventName', callback)

keyable()

Resolve any key presses/releases which passed to classes with decorator keyable

key(action, keyCode)

Parameters

• action string - key action (press or release)
• keyCode number - the key code to bind the function