Exports & Examples

Exports

The Discord API provides comprehensive exports for checking guild membership, user data, roles, and guild information.

Guild Membership Functions

IsUserPartOfThisGuild(src, force, guildName)

Check if a player is a member of a specific Discord server.

Parameters:

• src (string): Player source ID
• force (boolean): Force refresh cache (required)
• guildName (string): Name of the Discord server (as defined in config) (required)

Returns: boolean - true if user is a member, false if not, nil on error

Example:

local isMember = exports['night_discordapi']:IsUserPartOfThisGuild(source, false, "Your Guild Name")
if isMember then
    print("Player is a member of the Discord server!")
end

IsUserPartOfAnyOfTheseGuilds(src, force, guildNames)

Check if a player is a member of any of the specified Discord servers.

Parameters:

• src (string): Player source ID
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user is a member of any server, false if not, nil on error

Example:

local guildNames = {"Guild 1", "Guild 2", "Guild 3"}
local isMember = exports['night_discordapi']:IsUserPartOfAnyOfTheseGuilds(source, false, guildNames)
if isMember then
    print("Player is a member of at least one Discord server!")
end

IsUserPartOfAllOfTheseGuilds(src, force, guildNames)

Check if a player is a member of all specified Discord servers.

Parameters:

• src (string): Player source ID
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user is a member of all servers, false if not, nil on error

Example:

local guildNames = {"Guild 1", "Guild 2"}
local isMember = exports['night_discordapi']:IsUserPartOfAllOfTheseGuilds(source, false, guildNames)
if isMember then
    print("Player is a member of all Discord servers!")
end

User Data Functions

GetDiscordUser(src, force)

Get Discord user information for a player.

Parameters:

• src (string): Player source ID
• force (boolean): Force refresh cache (optional)

Returns: table - User data containing id, name, avatar, or nil on error

Example:

local userData = exports['night_discordapi']:GetDiscordUser(source, false)
if userData then
    print("Discord ID: " .. userData.id)
    print("Username: " .. userData.name)
    print("Avatar: " .. (userData.avatar or "No avatar"))
end

GetDiscordMember(src, force, guildNames)

Get Discord member information for a player in specific servers.

Parameters:

• src (string): Player source ID
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: table - Member data containing id, name, nick, avatar, discriminator, roles, or nil on error

Example:

local memberData = exports['night_discordapi']:GetDiscordMember(source, false, {"Your Guild Name"})
if memberData then
    print("Member ID: " .. memberData.id)
    print("Nickname: " .. (memberData.nick or "No nickname"))
    print("Roles: " .. table.concat(memberData.roles, ", "))
end

Role Functions

GetDiscordMemberRoles(src, force, guildNames)

Get all Discord roles for a player across specified servers.

Parameters:

• src (string): Player source ID
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: table - Array of role names, or nil on error

Example:

local roles = exports['night_discordapi']:GetDiscordMemberRoles(source, false, {"Guild 1", "Guild 2"})
if roles then
    for _, role in ipairs(roles) do
        print("Role: " .. role)
    end
end

Note

This function returns role names filtered through Config.Discord_Role_Names — only roles you have mapped in the config will be returned. If you need the raw Discord role IDs (so your own resource can match by ID against its own mapping table), use GetDiscordMemberRoleIds instead.

GetDiscordMemberRoleIds(src, force, guildNames)

Get the raw, unfiltered Discord role IDs for a player across the specified servers. Unlike GetDiscordMemberRoles, this does not filter against Config.Discord_Role_Names — you receive every role ID Discord returns for that member. Useful for downstream resources (e.g. Night Shifts MDT) that maintain their own role-mapping tables and need to match by stable role ID rather than role name.

Parameters:

• src (number/string): Player source ID
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names — uses all configured guilds when omitted (optional)

Returns: table — Array of role ID strings (e.g. "123456789012345678"), or nil on error. Empty array when the member is in the guild but holds no roles.

Example:

local roleIds = exports['night_discordapi']:GetDiscordMemberRoleIds(source, false, {"Your Guild"})
if roleIds then
    for _, id in ipairs(roleIds) do
        print("Role ID: " .. id)
    end
end

Tip

Results are cached separately from GetDiscordMemberRoles (same TTL/eviction behaviour), so calling both in the same session does not double-spend Discord API requests.

IsMemberPartOfThisRole(src, roleName, force, guildNames)

Check if a player has a specific Discord role.

Parameters:

• src (string): Player source ID
• roleName (string): Name of the role to check
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user has the role, false if not, nil on error

Example:

local hasRole = exports['night_discordapi']:IsMemberPartOfThisRole(source, "Admin", false, {"Your Guild"})
if hasRole then
    print("Player has Admin role!")
end

IsMemberPartOfAnyOfTheseRoles(src, roleNames, force, guildNames)

Check if a player has any of the specified Discord roles.

Parameters:

• src (string): Player source ID
• roleNames (table): Array of role names to check
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user has any of the roles, false if not, nil on error

Example:

local roleNames = {"Admin", "Moderator", "VIP"}
local hasRole = exports['night_discordapi']:IsMemberPartOfAnyOfTheseRoles(source, roleNames, false, {"Your Guild"})
if hasRole then
    print("Player has at least one of the specified roles!")
end

IsMemberPartOfAllOfTheseRoles(src, roleNames, force, guildNames)

Check if a player has all of the specified Discord roles.

Parameters:

• src (string): Player source ID
• roleNames (table): Array of role names to check
• force (boolean): Force refresh cache (optional)
• guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user has all roles, false if not, nil on error

Example:

local roleNames = {"Admin", "Moderator"}
local hasAllRoles = exports['night_discordapi']:IsMemberPartOfAllOfTheseRoles(source, roleNames, false, {"Your Guild"})
if hasAllRoles then
    print("Player has all specified roles!")
end

Guild Information Functions

GetDiscordGuild(guildName, force)

Get information about a Discord server/guild.

Parameters:

• guildName (string): Name of the Discord server (as defined in config)
• force (boolean): Force refresh cache (optional)

Returns: table - Guild data containing id, name, icon, ownerid, roles, or nil on error

Example:

local guildData = exports['night_discordapi']:GetDiscordGuild("Your Guild Name", false)
if guildData then
    print("Guild ID: " .. guildData.id)
    print("Guild Name: " .. guildData.name)
    print("Owner ID: " .. guildData.ownerid)
end

Configuration Functions

These read straight from config.lua so other resources can enumerate the mappings this resource knows about — useful for rendering admin dropdowns (“pick a configured role / guild”) without hard-coding lists in every consumer.

GetConfiguredRoles()

Returns the configured role-name table from config.lua as { [roleID] = roleName }.

Parameters: None.

Returns: table — { [roleID] = roleName }, or nil if the resource config is invalid.

Example:

local roles = exports['night_discordapi']:GetConfiguredRoles()
if roles then
    for roleId, roleName in pairs(roles) do
        print(roleId, "->", roleName)
    end
end

GetConfiguredGuilds()

Returns the configured guild table from config.lua as { [guildID] = guildName }.

Parameters: None.

Returns: table — { [guildID] = guildName }, or nil if the resource config is invalid.

Example:

local guilds = exports['night_discordapi']:GetConfiguredGuilds()
if guilds then
    for guildId, guildName in pairs(guilds) do
        print(guildId, "->", guildName)
    end
end

Usage Examples

Basic Permission System

-- Check if player has admin role
local hasAdmin = exports['night_discordapi']:IsMemberPartOfThisRole(source, "Admin", false, {"Your Guild"})
if hasAdmin then
    -- Give admin permissions
    TriggerClientEvent('chat:addMessage', source, {
        color = {255, 0, 0},
        multiline = true,
        args = {"System", "You have admin permissions!"}
    })
end

Multi-Server Role Check

-- Check if player has role in any of multiple servers
local guildNames = {"Main Server", "Staff Server", "VIP Server"}
local roleNames = {"Admin", "Moderator", "VIP"}
local hasPermission = exports['night_discordapi']:IsMemberPartOfAnyOfTheseRoles(source, roleNames, false, guildNames)

if hasPermission then
    -- Example: Grant access to restricted area
    TriggerClientEvent('restrictedArea:grantAccess', source)
end

User Information Display

-- Get and display user information
local userData = exports['night_discordapi']:GetDiscordUser(source, false)
if userData then
    TriggerClientEvent('chat:addMessage', -1, {
        color = {0, 255, 0},
        multiline = true,
        args = {"Discord", userData.name .. " joined the server!"}
    })
end

Guild Membership Verification

-- Verify player is member of specific guild
local isMember = exports['night_discordapi']:IsUserPartOfThisGuild(source, false, "Whitelisted Guild")
if not isMember then
    DropPlayer(source, "You must be a member of our Discord server to join this server.")
end

Advanced Role System

-- Check multiple roles across multiple servers
local guildNames = {"Police Department", "Fire Department", "EMS"}
local requiredRoles = {"Officer", "Firefighter", "Paramedic"}

local hasRequiredRole = exports['night_discordapi']:IsMemberPartOfAnyOfTheseRoles(source, requiredRoles, false, guildNames)
if hasRequiredRole then
    -- Allow access to emergency services
    TriggerClientEvent('emergency:grantAccess', source)
else
    TriggerClientEvent('chat:addMessage', source, {
        color = {255, 0, 0},
        multiline = true,
        args = {"System", "You need to be verified in our Discord server to access emergency services."}
    })
end

Integration with Other Resources

The Discord API serves as the foundation for these resources:

Resource	Purpose
Player List	Display players with Discord roles
Player Names	Sync Discord usernames
Garage System	Role-based vehicle access
Vehicle Permissions (vPerms)	Role-based vehicle permissions
Weapon Permissions (wPerms)	Role-based weapon permissions
Discord Spawn	Role-based spawning system
Discord Lockers	Role-based locker access
Discord Allowlist	Discord-based allowlist system
Emergency Response Simulator	A PvE Emergency Response Simulator
Night Shifts MDT	An system managing Emergency Services & Registrations