🔍 API Description
| API List | Description |
|---|---|
NWeather_GetDate() |
NWeather_GetDate() Returns the current in-game date. - date_str (string): Current date formatted as a readable string (example: 27, January 2025). Use case: Display the roleplay date in a HUD, journal, or immersive interface. Provided by: NWeather - Advanced Weather & Skybox addon |
NWeather_GetMoonphase() |
NWeather_GetMoonphase() Returns the current moon phase. - id (number): Numeric identifier of the moon phase. - name (string): Name of the moon phase (New Moon, First Quarter, Full Moon, Last Quarter, etc). Use case: Display the current moon phase as text or icon in a roleplay or immersive HUD. Provided by: NWeather - Advanced Weather & Skybox addon |
NWeather_GetSeason() |
NWeather_GetSeason() Returns the current season information. - id (number): Numeric identifier of the season. Example: 1 for Spring or 4 for Winter. - name (string): Name of the current season in English (Spring, Summer, Autumn, Winter). - icon (IMaterial): Graphical icon representing the season. Can be used with surface.SetMaterial in HUDs. Use case: Automatically display the icon and name of the current season in a custom GMod interface. Provided by: NWeather - Advanced Weather & Skybox addon |
NWeather_GetTemperature() |
NWeather_GetTemperature() Returns the current ambient temperature. - temperature (number): Temperature value in degrees Celsius. - display_format (string): Temperature formatted with unit (example: -3°C). Use case: Display the current temperature with visual effects based on the value. Provided by: NWeather - Advanced Weather & Skybox addon |
NWeather_GetTime() |
NWeather_GetTime() Returns the current in-game time managed by NWeather. - time (number): Internal numeric time value. - display_format (string): Readable formatted time for players (example: 08:01 AM). Use case: Synchronize a custom HUD or UI with the in-game time displayed by NWeather. Provided by: NWeather - Advanced Weather & Skybox addon |
NWeather_GetWeather() |
NWeather_GetWeather() Returns the current weather state. - id (number): Weather code identifier. Example: 4 for Cloudy. - name (string): Name of the current weather (Clear, Rain, Storm, Snow, Cloudy, etc). - icon (IMaterial): Graphical icon corresponding to the current weather. Use case: Integrate real-time weather data into a custom GMod weather HUD. Provided by: NWeather - Advanced Weather & Skybox addon |
NWeather_IsDay() |
NWeather_IsDay() Returns true during daytime and false during night. Can be used to branch gameplay or visuals depending on day/night state. Provided by: NWeather - Advanced Weather & Skybox addon |
player:IsBlacklisted() |
Player:IsBlacklisted(team_id) Check if the user is blacklisted for a job. Provided by: WJob - Whitelisting Job System 2 |
player:IsWhitelisted() |
Player:IsWhitelisted(team_id) Check if the user is whitelisted for a job. Provided by: WJob - Whitelisting Job System 2 |
player:WJobCheckAccess() |
Player:WJobCheckAccess(access_id) Check a user's permissions. Provided by: WJob - Whitelisting Job System 2 |
DarkRP.getCategories() |
DarkRP.getCategories(...) DarkRP alias referenced for compatibility checks. Used to retrieve job categories. Provided by: NJob - Job Creator and Editor |
DarkRP.getJobByCommand() |
DarkRP.getJobByCommand(...) DarkRP alias referenced for compatibility checks. Used to fetch job data from a command string. Provided by: NJob - Job Creator and Editor |
DarkRP.notify() |
DarkRP.notify(...) DarkRP alias referenced for compatibility checks. Used to send notifications to players. Provided by: NJob - Job Creator and Editor |
DarkRP.setPreferredJobModel() |
DarkRP.setPreferredJobModel(...) DarkRP alias referenced for compatibility checks. Used to set a preferred model for a job when integrating job systems. Provided by: NJob - Job Creator and Editor |
player:changeTeam() |
Player:changeTeam(...) DarkRP alias referenced for compatibility checks. Used to switch player job/team server-side. Provided by: NJob - Job Creator and Editor |
player:getDarkRPVar() |
Player:getDarkRPVar(key) DarkRP alias referenced for compatibility checks. Used to read DarkRP variables like money, salary, level. Provided by: NJob - Job Creator and Editor |
player:setDarkRPVar() |
Player:setDarkRPVar(key,value) DarkRP alias referenced for compatibility checks. Used to set DarkRP variables like money. Provided by: NJob - Job Creator and Editor |
player:addRKXP() |
Player:addRKXP(xp) Adds experience points for rank progression. Provided by: NRank - Advanced Customisable Ranking System |
player:DemotUserNRank() |
Player:DemotUserNRank() Allows demoting the user's rank. Provided by: NRank - Advanced Customisable Ranking System |
player:GetEXPNRank() |
Player:GetEXPNRank(xp) Returns the experience points needed to occupy a rank. Provided by: NRank - Advanced Customisable Ranking System |
player:GetMaxEXPNRank() |
Player:GetMaxEXPNRank() Returns the maximum experience threshold to reach for promotion to the next rank. Provided by: NRank - Advanced Customisable Ranking System |
player:GetNRankGroup() |
Player:GetNRankGroup() Returns the group name of a rank. Provided by: NRank - Advanced Customisable Ranking System |
player:GetNRankLvL() |
Player:GetNRankLvL() Returns the hierarchical level of a rank. Provided by: NRank - Advanced Customisable Ranking System |
player:GetNRankName() |
Player:GetNRankName() Returns the friendly name of a rank. Provided by: NRank - Advanced Customisable Ranking System |
player:GetNRankRank() |
Player:GetNRankRank() Returns the name of a rank. Used for indexing. Provided by: NRank - Advanced Customisable Ranking System |
player:NRankAutoAssign() |
Player:NRankAutoAssign() Allows assigning a rank randomly to a player. Provided by: NRank - Advanced Customisable Ranking System |
player:NRankIsAbove() |
Player:NRankIsAbove(rank) Checks if the rank is above. Provided by: NRank - Advanced Customisable Ranking System |
player:PromotUserNRank() |
Player:PromotUserNRank() Allows promoting the user's rank. Provided by: NRank - Advanced Customisable Ranking System |
player:SetEXPNRank() |
Player:SetEXPNRank(xp, bool) Sets the experience points of the occupied rank. Provided by: NRank - Advanced Customisable Ranking System |
player:SetUserNRank() |
Player:SetUserNRank(rank, save, by) Allows assigning a rank without condition. Provided by: NRank - Advanced Customisable Ranking System |
player:UserDemotUserNRank() |
Player:UserDemotUserNRank(target) Allows demoting a target (works if the required conditions are met). Provided by: NRank - Advanced Customisable Ranking System |
player:UserPromotUserNRank() |
Player:UserPromotUserNRank(target) Allows promoting a target (works if the required conditions are met). Provided by: NRank - Advanced Customisable Ranking System |
player:addFatigue() |
Player:addFatigue(add) Add and remove fatigue points. Works with positive and negative numeric values. (Server) Provided by: Fatigue mods + Sleep System |
player:Fatigue() |
Player:Fatigue() Returns the number of fatigue points of the user. (Client + Server) Provided by: Fatigue mods + Sleep System |
player:GetMaxFatigue() |
Player:GetMaxFatigue() Returns the maximum fatigue. (Client + Server) Provided by: Fatigue mods + Sleep System |
player:setFatigue() |
Player:setFatigue(add) Allows you to directly assign the number of karma points of the user. (Server) Provided by: Fatigue mods + Sleep System |
player:addRadiation() |
Player:addRadiation(add,text) Allows you to increase or decrease the player's radiation rate. (Server) Provided by: Radioactivity System + Radiation Zone |
player:GetMaxRadiation() |
Player:GetMaxRadiation() Returns the maximum limit that causes the character to die. (Client + Server) Provided by: Radioactivity System + Radiation Zone |
player:GetRadiation_Immun() |
Player:GetRadiation_Immun() Returns the player's cumulative radiation protection percentage: rank + job + playermodel. (Server) Provided by: Radioactivity System + Radiation Zone |
player:Radiation() |
Player:Radiation() Returns the user's radiation rate. (Client + Server) Provided by: Radioactivity System + Radiation Zone |
player:setRadiation() |
Player:setRadiation(add) Allows you to directly set the user's radiation rate. (Server) Provided by: Radioactivity System + Radiation Zone |
player:SetRadiation_Immun() |
Player:SetRadiation_Immun(value) Allows setting the user's radiation protection rate directly (rank/job/playermodel values are taken into account). (Server) Provided by: Radioactivity System + Radiation Zone |
player:addKarma() |
Player:addKarma(add,text) Adds or removes karma points (positive or negative numeric values). Server-side, optional text can be used for logs/notifications depending on implementation. Provided by: Karma + Reputation System |
player:GetKarmaRank() |
Player:GetKarmaRank() Returns the reputation title name corresponding to the player karma. Available on client and server. Provided by: Karma + Reputation System |
player:GetMaxKarma() |
Player:GetMaxKarma() Returns the maximum karma value configured for the system. Available on client and server. Provided by: Karma + Reputation System |
player:Karma() |
Player:Karma() Returns the current karma points of the player. Value is available on client and server. Provided by: Karma + Reputation System |
player:setKarma() |
Player:setKarma(value) Sets the exact karma points value for the player. Server-side setter. Provided by: Karma + Reputation System |
player:TradeRequest() |
Player:TradeRequest(player2) Allows player1 to send a request to player2. Provided by: Items Trading and Selling System |
player:AddInPocket() |
Player:AddInPocket(ent,quantity) Store an existing entity on the gmod server map. Provided by: Pocket System without DarkRP |
player:DropFromPocket() |
Player:DropFromPocket(id) Drop an item stored in the pocket. Provided by: Pocket System without DarkRP |
player:GetMaxPocket() |
Player:GetMaxPocket() Returns the max storage capacity in the pocket. The max capacity is defined in the configuration file by the variable: cfg.Pocket_max. Provided by: Pocket System without DarkRP |
player:GetPocketItems() |
Player:GetPocketItems() Return the table of the list of objects stored in the pocket. Provided by: Pocket System without DarkRP |
player:SavePocket() |
Player:SavePocket() Force save the pocket. Provided by: Pocket System without DarkRP |
player:StoreInPocket() |
Player:StoreInPocket(class,qt,mdl,clip2) Allows to store an entity with only the class name of that one. Provided by: Pocket System without DarkRP |
player:addItem() |
Player:addItem(entity , number quantity) Store an entity that exists on the map and delete it when it is stored. Provided by: Advanced Inventory System |
player:addMaxInventory() |
Player:addMaxInventory(number quantity , bolean save) Upgrade the user's inventory. Provided by: Advanced Inventory System |
player:GetItem() |
Player:GetItem("item_class") Returns the quantity of a type of object stored in all slots (item_class = is the class name of the entity). Provided by: Advanced Inventory System |
player:GetItems() |
Player:GetItems() Return table of items stored in the inventory of the users. Provided by: Advanced Inventory System |
player:GetMaxInventory() |
Player:GetMaxInventory() Allows to know the maximum capacity of the player's inventory. Provided by: Advanced Inventory System |
player:Inventory_Slot() |
Player:Inventory_Slot() Allows to know the number of slots in the occupied inventory. Provided by: Advanced Inventory System |
player:SetInventorySlot() |
Player:SetInventorySlot(slot) Assigns the inventory slot identifier for the player (multi-character support). Call it after character selection and before the real spawn so the inventory loads and saves on the correct character slot. Provided by: Advanced Inventory System |
player:setMaxInventory() |
Player:setMaxInventory(number quantity , bolean save) Set the user's max inventory. Provided by: Advanced Inventory System |
player:storeItem() |
Player:storeItem(class , quantity or clip1 , model path , clip2 or nil) Store an entity that doesn't exist on the map by its class name. Provided by: Advanced Inventory System |
player:addMana() |
Player:addMana(amount) Adds or removes mana points. Positive values add mana, negative values remove mana (example: -20 when casting a spell). Provided by: Mana System + HUD Creator |
player:addMaxMana() |
Player:addMaxMana(amount) Adds or removes maximum mana points (mana cap). Useful for upgrade or downgrade entities/items. Provided by: Mana System + HUD Creator |
player:GetMaxMana() |
Player:GetMaxMana() Returns the maximum mana points (mana cap) for the player. Provided by: Mana System + HUD Creator |
player:Mana() |
Player:Mana() Returns the current mana points of the player. Use it to check if the player has enough mana to cast a spell or use a magic weapon. Value available on client and server. Provided by: Mana System + HUD Creator |
player:setMana() |
Player:setMana(value) Sets the player mana points to an exact value. Provided by: Mana System + HUD Creator |
player:setMaxMana() |
Player:setMaxMana(value) Sets the player maximum mana points (mana cap) to an exact value. By default the max mana is capped (configurable). Provided by: Mana System + HUD Creator |
player:addHunger() |
Player:addHunger(amount) Adds or removes hunger points from the player. Positive values increase hunger, negative values decrease hunger. Never goes below 0. Provided by: Hunger Mod + Customizable HUD |
player:addMaxHunger() |
Player:addMaxHunger(amount) Adds or removes the maximum hunger cap. Useful for items or progression effects affecting hunger capacity. Provided by: Hunger Mod + Customizable HUD |
player:addMaxThirst() |
Player:addMaxThirst(amount) Adds or removes the maximum thirst cap. Useful for items or progression effects affecting thirst capacity. Provided by: Hunger Mod + Customizable HUD |
player:addThirst() |
Player:addThirst(amount) Adds or removes thirst points from the player. Positive values increase thirst, negative values decrease thirst. Never goes below 0. Provided by: Hunger Mod + Customizable HUD |
player:GetMaxHunger() |
Player:GetMaxHunger() Returns the maximum hunger points the player can have (hunger cap). Provided by: Hunger Mod + Customizable HUD |
player:GetMaxThirst() |
Player:GetMaxThirst() Returns the maximum thirst points the player can have (thirst cap). Provided by: Hunger Mod + Customizable HUD |
player:GetThirst() |
Player:GetThirst() Returns the current thirst points of the player. Similar to hunger, thirst regulates the players need for water. Provided by: Hunger Mod + Customizable HUD |
player:Hunger() |
Player:Hunger() Returns the current hunger points of the player. Value available on both client and server. Use to determine how hungry the player is at any time. Provided by: Hunger Mod + Customizable HUD |
player:setHunger() |
Player:setHunger(value) Sets the player hunger points to an exact numeric value. Provided by: Hunger Mod + Customizable HUD |
player:setMaxHunger() |
Player:setMaxHunger(value) Sets the player maximum hunger points (hunger cap) to a specific value. Provided by: Hunger Mod + Customizable HUD |
player:setMaxThirst() |
Player:setMaxThirst(value) Sets the player maximum thirst points (thirst cap) to a specific value. Provided by: Hunger Mod + Customizable HUD |
player:setThirst() |
Player:setThirst(value) Sets the player thirst points to an exact numeric value. Provided by: Hunger Mod + Customizable HUD |
player:addMaxStamina() |
Player:addMaxStamina(amount) Adds or removes maximum stamina points (stamina cap). Useful for upgrade or downgrade items. Provided by: Stamina System + Editable HUD |
player:addStamina() |
Player:addStamina(amount) Adds or removes stamina points. Positive values add stamina, negative values remove stamina. Stamina cannot go below 0. Provided by: Stamina System + Editable HUD |
player:GetMaxStamina() |
Player:GetMaxStamina() Returns the maximum stamina points (stamina cap) of the player. Provided by: Stamina System + Editable HUD |
player:setMaxStamina() |
Player:setMaxStamina(value) Sets the player maximum stamina points (stamina cap) to an exact value. Provided by: Stamina System + Editable HUD |
player:setStamina() |
Player:setStamina(value) Sets the player stamina points to an exact value. Provided by: Stamina System + Editable HUD |
player:Stamina() |
Player:Stamina() Returns the current stamina points of the player. Use it to restrict actions (melee, sprint, jump) when the player is out of breath. Value available on client and server. Provided by: Stamina System + Editable HUD |
player:addArmor() |
player:addArmor(number) Adds (or removes if negative) armor points to the player. Armor will not go below 0 nor above max armor. Provided by: Health Modules + HUD Editor |
player:addHealth() |
player:addHealth(number) Adds (or removes if negative) health points to the player. Can be used in custom entities that grant health or in admin tools. Provided by: Health Modules + HUD Editor |
player:addMaxArmor() |
player:addMaxArmor(number) Adds (or removes if negative) to the maximum armor limit of the player. Server-side only. Provided by: Health Modules + HUD Editor |
player:addMaxHealth() |
player:addMaxHealth(number) Adds (or removes if negative) to the maximum health limit of the player. Server-side only. Provided by: Health Modules + HUD Editor |
player:GetMaxArmor() |
player:GetMaxArmor() Returns the current maximum armor points of the player. Useful for HUD display or server logic involving armor limits. Provided by: Health Modules + HUD Editor |
player:GetMaxHealth() |
player:GetMaxHealth() Returns the current maximum health points of the player. Useful when creating custom HUDs or game logic that depends on max health. Provided by: Health Modules + HUD Editor |
player:setArmor() |
player:setArmor(number) Sets the armor points of the player to an exact value. Server-side only. Provided by: Health Modules + HUD Editor |
player:setHealth() |
player:setHealth(number) Sets the health points of the player to an exact value. Useful for scripted effects or admin commands. Provided by: Health Modules + HUD Editor |
player:setMaxArmor() |
player:setMaxArmor(number) Sets the maximum armor limit for the player to an exact value. Server-side only. Provided by: Health Modules + HUD Editor |
player:setMaxHealth() |
player:setMaxHealth(number) Sets the maximum health limit for the player to an exact value. Server-side only. Provided by: Health Modules + HUD Editor |
player:AddCredit() |
Player:AddCredit(number, msg) Gives credits to a user. A negative number will deduct credits. Provided by: NPC Reward Manager |
player:Credit() |
Player:Credit() Returns the user's credit count. Provided by: NPC Reward Manager |
player:SetCredit() |
Player:SetCredit(number, msg) Sets the credit count. Provided by: NPC Reward Manager |
player:addLevels() |
Player:addLevels(lvl) No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:addXP() |
Player:addXP(xp) No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:getLevel() |
Player:getLevel() No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:getMaxXP() |
Player:getMaxXP() No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:getXP() |
Player:getXP() No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:hasLevel() |
Player:hasLevel(level) No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:setLevel() |
Player:setLevel(lvl,save) No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:setXP() |
Player:setXP(xp) No description provided in the product documentation. Provided by: Leveling System - XP, Levels, Progression |
player:addMoney() |
Player:addMoney(money_amount) Adds (or removes if negative) money to the player balance. Server-side money mutation helper for DarkRP compatibility. Provided by: Store Builder - Create your in-game store |
player:getCredit() |
Player:getCredit() Returns the current premium currency (credit) amount for the player. Implemented for standalone usage without DarkRP. Provided by: Store Builder - Create your in-game store |
player:getMoney() |
Player:getMoney() Returns the current money amount for the player. Provided to keep compatibility with DarkRP-like scripts even when DarkRP is not installed. Provided by: Store Builder - Create your in-game store |
player:setMoney() |
Player:setMoney(money_amount) Sets the player money balance to an exact value. Server-side money setter for DarkRP compatibility. Provided by: Store Builder - Create your in-game store |
player:CheckUserAccess() |
Player:CheckUserAccess(unique_id) Checks if the player rank has a specific access enabled for the given unique_id (example: access_superadmin). Designed to let custom ranks inherit granular powers. Provided by: Nor Admin Mod for GMod - Administration System |
player:GetUserGroup() |
Player:GetUserGroup() Returns the player current rank identifier (usergroup). Used by the access system and compatible with common GMod standards. Provided by: Nor Admin Mod for GMod - Administration System |
player:IsAbove() |
Player:IsAbove(player2) Returns true if the player rank hierarchy is above player2 (example: a moderator is not above an admin). Used to prevent lower staff from acting on higher staff. Provided by: Nor Admin Mod for GMod - Administration System |
player:IsAdmin() |
Player:IsAdmin() Returns true if the player is admin, or if the access system grants an equivalent right (for example access_admin enabled for the player rank). Provided by: Nor Admin Mod for GMod - Administration System |
player:IsModerator() |
Player:IsModerator() Returns true if the player has moderator-level access according to the rank/access configuration. Provided by: Nor Admin Mod for GMod - Administration System |
player:IsSuperAdmin() |
Player:IsSuperAdmin() Returns true if the player is superadmin, or if the access system grants an equivalent right (for example access_superadmin enabled for the player rank). Provided by: Nor Admin Mod for GMod - Administration System |
player:IsUserGroup() |
Player:IsUserGroup(name) Returns true if the player rank equals the provided name, otherwise false. Provided by: Nor Admin Mod for GMod - Administration System |
player:SetUserGroup() |
Player:SetUserGroup(str) Changes the player rank identifier (usergroup). Server-side rank mutation. Provided by: Nor Admin Mod for GMod - Administration System |
API_Whitelistjob_nordahl() |
API_Whitelistjob_nordahl(ply,job_name,category_name) Checks whether a player is allowed for a job/category according to the whitelist and donator rules. Returns true if the job is accepted, otherwise returns false and the player can be notified depending on configuration. Provided by: Job Whitelist system - DarkRP |
🔌 API Reference
Player (109)
AddCredit
addFatigue
addHealth
addHunger
AddInPocket
addItem
addKarma
addLevels
addMana
addMaxArmor
addMaxHealth
addMaxHunger
addMaxInventory
addMaxMana
addMaxStamina
addMaxThirst
addMoney
addRadiation
addRKXP
addStamina
addThirst
addXP
changeTeam
CheckUserAccess
Credit
DemotUserNRank
DropFromPocket
Fatigue
getCredit
getDarkRPVar
GetEXPNRank
GetItem
GetItems
GetKarmaRank
getLevel
GetMaxArmor
GetMaxEXPNRank
GetMaxFatigue
GetMaxHealth
GetMaxHunger
GetMaxInventory
GetMaxKarma
GetMaxMana
GetMaxPocket
GetMaxRadiation
GetMaxStamina
GetMaxThirst
getMaxXP
getMoney
GetNRankGroup
GetNRankLvL
GetNRankName
GetNRankRank
GetPocketItems
GetRadiation_Immun
GetThirst
GetUserGroup
getXP
hasLevel
Hunger
Inventory_Slot
IsAbove
IsAdmin
IsBlacklisted
IsModerator
IsSuperAdmin
IsUserGroup
IsWhitelisted
Karma
Mana
NRankAutoAssign
NRankIsAbove
PromotUserNRank
Radiation
SavePocket
setArmor
SetCredit
setDarkRPVar
SetEXPNRank
setFatigue
setHealth
setHunger
SetInventorySlot
setKarma
setLevel
setMana
setMaxArmor
setMaxHealth
setMaxHunger
setMaxInventory
setMaxMana
setMaxStamina
setMaxThirst
setMoney
setRadiation
SetRadiation_Immun
setStamina
setThirst
SetUserGroup
SetUserNRank
setXP
Stamina
StoreInPocket
storeItem
TradeRequest
UserDemotUserNRank
UserPromotUserNRank
WJobCheckAccess