💻Exports (Client)

Name Display Related

Toggle Name Visibility

Show your name

local isVisible = exports['cats-advanced-name']:switchVisibleName(true)

Show your name

local isHidden = exports['cats-advanced-name']:switchVisibleName(false)

Show your name

local isToggled = exports['cats-advanced-name']:switchVisibleName()

Change Character Name

Change first and last name

local success = exports['cats-advanced-name']:changeName('太郎', '山田')
if success then
    print('Name changed successfully')
end

Name Label Management

Set a label (displayed above name)

local success = exports['cats-advanced-name']:changeNameLabel('Police Chief')

Remove the label

exports['cats-advanced-name']:removeNameLabel()

Get Current Display Name

Get the currently displayed name (nickname or real name)

local displayName = exports['cats-advanced-name']:getDisplayName()
print('Current display name: ' .. displayName)

Nickname Management

Add Nickname

Add a new nickname

local success = exports['cats-advanced-name']:addNickname('Johnny')
if success then
    print('Nickname added successfully')
end

Use Nickname

Use a saved nickname

exports['cats-advanced-name']:useNickname('Johnny')

Revert to Character Name

Stop using nickname and return to real name

exports['cats-advanced-name']:useCharacterName()

Get Nickname List

Get list of saved nicknames

local nicknames = exports['cats-advanced-name']:getNicknames()
for i, nickname in ipairs(nicknames) do
    print(i .. ': ' .. nickname)
end

Delete Nickname

Delete a specific nickname

exports['cats-advanced-name']:deleteNickname('Johnny')Mark Related

Mark Related

Toggle Mark

Toggle a specific mark (on→off or off→on)

local success = exports['cats-advanced-name']:toggleMark('police')
if success then
    print('Police mark toggled successfully')
end

Other mark examples

exports['cats-advanced-name']:toggleMark('ems')      -- EMS mark
exports['cats-advanced-name']:toggleMark('mechanic') -- Mechanic mark
exports['cats-advanced-name']:toggleMark('beginner') -- Beginner mark

Get Player Marks List

Get your own marks list

local myMarks = exports['cats-advanced-name']:getPlayerMarks()

Get marks list for a specific player (by player ID)

local playerMarks = exports['cats-advanced-name']:getPlayerMarks(12)

Check active marks

for markId, isActive in pairs(myMarks) do
    if isActive then
        print('Active mark: ' .. markId)
    end
end

Check Mark Status

Check if a specific mark is active

local isPolice = exports['cats-advanced-name']:isMarkActive('police')
if isPolice then
    print('Police mark is active')
end

Check mark status for another player

local hasEMS = exports['cats-advanced-name']:isMarkActive('ems', 12) -- Player ID 12

Get Mark Definitions List

Get all available mark definitions

local markDefs = exports['cats-advanced-name']:getMarkDefinitions()
for i, def in ipairs(markDefs) do
    print(def.id .. ': ' .. def.label .. ' - ' .. def.emoji)
end

PVE Mode Related

Check PVE Mode Status

Check current PVE mode status

local isPVE = exports['cats-advanced-name']:isPVEModeEnabled()
if isPVE then
    print('PVE mode is enabled')
else
    print('PVE mode is disabled')
end

Toggle PVE Mode

Enable PVE mode

exports['cats-advanced-name']:togglePVEMode(true)

Disable PVE mode

exports['cats-advanced-name']:togglePVEMode(false)