Exports

Exports

Prodigy Chat provides exports that can be used by other resources to interact with the chat system.

Client-Side Exports

GetProdigyTimestamp

Returns a formatted timestamp string in the format [HH:MM:SS].

Usage:

local timestamp = exports['prodigy-chat']:GetProdigyTimestamp()
-- Returns: "[14:30:25]"

Example:

local timestamp = exports['prodigy-chat']:GetProdigyTimestamp()
print(timestamp) -- Output: [14:30:25]

Returns:

• string - Formatted timestamp string [HH:MM:SS]

Server-Side Exports

getMaskData

Returns the current mask data table containing all masked players.

Usage:

local maskData = exports['prodigy-chat']:getMaskData()

Returns:

• table - Array of mask data entries with the following structure:

  {
      {
          source = playerId,              -- Player server ID
          maskName = "MASKED_1234",       -- Masked name format
          server_maskedNameEnabled = true  -- Whether masking is enabled
      },
      -- ... more entries
  }

Example:

local maskData = exports['prodigy-chat']:getMaskData()

for _, data in ipairs(maskData) do
    print(string.format("Player %d is masked as %s", data.source, data.maskName))
end

Events

While not exports, Prodigy Chat also triggers several events that other resources can listen to:

Client Events

prodigy-chat:updateFont

Triggered when chat font is changed.

Parameters:

• fontFamily (string) - The new font family name

Example:

RegisterNetEvent('prodigy-chat:updateFont')
AddEventHandler('prodigy-chat:updateFont', function(fontFamily)
    print("Chat font changed to: " .. fontFamily)
end)

prodigy-chat:updateSize

Triggered when chat size is changed.

Parameters:

• size (string) - The new size ("small", "medium", "large", "xlarge")

Example:

RegisterNetEvent('prodigy-chat:updateSize')
AddEventHandler('prodigy-chat:updateSize', function(size)
    print("Chat size changed to: " .. size)
end)

prodigy-chat:updateMaskState

Triggered when a player's mask state changes.

Parameters:

• isMasked (boolean) - Whether the player is masked

• maskName (string, optional) - The masked name if masked

Example:

RegisterNetEvent('prodigy-chat:updateMaskState')
AddEventHandler('prodigy-chat:updateMaskState', function(isMasked, maskName)
    if isMasked then
        print("Player is masked as: " .. maskName)
    else
        print("Player is no longer masked")
    end
end)

Server Events

prodigy-chat:maskStateChanged

Triggered when a player's mask state changes on the server.

Parameters:

• source (number) - Player server ID

• isMasked (boolean) - Whether the player is masked

• maskName (string, optional) - The masked name if masked

Example:

RegisterNetEvent('prodigy-chat:maskStateChanged')
AddEventHandler('prodigy-chat:maskStateChanged', function(source, isMasked, maskName)
    if isMasked then
        print(string.format("Player %d is masked as %s", source, maskName))
    end
end)

Integration Examples

Using Timestamp in Custom Chat

-- In your resource's client script
RegisterCommand('customchat', function(source, args)
    local message = table.concat(args, ' ')
    local timestamp = exports['prodigy-chat']:GetProdigyTimestamp()
    
    TriggerEvent('chat:addMessage', {
        template = '<div>{0} [Custom] {1}</div>',
        args = { timestamp, message }
    })
end)

Checking Mask State

-- In your resource's server script
RegisterCommand('checkmask', function(source, args)
    local maskData = exports['prodigy-chat']:getMaskData()
    local targetId = tonumber(args[1])
    
    for _, data in ipairs(maskData) do
        if data.source == targetId and data.server_maskedNameEnabled then
            print(string.format("Player %d is masked as %s", targetId, data.maskName))
            return
        end
    end
    
    print(string.format("Player %d is not masked", targetId))
end)

Listening to Mask Changes

-- In your resource's server script
RegisterNetEvent('prodigy-chat:maskStateChanged')
AddEventHandler('prodigy-chat:maskStateChanged', function(source, isMasked, maskName)
    if isMasked then
        -- Do something when player masks up
        print(string.format("Player %d masked up as %s", source, maskName))
    else
        -- Do something when player removes mask
        print(string.format("Player %d removed their mask", source))
    end
end)

Notes

• All exports are available immediately after the resource starts

• Client exports can only be called from client-side scripts

• Server exports can only be called from server-side scripts

• Events are triggered automatically by the chat system

• Always check if exports exist before using them in your code

Troubleshooting

Export Not Found

If you get an error that an export is not found:

1. Ensure Prodigy Chat is started and loaded

2. Check the resource name matches exactly: 'prodigy-chat'

3. Verify you're calling the export from the correct side (client/server)

4. Check server console for any resource errors

Export Returns Nil

• For getMaskData: Returns an empty table {} if no players are masked

• For GetProdigyTimestamp: Should always return a string, check for typos in the export name