Server

getPlayerData

Usage

bridge.framework.getPlayerData(src)

• src: number

Example

bridge.framework.getPlayerData(src)

• return: object

  • identifier: string

  • gender: string

  • name: object

    • first: string

    • last: string

    • full: string

  • job: object

    • name: string

    • label: string

    • onDuty: boolean

    • grade: number

    • gradeName: string

  • money: object

    • cash: number

    • bank: number

getPlayerByIdentifier

Usage

bridge.framework.getPlayerByIdentifier(identifier)

• identifier: string

Example

bridge.framework.getPlayerByIdentifier(identifier)

• return: number

addMoney

Usage

bridge.framework.addMoney(src, type, amount)

• src: number

• type: "cash" or "bank"

• amount: number

Example

bridge.framework.addMoney(src, "bank", 50000)

• return: boolean

removeMoney

Usage

bridge.framework.removeMoney(src, type, amount)

• src: number

• type: "cash" or "bank"

• amount: number

Example

bridge.framework.removeMoney(src, "bank", 50000)

• return: boolean

createUsableItem

Usage

bridge.framework.createUsableItem(name, cb)

• name: string

• cb: function

Example

bridge.framework.createUsableItem("water", function(src)
    print("Example Function")
end)

registerCommand

Usage

bridge.framework.registerCommand(name, permission, cb, data)

• name: string

• permission: string

• cb: function

• data(optional): object

  • help(optional): string

  • arguments(optional): array

    • name: string

    • help: string

    • optional: boolean

Example

bridge.framework.registerCommand("test", "user", function(src, args)
    print("Example Command")
end)

bridge.framework.registerCommand("test", "god", function(src, args)
    print("src: " .. src)
    print("playerId: " .. args.playerId)
    print("fullname: " .. args.fullname)
end, {
    help = "Example Command Help",
    arguments = {
        {name = "playerId", help = "Provide Player Id", optional = false},
        {name = "fullname", help = "Provide Player Id Full Name", optional = true},
    },
})

getAllJobs

Usage

bridge.framework.getAllJobs()

Example

bridge.framework.getAllJobs()

• return: object

  • jobName: object

    • name: string

    • label: string

    • grades: array

      • grade: number

      • name: string

getJob

Usage

bridge.framework.getJob(job)

• job: string

Example

bridge.framework.getJob(job)

• return: object

  • name: string

  • label: string

  • grades: array

    • grade: number

    • name: string