Skip to content

Player meta

Physical representation of connected players.

Players are a type of Entity. They are a physical representation of a Character - and can possess at most one Character object at a time that you can interface with.

See the Garry's Mod Wiki for all other methods that the Player class has.

playerMeta:getChar

Description

Retrieves this player's currently possessed Character object if it exists.

Realm

Shared

Returns

  • Character|nil: The currently loaded character or nil if no character is loaded.

Example

local char = player:getChar()
if char then
    print("Character Name:", char:getName())
end

playerMeta:Name

Description

Returns this player's current name. If the player has a character loaded, it returns the character's name; otherwise, it returns the player's Steam name.

Realm

Shared

Returns

  • String: The name of the player's currently loaded character or the player's Steam name if no character is loaded.

Example

print("Player Name:", player:Name())

playerMeta:hasPrivilege

Description

Checks if the player has a specified CAMI privilege.

Realm

Shared

Parameters

  • privilegeName (String): The name of the privilege to check.

Returns

  • Boolean: true if the player has the privilege, false otherwise.

Example

if player:hasPrivilege("admin") then
    print("Player is an admin.")
end

playerMeta:getCurrentVehicle

Description

Gets the current vehicle the player is in, if any.

Realm

Shared

Returns

  • Entity|nil: The current vehicle entity or nil if the player is not in a vehicle.

Example

local vehicle = player:getCurrentVehicle()
if vehicle then
    print("Player is in a vehicle:", vehicle:GetClass())
end

playerMeta:hasValidVehicle

Description

Checks if the player is in a valid vehicle.

Realm

Shared

Returns

  • Boolean: true if the player is in a valid vehicle, false otherwise.

Example

if player:hasValidVehicle() then
    print("Player is in a valid vehicle.")
end

playerMeta:isNoClipping

Description

Checks if the player is currently in noclip mode.

Realm

Shared

Returns

  • Boolean: true if the player is in noclip mode, false otherwise.

Example

if player:isNoClipping() then
    print("Player is in noclip mode.")
end

playerMeta:hasRagdoll

Description

Checks if the player has a valid ragdoll entity.

Realm

Shared

Returns

  • Boolean: true if the player has a valid ragdoll entity, false otherwise.

Example

if player:hasRagdoll() then
    print("Player has a ragdoll.")
end

playerMeta:getRagdoll

Description

Returns the player's ragdoll entity if it exists and is valid.

Realm

Shared

Returns

  • Entity|nil: The player's ragdoll entity or nil if none exists.

Example

local ragdoll = player:getRagdoll()
if ragdoll then
    print("Ragdoll found:", ragdoll:GetClass())
end

playerMeta:isStuck

Description

Determines whether the player is stuck using a trace.

Realm

Shared

Returns

  • Boolean: true if the player is stuck, false otherwise.

Example

if player:isStuck() then
    print("Player is stuck.")
end

playerMeta:isNearPlayer

Description

Checks if the player is near another entity within a specified radius.

Realm

Shared

Parameters

  1. radius (int): The radius within which to check for proximity.
  2. entity (Entity): The entity to check proximity to.

Returns

  • Boolean: true if the player is near the specified entity within the given radius, false otherwise.

Example

if player:isNearPlayer(100, targetPlayer) then
    print("Player is near the target.")
end

playerMeta:entitiesNearPlayer

Description

Retrieves entities near the player within a specified radius. Can filter to only include players.

Realm

Shared

Parameters

  1. radius (int): The radius within which to search for entities.
  2. playerOnly (Boolean): If true, only return player entities.

Returns

  • Table: A table containing the entities near the player.

Example

local nearbyPlayers = player:entitiesNearPlayer(200, true)
for _, p in ipairs(nearbyPlayers) do
    print("Nearby Player:", p:Nick())
end

playerMeta:getItemWeapon

Description

Retrieves the active weapon item of the player along with its corresponding inventory item.

Realm

Shared

Returns

  • Entity|nil: The active weapon entity or nil if not found.
  • Item|nil: The corresponding inventory item or nil if not found.

Example

local weapon, item = player:getItemWeapon()
if weapon then
    print("Active Weapon:", weapon:GetClass())
end

playerMeta:isRunning

Description

Checks if the player is running based on their velocity compared to their walk speed.

Realm

Shared

Returns

  • Boolean: true if the player is running, false otherwise.

Example

if player:isRunning() then
    print("Player is running.")
end

playerMeta:isFemale

Description

Determines if the player's character model is female based on model naming conventions.

Realm

Shared

Returns

  • Boolean: true if the player's character is female, false otherwise.

Example

if player:isFemale() then
    print("Player character is female.")
end

playerMeta:getItemDropPos

Description

Calculates the position to drop an item from the player's inventory based on their current view.

Realm

Shared

Returns

  • Vector: The position where the item should be dropped.

Example

local dropPos = player:getItemDropPos()
item:spawn(dropPos, Angle(0, 0, 0))

playerMeta:getItems

Description

Retrieves the items from the player's character inventory.

Realm

Shared

Returns

  • Table|nil: A table containing the items in the player's character inventory or nil if not found.

Example

local items = player:getItems()
if items then
    for _, item in ipairs(items) do
        print("Item:", item.uniqueID)
    end
end

playerMeta:getTracedEntity

Description

Retrieves the entity traced by the player's aim within a short distance.

Realm

Shared

Returns

  • Entity|nil: The entity traced by the player's aim or nil if none is found.

Example

local target = player:getTracedEntity()
if target then
    print("Traced Entity:", target:GetClass())
end

playerMeta:getTrace

Description

Performs a hull trace from the player's view and returns the trace result.

Realm

Shared

Returns

  • Table: A table containing the trace result.

Example

local trace = player:getTrace()
if trace.Hit then
    print("Trace hit:", trace.Entity:GetClass())
end

playerMeta:getEyeEnt

Description

Retrieves the entity within the player's line of sight up to a specified distance.

Realm

Shared

Parameters

  • distance (int, optional): The maximum distance to consider. Defaults to 150.

Returns

  • Entity|nil: The entity within the player's line of sight or nil if none is found.

Example

local eyeEnt = player:getEyeEnt(200)
if eyeEnt then
    print("Entity in sight:", eyeEnt:GetClass())
end

playerMeta:loadLiliaData

Description

Loads Lilia data for the player from the database.

Realm

Server

Parameters

  • callback (function): A function to call after the data is loaded, receiving the loaded data as an argument.

Example

player:loadLiliaData(function(data)
    print("Data loaded:", data)
end)

playerMeta:saveLiliaData

Description

Saves the player's Lilia data to the database.

Realm

Server

Example

player:saveLiliaData()

playerMeta:setLiliaData

Description

Sets a key-value pair in the player's Lilia data. Optionally suppresses networking of the data update.

Realm

Server

Parameters

  1. key (String): The key for the data.
  2. value (any, optional): The value to set for the specified key. Defaults to nil if not provided.
  3. noNetworking (boolean, optional): If true, the data update will not be sent to clients. Defaults to false.

Example

-- Example 1: Setting a key-value pair with networking
player:setLiliaData("score", 1500)

-- Example 2: Setting a key-value pair without networking
player:setLiliaData("health", 100, true)

playerMeta:chatNotify

Description

Notifies the player with a message in the chatbox.

Realm

Server and Client

Parameters

  • message (String): The message to notify the player.

Example

player:chatNotify("Welcome to the server!")

playerMeta:chatNotifyLocalized

Description

Notifies the player with a localized message in the chatbox.

Realm

Server and Client

Parameters

  • message (String): The key of the localized message to notify the player.
  • ... (any): Additional arguments to format the localized message.

Example

player:chatNotifyLocalized("welcome_message", player:Nick())

playerMeta:chatError

Description

Notifies the player with an error message in the chatbox.

Realm

Server and Client

Parameters

  • message (String): The error message to notify the player.

Example

player:chatError("An error occurred!")

playerMeta:chatErrorLocalized

Description

Notifies the player with a localized error message in the chatbox.

Realm

Server and Client

Parameters

  • message (String): The key of the localized error message to notify the player.
  • ... (any): Additional arguments to format the localized message.

Example

player:chatErrorLocalized("error_message", player:Nick())

playerMeta:getLiliaData

Description

Retrieves a value from the player's Lilia data.

Realm

Server and Client

Parameters

  1. key (String): The key for the data.
  2. default (any, optional): The default value to return if the key does not exist.

Returns

  • any: The value corresponding to the key, or the default value if the key does not exist.

Example

local level = player:getLiliaData("level", 1)
print("Player Level:", level)

playerMeta:getAllLiliaData

Description

Retrieves the full Lilia data table for the player.

Realm

Server and Client

Returns

  • table: The entire Lilia data table for the player.

Example

local fullData = player:getAllLiliaData()
-- Print all data for debugging
PrintTable(fullData)

playerMeta:setRagdoll

Description

Sets the player's ragdoll entity.

Realm

Server

Parameters

  • entity (Entity): The entity to set as the player's ragdoll.

Example

local ragdoll = player:createServerRagdoll()
player:setRagdoll(ragdoll)

playerMeta:setAction

Description

Sets an action bar for the player with optional duration and callback.

Realm

Server

Parameters

  1. text (String): The text to display on the action bar.
  2. time (int, optional): The duration for the action bar to display in seconds. Set to 0 or nil to remove the action bar immediately.
  3. callback (function, optional): Function to execute when the action bar timer expires.
  4. startTime (int, optional): The start time of the action bar, defaults to the current time.
  5. finishTime (int, optional): The finish time of the action bar, defaults to startTime + time.

Example

player:setAction("Processing...", 10, function(p) print("Action completed for", p:Nick()) end)

playerMeta:stopAction

Description

Stops the action bar currently being displayed for the player.

Realm

Server

Example

player:stopAction()

playerMeta:playSound

Description

Plays a sound for the player.

Realm

Server

Parameters

  1. sound (String): The sound to play.
  2. volume (int, optional): The volume of the sound. Defaults to 75.
  3. pitch (int, optional): The pitch of the sound. Defaults to 100.
  4. shouldEmit (Boolean): Whether to emit the sound server-side (true) or send it to the client (false).

Example

player:playSound("ambient/alarms/warningbell1.wav", 100, 100, false)

playerMeta:openUI

Description

Opens a VGUI panel for the player.

Realm

Server

Parameters

  • panel (String): The name of the VGUI panel to open.

Example

player:openUI("InventoryPanel")

playerMeta:openPage

Description

Opens a web page for the player.

Realm

Server

Parameters

  • url (String): The URL of the web page to open.

Example

player:openPage("https://example.com")

playerMeta:requestDropdown

Description

Requests a dropdown selection from the player.

Realm

Shared

Parameters

  1. title (String): The title of the request.
  2. subTitle (String): The subtitle of the request.
  3. options (Table): The table of options to choose from.
  4. callback (function): The function to call upon receiving the selected option.

Example

player:requestDropdown("Choose Option", "Select one of the following:", {"Option1", "Option2"}, function(selected)
    print("Player selected:", selected)
end)

playerMeta:requestOptions

Description

Requests multiple options selection from the player.

Realm

Server

Parameters

  1. title (String): The title of the request.
  2. subTitle (String): The subtitle of the request.
  3. options (Table): The table of options to choose from.
  4. limit (int): The maximum number of selectable options.
  5. callback (function): The function to call upon receiving the selected options.

Example

player:requestOptions("Select Items", "Choose up to 3 items:", {"Item1", "Item2", "Item3"}, 3, function(selected)
    print("Player selected:", table.concat(selected, ", "))
end)

playerMeta:requestString

Description

Requests a string input from the player. Supports both callback and promise-based usage.

Realm

Server

Parameters

  1. title (String): The title of the string input dialog.
  2. subTitle (String): The subtitle or description of the string input dialog.
  3. callback (function, optional): The function to call with the entered string.
  4. default (String, optional): The default value for the string input.

Returns

  • Promise|nil: A promise object resolving with the entered string, or nil if a callback is provided.

Example

-- Using callback
player:requestString("Enter Name", "Please enter your name:", function(name)
    print("Player entered:", name)
end)

-- Using promise
local promise = player:requestString("Enter Name", "Please enter your name:", "DefaultName")
if promise then
    promise:next(function(name)
        print("Player entered:", name)
    end)
end

playerMeta:binaryQuestion

Description

Requests a binary choice from the player.

Realm

Server

Parameters

  1. question (String): The question to present to the player.
  2. option1 (String): The text for the first option.
  3. option2 (String): The text for the second option.
  4. manualDismiss (Boolean): Whether the notice should be manually dismissed.
  5. callback (function): The function to call with the choice (0 or 1) when the player selects an option.

Example

player:binaryQuestion("Confirm Action", "Yes", "No", false, function(choice)
    if choice == 0 then
        print("Player chose Yes.")
    else
        print("Player chose No.")
    end
end)

playerMeta:getPlayTime

Description

Retrieves the player's total playtime.

Realm

Server and Client

Returns

  • Float: The total playtime of the player in seconds.

Example

local playTime = player:getPlayTime()
print("Playtime:", playTime, "seconds")

playerMeta:createServerRagdoll

Description

Creates a ragdoll entity for the player on the server.

Realm

Server

Parameters

  • dontSetPlayer (Boolean): Determines whether to associate the player with the ragdoll.

Returns

  • Entity: The created ragdoll entity.

Example

local ragdoll = player:createServerRagdoll()

playerMeta:doStaredAction

Description

Performs a stared action towards an entity for a certain duration. Executes callbacks upon completion or cancellation.

Realm

Server

Parameters

  1. entity (Entity): The entity towards which the player performs the stared action.
  2. callback (function): The function to call when the stared action is completed.
  3. time (int, optional): The duration of the stared action in seconds. Defaults to 5.
  4. onCancel (function): The function to call if the stared action is canceled.
  5. distance (int, optional): The maximum distance for the stared action. Defaults to 96.

Example

player:doStaredAction(targetEntity, function()
    print("Stared action completed.")
end, 10, function()
    print("Stared action canceled.")
end, 150)

playerMeta:notify

Description

Notifies the player with a message using the Lilia notice system.

Realm

Server

Parameters

  • message (String): The message to notify the player.

Example

player:notify("You have received a new item!")

playerMeta:notifyLocalized

Description

Notifies the player with a localized message using the Lilia notice system.

Realm

Server

Parameters

  • message (String): The key of the localized message to notify the player.
  • ... (any): Additional arguments to format the localized message.

Example

player:notifyLocalized("welcome_message", player:Nick())

playerMeta:createRagdoll

Description

Creates a ragdoll entity for the player. Can optionally freeze the ragdoll initially.

Realm

Server

Parameters

  • freeze (Boolean): Whether to freeze the ragdoll initially.

Returns

  • Entity: The created ragdoll entity.

Example

local ragdoll = player:createRagdoll(true)

playerMeta:setRagdolled

Description

Sets the player to a ragdolled state or removes the ragdoll.

Realm

Server

Parameters

  1. state (Boolean): Whether to set the player to a ragdolled state (true) or remove the ragdoll (false).
  2. time (int, optional): The duration for which the player remains ragdolled.
  3. getUpGrace (int, optional): The grace period for the player to get up before the ragdoll is removed.
  4. getUpMessage (String, optional): The message displayed when the player is getting up. Defaults to "@wakingUp".

Example

player:setRagdolled(true, 10, 5, "@gettingUp")

playerMeta:syncVars

Description

Synchronizes networked variables with the player.

Realm

Server

Example

player:syncVars()

playerMeta:setLocalVar

Description

Sets a local variable for the player and synchronizes it over the network.

Realm

Server

Parameters

  1. key (String): The key of the variable.
  2. value (any): The value of the variable.

Example

player:setLocalVar("health", 100)

playerMeta:isFaction

Description

Checks if the player belongs to the specified faction.

Realm

Shared

Parameters

  • faction (String): The faction to check against.

Returns

  • Boolean: true if the player belongs to the specified faction, false otherwise.

Example

if player:isFaction("Police") then
    print("Player is in the Police faction.")
end

playerMeta:isClass

Description

Checks if the player belongs to the specified class.

Realm

Shared

Parameters

  • class (String): The class to check against.

Returns

  • Boolean: true if the player belongs to the specified class, false otherwise.

Example

if player:isClass("Medic") then
    print("Player is a Medic.")
end

playerMeta:getDarkRPVar

Description

Retrieves the player's DarkRP money. This is used as compatibility for DarkRP Vars.

Realm

Shared

Parameters

  • var (String): The DarkRP variable to fetch (only "money" is allowed).

Returns

  • Integer|nil: The player's money if the variable is valid, or nil if not.

Example

local money = player:getDarkRPVar("money")
if money then
    print("Player Money:", money)
end

playerMeta:getMoney

Description

Retrieves the amount of money owned by the player's character.

Realm

Shared

Returns

  • Integer: The amount of money owned by the player's character.

Example

local money = player:getMoney()
print("Player Money:", money)

playerMeta:canAfford

Description

Checks if the player's character can afford a specified amount of money. This function uses Lilia methods to determine if the player can afford the specified amount. It is designed to be compatible with the DarkRP canAfford method.

Realm

Shared

Parameters

  • amount (int): The amount of money to check.

Returns

  • Boolean: Whether the player's character can afford the specified amount of money.

Example

if player:canAfford(500) then
    print("Player can afford the item.")
else
    print("Player cannot afford the item.")
end

playerMeta:addMoney

Description

Adds money to the player's character. This function uses Lilia methods to add the specified amount of money to the player. It handles wallet limits and spawns excess money as an item in the world if necessary.

Realm

Server

Parameters

  • amount (int): The amount of money to add.

Returns

  • Boolean: true if the operation was successful, false otherwise.

Example

player:addMoney(1000)

playerMeta:takeMoney

Description

Takes money from the player's character.

Realm

Server

Parameters

  • amount (int): The amount of money to take.

Example

player:takeMoney(200)

playerMeta:hasSkillLevel

Description

Checks if the player has a skill level equal to or greater than the specified level.

Realm

Shared

Parameters

  1. skill (String): The skill to check.
  2. level (int): The required skill level.

Returns

  • Boolean: Whether the player's skill level meets or exceeds the specified level.

Example

if player:hasSkillLevel("Archery", 3) then
    print("Player has Archery level 3 or higher.")
end

playerMeta:meetsRequiredSkills

Description

Checks if the player meets the required skill levels.

Realm

Shared

Parameters

  • requiredSkillLevels (Table): A table containing the required skill levels.

Returns

  • Boolean: Whether the player meets all the required skill levels.

Example

local requiredSkills = {Archery = 2, Stealth = 3}
if player:meetsRequiredSkills(requiredSkills) then
    print("Player meets all required skills.")
else
    print("Player does not meet the required skills.")
end

playerMeta:restoreStamina

Description

Restores stamina for the player. This function restores a certain amount of stamina to the player, clamping the value between 0 and the character's maximum stamina. If stamina is restored above a certain threshold, it will trigger the removal of a breathless state.

Realm

Server

Parameters

  • amount (int): The amount of stamina to restore.

Example

player:restoreStamina(10)

playerMeta:consumeStamina

Description

Consumes stamina from the player. This function decreases the player's stamina by a specified amount, clamping the value between 0 and the character's maximum stamina. If stamina is depleted, it may trigger a breathless state.

Realm

Server

Parameters

  • amount (int): The amount of stamina to consume.

Example

player:consumeStamina(5)

playerMeta:CanEditVendor

Description

Determines if the player can edit a vendor. This function checks whether the player has the necessary privilege to edit vendors.

Realm

Shared

Returns

  • Boolean: true if the player has the privilege to edit vendors, false otherwise.

Example

if player:CanEditVendor() then
    print("Player can edit vendors.")
end

playerMeta:CanOverrideView

Description

Checks various conditions to determine if the player can switch to a third-person view.

Realm

Shared

Returns

  • Boolean: true if the player can override the view to third-person, false otherwise.

Example

if player:CanOverrideView() then
    print("Player can switch to third-person view.")
end

playerMeta:IsInThirdPerson

Description

Checks if the player is currently using third-person view. This function verifies if third-person mode is active for the player.

Realm

Client

Returns

  • Boolean: true if the player is in third-person view, false otherwise.

Example

if player:IsInThirdPerson() then
    print("Player is in third-person view.")
end

playerMeta:isUser

Description

Checks if the player belongs to the "user" user group.

Realm

Shared

Returns

  • Boolean: true if the player is in the "user" group, false otherwise.

Example

if player:isUser() then
    print("Player is a regular user.")
end

playerMeta:isStaff

Description

Checks if the player is a staff member.

Realm

Shared

Returns

  • Boolean: true if the player is a staff member, false otherwise.

Example

if player:isStaff() then
    print("Player is a staff member.")
end

playerMeta:isVIP

Description

Checks if the player is a VIP.

Realm

Shared

Returns

  • Boolean: true if the player is a VIP, false otherwise.

Example

if player:isVIP() then
    print("Player is a VIP.")
end

playerMeta:isStaffOnDuty

Description

Checks if the staff member is currently on duty (FACTION_STAFF).

Realm

Shared

Returns

  • Boolean: true if the staff member is currently on duty, false otherwise.

Example

if player:isStaffOnDuty() then
    print("Staff member is on duty.")
end

playerMeta:hasWhitelist

Description

Checks if the player has whitelisted access to a faction.

Realm

Shared

Parameters

  • faction (int): The faction to check for whitelisting.

Returns

  • Boolean: Whether the player has whitelisted access to the specified faction.

Example

if player:hasWhitelist(TEAM_POLICE) then
    print("Player has access to the Police faction.")
end

playerMeta:getClass

Description

Retrieves the class of the player's character.

Realm

Shared

Returns

  • String|nil: The class of the player's character, or nil if not found.

Example

local class = player:getClass()
if class then
    print("Player Class:", class)
end

playerMeta:hasClassWhitelist

Description

Checks if the player has whitelisted access to a class.

Realm

Shared

Parameters

  • class (int): The class to check for whitelisting.

Returns

  • Boolean: Whether the player has whitelisted access to the specified class.

Example

if player:hasClassWhitelist("Medic") then
    print("Player has access to the Medic class.")
end

playerMeta:getClassData

Description

Retrieves the data of the player's character class.

Realm

Shared

Returns

  • Table|nil: A table containing the data of the player's character class, or nil if not found.

Example

local classData = player:getClassData()
if classData then
    print("Player Class Data:", classData.name)
end

playerMeta:WhitelistAllClasses

Description

Whitelists all classes for the player.

Realm

  • Server

Example

player:WhitelistAllClasses()

playerMeta:WhitelistAllFactions

Description

Whitelists all factions for the player.

Realm

  • Server

Example

player:WhitelistAllFactions()

playerMeta:WhitelistEverything

Description

Whitelists everything (all classes and factions) for the player.

Realm

  • Server

Example

player:WhitelistEverything()

playerMeta:classWhitelist

Description

Whitelists the player for a specific class.

Realm

  • Server

Parameters

  • class (int): The class to whitelist the player for.

Example

player:classWhitelist("Medic")

playerMeta:classUnWhitelist

Description

Removes the whitelist status for a specific class from the player.

Realm

  • Server

Parameters

  • class (int): The class to remove the whitelist status for.

Example

player:classUnWhitelist("Medic")

playerMeta:setWhitelisted

Description

Sets whether the player is whitelisted for a faction.

Realm

Server

Parameters

  1. faction (int): The faction ID.
  2. whitelisted (bool): Whether the player should be whitelisted for the faction.

Returns

  • Boolean: Whether the operation was successful.

Example

player:setWhitelisted(TEAM_POLICE, true)

playerMeta:IsLiliaPersistent

Description

Checks if the entity is persistent. This function checks whether the entity is flagged as persistent.

Realm

Shared

Returns

  • Boolean: true if the entity is persistent, false otherwise.

Example

if entity:IsLiliaPersistent() then
    print("Entity is persistent.")
end