OWFramework

OWFramework is an object to allow you to overwrite all framework functions.
You can overwrite all method from Framework & User class.

TIP

If you have an unmodified version of your framework that is supported natively by the library. You don't need to read this page.

How it works ?

Because some server customize their framework to add/edit features. The framework-bridge library was build to allow the link with these custom frameworks.
You can also add the link to your fully custom framework with these functions.
By overwrite the framework function in this file, all scripts that used the framework-bridge library will be compatible with your framework.

To overwrite a framework function, create the OWFramework in the @jo_libs/modules/framework-bridge/overwrite-functions.lua file.

Syntax

function OWFramework.<NameOfTheMethod>(...)
end

Arguments

NameOfTheMethod : string

Name of the native method from framework-bridge library

... : mixed

Same argument list than the native method

Return value

You have to return the same type of value than the native method to keep the scripts compatibility.

OWFramework.addItemInInventory

Add a specific item in a custom inventory

Syntax

function OWFramework.addItemInInventory(source,id,item,quantity,metadata,needWait)
end

Arguments

source : integer

The source ID of the player

id : string

The unique ID of the inventory

item : string

The name of the item

quantity : integer

The quantity of the item

metadata : table

The metadata of the item

needWait : boolean Optional

If the function need to wait the MySQL injected to ending
default: false

OWFramework.canUseItem()

If the user has enough quantity of a specific item in his inventory

Syntax

function OWFramework.canUseItem(source,item,amount,meta,remove)
end

Arguments

source : integer

The source ID of the player

item : string

The name of the item need to use

amount : integer

The quantity of the item

meta : table Optional

The metadata of the item

remove : boolean Optional

If the item has to be removed
default: false

Return value

Type: boolean

Return true if the player has enough quantity of the item

OWFramework.createInventory()

Function to create an inventory

Syntax

function OWFramework.createInventory(id,label,definition)
end

Arguments

id : string

Unique id of the inventory

label : string

Label of the inventory

definition : table

definition.maxSlots : integer - Max slot of the inventory
definition.maxWeight : float - Max weight of the inventory
definition.acceptWeapons : boolean (default: false) - If the inventory accept weapons Optional
definition.shared : boolean (default: true) - If the inventory is shared between players Optional
definition.ignoreStackLimit : boolean (default: true) - If the inventory can overcoming stack limits Optional
definition.whitelist : table - Restrict the list of item can be put in the inventory Optional

definition.whitelist[..].item : string - name of the whitelisted item
definition.whitelist[..].limit : string - stack limit of this item

Configuration of the inventory

OWFramework.get()

Get the framework name

Syntax

function OWFramework.get()
end

Return value

Type: string

Return the name of the framework

OWFramework.getItemsFromInventory()

Get the list of items included in a custom inventory

Syntax

function OWFramework.getItemsFromInventory(source,id)
end

Arguments

source : integer

The source ID of the player

id : string

The unique ID of the inventory

Return value

Type: table

Return the list of items

The item structure:
item.amount : integer - The amount of the item
item.id : integer - The id of the item
item.item : string - The name of the item
item.metadata : table - The metadata of the item

OWFramework.giveItem()

Give an item to the user

Syntax

function OWFramework.giveItem(source,item,amount,meta)
end

Arguments

source : integer

The source ID of the player

item : string

The name of the item

amount : integer

The amount of the item to give

meta : table Optional

The metadata of the item

Return value

Type: boolean

Return true if the item is successfully gave

OWFramework.initFramework()

A function fired to initialize the framework. You can initialize the Core value here.

Syntax

function OWFramework.initFramework()
end

Arguments

None.

OWFramework.openInventory()

Open a specific inventory

Syntax

function OWFramework.openInventory(source,id, name, definition)
end

Arguments

source : integer

The source ID of the player

id : string

The unique ID of the inventory

name : string

The name of the inventory

definition : table

definition.maxSlots : integer - Max slot of the inventory
definition.maxWeight : float - Max weight of the inventory
definition.acceptWeapons : boolean (default: false) - If the inventory accept weapons Optional
definition.shared : boolean (default: true) - If the inventory is shared between players Optional
definition.ignoreStackLimit : boolean (default: true) - If the inventory can overcoming stack limits Optional
definition.whitelist : table - Restrict the list of item can be put in the inventory Optional

definition.whitelist[..].item : string - name of the whitelisted item
definition.whitelist[..].limit : string - stack limit of this item

Configuration of the inventory

OWFramework.registerUseItem()

Register an item has usable and attach a function to it

Syntax

function OWFramework.registerUseItem(item,closeAfterUsed,cb)
end

Arguments

item : string

The name of the item

closeAfterUsed : boolean Optional

If the inventory needs to be closed after using the item default: true

cb : function

The function fired after use the item
1st argument: source
2nd argument: metadata of the item

OWFramework.removeInventory()

Remove the inventory from the server cache. Usefull to reload the inventory from the database

Syntax

function OWFramework.removeInventory(id)
end

Arguments

id : string

Unique id of the inventory

OWFramework.User.getJob()

Get the user job

Syntax

function OWFramework.User.getJob(source)
end

Arguments

source : integer

The source ID of the player

Return value

Type: string

Return the job name of the player

OWFramework.User.getMoney()

Get the user money

Syntax

function OWFramework.User.getMoney(source,moneyType)
end

Arguments

source : integer

The source ID of the player

moneyType : integer

moneyType = 0 > dollar
moneyType = 1 > gold
moneyType = 2 > rol

Return value

Type: float

Return the amount for this kind of money

OWFramework.User.getRPName()

Get the first & last name

Syntax

function OWFramework.User.getRPName(source)
end

Arguments

source : integer

The source ID of the player

Return value

Type: string

Return the name of the player

OWFramework.User.getSecondMoney()

Get the user second money (gold in many framework) Only for : RedEM:RP, QBR, RSG, QR framework

Syntax

function OWFramework.User.getSecondMoney(source)
end

Arguments

source : integer

The source ID of the player

Return value

Type: float

Return the amount of money for the second currency

OWFramework.User.getThirdMoney()

Get the user third money (rol in VORP framework) Only for : RedEM:RP, QBR, RSG, QR framework

Syntax

function OWFramework.User.getThirdMoney(source)
end

Arguments

source : integer

The source ID of the player

Return value

Type: float

Return the amount of money for the third currency

OWFramework.User.getUser()

Get the user data

Syntax

function OWFramework.User.getUser(source)
end

Arguments

source : integer

The source ID of the player

Return value

type: User

Return a User class

OWFramework.User.addMoney()

Add money from player

Syntax

function OWFramework.User.addMoney(source,amount,moneyType)

Arguments

amount : float

The amount of money added

moneyType : integer

moneyType = 0 > dollar
moneyType = 1 > gold
moneyType = 2 > rol

OWFramework.User.addSecondMoney()

Add the user second money (gold in many framework) Only for : RedEM:RP, QBR, RSG, QR framework

Syntax

function OWFramework.User.addSecondMoney(source, amount)
end

Arguments

source : integer

The source ID of the player

amount : float

The amount of money added

OWFramework.User.addThirdMoney()

Add the user third money (rol in VORP framework) Only for : RedEM:RP, QBR, RSG, QR framework

Syntax

function OWFramework.User.addThirdMoney(source)
end

Arguments

source : integer

The source ID of the player

amount : float

The amount of money added

OWFramework.User.removeMoney()

Remove money from player

Syntax

function OWFramework.User.removeMoney(source,amount,moneyType)

Arguments

amount : float

The amount of money removed

moneyType : integer

moneyType = 0 > dollar
moneyType = 1 > gold
moneyType = 2 > rol

OWFramework.User.removeSecondMoney()

Remove the user second money (gold in many framework) Only for : RedEM:RP, QBR, RSG, QR framework

Syntax

function OWFramework.User.removeSecondMoney(source, amount)
end

Arguments

source : integer

The source ID of the player

amount : float

The amount of money removed

OWFramework.User.removeThirdMoney()

Remove the user third money (rol in VORP framework) Only for : RedEM:RP, QBR, RSG, QR framework

Syntax

function OWFramework.User.removeThirdMoney(source)
end

Arguments

source : integer

The source ID of the player

amount : float

The amount of money removed