Exports (API Communication)

All Functions only accessible at server side

Good to know: You can use all functions as event or manupulation of the logic

Functions

Add channel to settings

Example (1)

exports["EasyGPS"]:AddChannel(array)

Parameters (1)

Name	Type
array	channel

Manipulation (1)

If false is returned, the code is interrupted and the channel is not added.

If it is set to true, the complete code will continue and the channel will be added.

Return (1)

The index of the channel in the array (int)

Deactivate a channel from settings

Example (2)

exports["EasyGPS"]:DeactivateChannel(key)

Parameters (2)

Name	Type
key	int

Manipulation (2)

If false is returned, the code is interrupted and the channel is not deactivated.

If it is set to true, the complete code will continue and the channel will be deactivated.

Modify a channel from settings

Example (3)

exports["EasyGPS"]:ModifyChannel(key, array)

Parameters (3)

Name	Type
key	int
array	channel

Manipulation (3)

If false is returned, the code is interrupted and the channel is not changed.

If it is set to true, the complete code will continue and the channel will be changed.

Get all channels from settings

Example (4)

exports["EasyGPS"]:GetChannels()

Return (4)

Array of Channels (channel[])

Events

OnToggle

Explanation (5)

Called when the blip of an entity is set or removed. (Listed after all checks)

Parameters (5)

Name	Type
entity	int (Entity)
channelID	int (Index of channel in channel[])
state	true / false

Channel

{
    IsPlayerAllowedToShow = function (entity, player)
        return true / false
    end,
    IsPlayerAllowedToToggle = function (entity, player, client)
        return true / false
    end,
    Checker = function (ped)
        return entity, true / false
    end,
    Blip = function (blip)
        -- Manage Blip
    end
}