Client exports & events

Exports

PEFCL exposes a few useful exports that be used from other resources to integrate better with the financing system. The exports support both callback & promises.

openBank

Opens the Bank UI. This can be used to open the bank anywhere

Lua Example

exports.pefcl:openBank()

JS Example

exports.pefcl.openBank()

TS Example

exports.pefcl.openBank()

closeBank

Closes the Bank UI

Lua Example

exports.pefcl:closeBank()

JS Example

exports.pefcl.closeBank()

TS Example

exports.pefcl.closeBank()

openAtm

Opens the ATM UI

Lua Example

exports.pefcl:openAtm()

JS Example

exports.pefcl.openAtm()

TS Example

exports.pefcl.openAtm()

closeAtm

Closes the ATM UI

Lua Example

exports.pefcl:closeAtm()

JS Example

exports.pefcl.closeAtm()

TS Example

exports.pefcl.closeAtm()

giveNearestPlayerCash

Gives amount of cash to the nearest player.

Lua Example

exports.pefcl:giveNearestPlayerCash(amount)

JS Example

exports.pefcl.giveNearestPlayerCash(amount)

TS Example

exports.pefcl.giveNearestPlayerCash(amount: number)

• amount: number
  • Amount of cash to be given to the nearest player.

createInvoiceForNearestPlayer

Creates an invoice for the nearest player.

Lua Example

exports.pefcl:createInvoiceForNearestPlayer(amount, message)

JS Example

exports.pefcl.createInvoiceForNearestPlayer(amount, message)

TS Example

exports.pefcl.createInvoiceForNearestPlayer(amount: number, message: string)

• amount: number
  • Decides how much the invoice should be
• message: string
  • Invoice description

depositMoney

Deposits money into default account, without ATM.

Lua Example

exports.pefcl:depositMoney(amount)

JS Example

exports.pefcl.depositMoney(amount)

TS Example

exports.pefcl.depositMoney(amount: number)

withdrawMoney

Withdraws money from default account, without ATM.

Lua Example

exports.pefcl:withdrawMoney(amount)

JS Example

exports.pefcl.withdrawMoney(amount)

TS Example

exports.pefcl.withdrawMoney(amount: number)

Events

pefcl:newTransaction

interface Account {
  id: number;
  number: string;
  balance: number;
  isDefault: boolean;
  accountName: string;
  ownerIdentifier: string;
  role: 'owner' | 'admin' | 'contributor';
  type: 'personal' | 'shared';
  createdAt?: string;
}

interface Transaction {
  id: number;
  toAccount?: Account;
  fromAccount?: Account;

  amount: number;
  message: string;
  type: 'Outgoing' | 'Incoming';

  updatedAt?: string;
  createdAt?: string;
}

Lua

AddEventHandler('pefcl:newTransaction', function(transaction)
    ShowNotification("You got a new transaction of" .. transaction.amount)
end)

JavaScript

onNet('pefcl:newTransaction', (transaction) => {
  showNotification(`You got a new transaction of ${transaction.amount}`)
}

Typescript

onNet('pefcl:newTransaction', (transaction: Transaction) => {
  showNotification(`You got a new transaction of ${transaction.amount}`)
}