Hooks

General

`createHook`

Creates a hook for a specified action. You can also return false in some hooks to cancel the action!

Arguments

Name	Type	Description
`name`	Hook	Hook name
`callback`	function	Callback function

Example

server.lua

exports['high-phone']:createHook('startCall', function(src, call)
    print(src, json.encode(call, { indent = true }))
    -- Cancel the call
    return false
end)

Hooks

`beforeCreatePhone`

Gets called before the phone is inserted into the database, which means you can inject your own data.

Function Parameters

Name	Type	Description
`src`	number	Player source
`data`	PhoneData	Phone data

Example

server.lua

exports['high-phone']:createHook('beforeCreatePhone', function(src, data)
    print(src, data.number)
end)

`afterCreatePhone`

Gets called after the phone is inserted into the database. Use for tasks that don't inject any data, as it will not get updated in the database.

Function Parameters

Name	Type	Description
`src`	number	Player source
`data`	PhoneData	Phone data

Example

server.lua

exports['high-phone']:createHook('afterCreatePhone', function(src, data)
    print(src, data.number)
end)

`startCall`

Gets called when a player starts a phone call.

Function Parameters

Name	Type	Description
`src`	number	Player source
`call`	PhoneCall	Call data

Example

server.lua

exports['high-phone']:createHook('startCall', function(src, call)
    print(src, call.caller.number, call.participants[1].number)
    -- Cancel the call
    return false
end)

`endCall`

Gets called when a phone call is ended.

Function Parameters

Name	Type	Description
`src`	number	Player source
`call`	PhoneCall	Call data

Example

server.lua

exports['high-phone']:createHook('endCall', function(src, call)
    print(src, call.caller.number, call.participants[1].number)
end)

`sendMessage`

Gets called when a message is sent, that includes server-sent messages.

Function Parameters

Name	Type	Description
`src?`	number	Player source if not sent from the server
`message`	MessageData	Message data

Example

server.lua

exports['high-phone']:createHook('sendMessage', function(src, message)
    print(src, message.sender, message.recipient)
    -- Cancel the message
    return false
end)

Hooks

On this page