Player

Shared Player Metafunctions.

Functions

Sharedcityrp.player.DebugListRanks() → RankPreviewEntry[]Source ☍

TEMPORARY (beta only) — enumerates every configured rank for the !previewrankcolours QA command in the beta plugin. rankdata is local to this file, so this is the only way for that command to see it. Delete this alongside the command once the rank colour rollout is confirmed.

Returns

RankPreviewEntry[]Every rank, ordered by rank order.

ServerPlayer:ApplySpawnModel()Source ☍

Puts a player in the model a spawn gives them: their F1 pick, or the model they last wore on this job, or their job's default.

ServerPlayer:Arrest(boolean, reset)Source ☍

Arrest or unarrest a player.

Parameters

booleanbooleanIf the player should be arrested or unarrested.
resetbooleanIf the player's status should be reset.

SharedPlayer:Arrested() → boolean|nilSource ☍

Check if a player is arrested.

Returns

boolean|nilcurrent arrest state.

ServerPlayer:BlacklistWarning(access, warning)Source ☍

Notifies the player that they are blacklisted from something, using a friendly access name and remaining time.

Parameters

accessstringThe access tag they are blacklisted from.
warningstring?Text describing what they're blacklisted from. Defaults to the access's friendly name, or the raw access tag if unnamed.

ServerPlayer:Bleed(boolean, seconds)Source ☍

Make a player bleed or stop them from bleeding.

Parameters

booleanbooleanIf they should start bleeding.
secondsnumberHow long they should bleed for.

ServerPlayer:BleedOutWithoutRagdoll()Source ☍

End a fatal injury whose ragdoll has been removed by killing the player as a bleed-out. With no body there is nothing left to tick, tap out of or revive, and waking them would be a free revive.

ServerPlayer:Blind(bool)Source ☍

Manage a players blindfolded state.

Parameters

boolbooleanIf the player should be blindfolded or unblindfolded.

SharedPlayer:Blindfolded() → boolean|nilSource ☍

Check if a player is blindfolded.

Returns

boolean|nilcurrent blindfold state.

SharedPlayer:CanAccessPoliceDB() → booleanSource ☍

Check if a player can access the police database.

Returns

booleanthe player can access the police database.

ServerPlayer:CanAfford(amt) → booleanSource ☍

Check if a player can afford an amount of money.

Parameters

amtnumberThe money to check against.

Returns

booleanthe player can afford the amount.

SharedPlayer:CanBeDisarmed() → boolean, string|nilSource ☍

Check whether a player can disarm without breaking restraint holster state. Restrained, arrested, unconscious, and injured players already have weapons holstered (or confiscated) and must not go through HolsterAll(false, true) again.

Returns

1boolean
2string|nilMachine-readable reason when false.

ServerPlayer:CancelTranq()Source ☍

End a tranquilliser dart's drowsy spell before it knocks the player out, cancelling the pending knockout and fading the blur. Safe to call when no dart is pending.

SharedPlayer:CanGoUndercover() → booleanSource ☍

Check if a player can go undercover, hiding their staff identity behind a fake name.

Returns

booleanIf the player can go undercover.

SharedPlayer:CanNoclip() → boolean, booleanSource ☍

Check if a player can enter noclip on the noclip key, and whether it is echoed to staff. The echo case mirrors !noclip's access letter - (admin plugin); change the two together.

Returns

1booleanIf the player can enter noclip.
2booleanIf entering noclip must post the !noclip echo.

SharedPlayer:CanRecieveCriminalHints() → booleanSource ☍

Check if a player can receive criminal hints (such as lock-picking lockers)..

Returns

booleanIf the player can receive criminal hints..

SharedPlayer:CanSelfSubmaterial() → booleanSource ☍

Check if a player may set submaterials on themself, the self-target fallback rule for tools that otherwise operate on aimed entities.

Returns

booleanIf the player can set their own submaterials.

SharedPlayer:CanSendPopupNotification(globally) → booleanSource ☍

Check if a staff member can send a popup notification.

Parameters

globallyboolean?If the notification should be sent globally.

Returns

booleanIf the staff member can send the notification.

SharedPlayer:CanStaffChat() → booleanSource ☍

Check if a player can view staff chat.

Returns

booleanIf the player can use staff chat.

ServerPlayer:ChangeModel(model, concom, postChange) → booleanSource ☍

Change the model of a player.

Parameters

modelstringModel to change to.
concomstringEmote to use after changing.
postChangefunctionHook function called after the change has happened.

Returns

boolean

ServerPlayer:ChangeSkin(skin, concom, nomodelchange) → booleanSource ☍

Change the player's active skin.

Parameters

skinnumberSkin index to change to.
concomstringEmote to use after changing.
nomodelchangebooleanArgument set if the function is called in isolation (without ChangeModel).

Returns

boolean

ServerPlayer:ChatPrintF(_)Source ☍

Add a chat print message which has been passed through string.format. See: string.format

Parameters

SharedPlayer:Clan() → stringSource ☍

Get a player's clan name and rank combined.

Returns

stringcurrent clan name and rank (e.g., "[Leader] Gang Name").

SharedPlayer:ClanID() → numberSource ☍

Get a player's clan ID.

Returns

numbercurrent clan ID, or 0 if not in a clan.

SharedPlayer:ClanName() → stringSource ☍

Get a player's clan name.

Returns

stringcurrent clan name.

ServerPlayer:ClearFatalInjury()Source ☍

End a player's fatal injury. The only code that does, so every revive and respawn leaves the same state behind: the injured, can-die and stabilised flags cleared, and the bleed-out timer and CPR's stabilised window stopped. Health, bullet wounds and waking the player are left to the caller.

ServerPlayer:ConfiscateMarkedWeapons() → tableSource ☍

Removes only the holstered weapons an officer has marked for confiscation from inventory (leaving unmarked weapons recoverable), then clears the holstered/marked weapon lists and notifies the player what was taken. Used on arrest instead of a blanket RemoveHolstered() so restrained players only lose weapons an LEO chose to confiscate via the search menu. Each confiscation is admin-logged against the officer who marked it (not necessarily whoever performs the arrest).

Returns

tabledisplay names of the items that were confiscated.

SharedPlayer:Cuffed() → boolean|nilSource ☍

Check if a player is cuffed.

Returns

boolean|nilcurrent cuff state.

ServerPlayer:Demote()Source ☍

Demote a player from their current team, leaving them nothing their old job gave them.

SharedPlayer:Description() → string|nilSource ☍

Get a player's custom description.

Returns

string|nil

ServerPlayer:DisableEventMgr()Source ☍

Disables Event Manager permissions for player.

ServerPlayer:Disarm(emote) → boolean, string|nilSource ☍

Immediately holster weapons and remove modifications.

Parameters

emoteboolean?If true, broadcast a /me disarm emote.

Returns

1booleanTrue when the player was disarmed.
2string|nilMachine-readable reason when disarmed is false.

ServerPlayer:DoorAccess(door) → booleanSource ☍

Check if a player has access to lock a door.

Parameters

doorEntityDoor to be checked.

Returns

booleanthe player is allowed access to the door.

ServerPlayer:Emote(text)Source ☍

Send a message as an action performed by the player.

Parameters

textstringThe message to send.

ServerPlayer:EnableEventMgr()Source ☍

Enables Event Manager permissions for player.

ServerPlayer:EnvironmentalEmote(text)Source ☍

Send a message as an environmental action around a player. Essentially /it.

Parameters

textstringThe message to send.

SharedPlayer:EventMgr() → booleanSource ☍

Check if the player has Event Manager permissions.

Returns

booleanif the player has Event Manager permissions.

ServerPlayer:FinishHolster(weapon)Source ☍

Finishes a /holster once its wait is up: the weapon is taken out of their hands, if they are still holding it.

Parameters

weaponWeaponThe weapon being holstered.

SharedPlayer:Frozen() → boolean|nilSource ☍

Check if a player is frozen or physgun-frozen.

Returns

boolean|nilcurrent freeze state.

SharedPlayer:Gagged() → boolean|nilSource ☍

Check if a player is gagged.

Returns

boolean|nilcurrent gag state.

SharedPlayer:GenderWord() → stringSource ☍

Return the appropriate possessive pronoun for the player's gender.

Returns

string"his" for male, "her" for female.

SharedPlayer:GetAgendaGroup() → boolean|stringSource ☍

Get the agenda group the player is in.

Returns

boolean|stringagenda group (e.g., "president", "police"), or false if none.

SharedPlayer:GetAgendaLeader() → boolean|stringSource ☍

Get the agenda group the player leads. Only returns a value for leader positions (e.g., President, SWAT Leader, Police Commander).

Returns

boolean|stringagenda group the player leads, or false if none.

ServerPlayer:GetDefaultModel() → stringSource ☍

Get a player's default (team) model. Jobs whose model list has citizen models merged in via ApplyCitizenModels (Mafia, Rebel, Anarchist) roll one of their own unique models here rather than a citizen one; the citizen models are still manually selectable via the F1 menu. An Assistant+ default model list (core/plugins/teamname) short-circuits this, citizen pool included, and picks randomly among multiple configured models.

Returns

stringpath.

SharedPlayer:GetFace() → number|nilSource ☍

Get the current face ID of the player. Extracts the face ID from the player's model path if applicable.

Returns

number|nilface ID, or nil if the model doesn't have a face ID.

ServerPlayer:GetHoursPropLimitBonus() → numberSource ☍

This player's playtime prop limit bonus, 0 until they cross the configured hours threshold.

Returns

number

SharedPlayer:GetIcon() → stringSource ☍

Get the rank icon path for a player.

Returns

stringrank icon file path.

SharedPlayer:GetIconMaterial() → IMaterialSource ☍

Get the rank material for a player. Client-side only. Returns a cached material object for rendering.

Returns

IMaterialrank icon material.

SharedPlayer:GetIconReplacement() → stringSource ☍

Get the rank icon's textual replacement for a player. Returns an ASCII/symbol representation of the rank icon for use in text chat.

Returns

stringtextual replacement (e.g., "^", "*", ":)").

SharedPlayer:GetInjuryState(hpOverride) → numberSource ☍

Get the player's injury state based on current HP and injured status. Possible states:

0: Uninjured
1: Injured (HP > 70)
2: Seriously Injured (HP > 40)
3: Mortally Wounded (HP > 5)
4: Cardiac Arrest (HP <= 5) ragdolled player should pass the ragdoll's networked health, since the underlying player entity's own Health() can lag for bystanders while it sits in observer mode (issue #1374).

Parameters

hpOverridenumber|nilHP value to use instead of self:Health(). Callers displaying a

Returns

numbercurrent injury state (0-4).

ServerPlayer:GetInvAmount(item, meta) → numberSource ☍

Get the amount of a given item and meta combination in a player's inventory.

Parameters

itemstringItem Name.
metastringMeta Value.

Returns

numberamount of the item in the inventory.

SharedPlayer:getLocation() → stringSource ☍

Get the current location of the player. Returns "*** Unknown ***" if the player is blindfolded or in certain vehicles.

Returns

stringplayer's location name.

ServerPlayer:GetMember() → booleanSource ☍

Check if a player has been granted Member entitlement (independent of whether they're wearing the tag).

Returns

booleanif the player holds the Member flag.

ServerPlayer:GetMemberPropLimitBonus() → numberSource ☍

This player's membership prop limit bonus, 0 if they're not a member.

Returns

number

SharedPlayer:GetNetMember() → booleanSource ☍

Get the networked Member state. This is the networked sync of GetMember() (entitlement), not the final IsMember() value.

Returns

booleanif the player is currently networked as entitled to Member status.

ClientPlayer:GetNSVar(name, default) → anySource ☍

Get a player's NSVar with given name.

Parameters

namestringName of the NSVar to get.
defaultanyDefault value if the NSVar isn't set.

Returns

anyThe value of the NSVar, or the default value.

ServerPlayer:GetNSVar(name, default) → anySource ☍

Get an authoritative NSVar value from a player.

Parameters

namestringThe NSVar name to read.
defaultanyValue returned when the NSVar is unset.

Returns

anyThe stored value, or default.

SharedPlayer:GetPlayerChatColour() → tableSource ☍

Get the player's chat color. Alias for GetRankColor().

Returns

tableplayer's chat color as a Color object.

SharedPlayer:GetPropLimit() → numberSource ☍

Get the player's prop limit. The resolved value of the proplimit layer stack; see cityrp.limits.

Returns

numberprop limit for this player, or -1 if they have none.

SharedPlayer:GetRankColor() → tableSource ☍

Get the color for a given player's rank.

Returns

tablerank color as a Color object.

SharedPlayer:GetRankKey() → stringSource ☍

Determine the rank key for a player. Returns the staff rank if applicable, or membership tier based on spending level.

Returns

stringrank key (e.g., "admin", "diamondmember", "default").

SharedPlayer:GetRankName() → stringSource ☍

Get the name of a given player's rank.

Returns

stringrank display name (e.g., "Administrator", "Moderator").

ServerPlayer:GetRankPropLimit() → numberSource ☍

This player's base prop limit for their staff rank. -1 for unlimited.

Returns

number

SharedPlayer:GetRankSortOrder() → numberSource ☍

Get the sort order for a given player's rank. Lower numbers indicate higher priority/importance.

Returns

numbersort order (1 for owner, higher for lower ranks).

ServerPlayer:GetRepPropLimitBonus() → numberSource ☍

This player's REP prop limit bonus (a fixed amount per REP earned).

Returns

number

SharedPlayer:GetSVRank() → stringSource ☍

Get the player's staff rank. On server, this always returns the true value (if the player has had their data loaded from the database), unless stream override is enabled. On client, this returns a value based on the true value, current rank, and hidden state.

Returns

stringuser's current rank (e.g., "owner", "admin", "moderator", "user").

SharedPlayer:getTeamGroup() → "ADMINISTRATION"|"GOVERNMENT"|"LAWENFORCEMENT"|"MAFIA"|"POLICE"...(+6)Source ☍

Get the current team group the player is in. If there are multiple matches, the first one defined in the TEAMGROUPS table will be used.

groupname:
    | "GOVERNMENT"
    | "PRESIDENT"
    | "SECRET_SERVICE"
    | "ADMINISTRATION"
    | "LAWENFORCEMENT"
    | "SWAT"
    | "POLICE"
    | "RESCUE"
    | "REBELS"
    | "MAFIA"

Returns

"ADMINISTRATION"|"GOVERNMENT"|"LAWENFORCEMENT"|"MAFIA"|"POLICE"...(+6)The group name the player is in, or nil if not in any group.

ServerPlayer:GiveDoor(door, name, unsellable, lock)Source ☍

Give a door to a player.

Parameters

doorEntityThe door entity to give.
namestringThe name of the door to set.
unsellablebooleanIf the door should be set to be unsellable.
lockbooleanIf the door should spawn locked.

ServerPlayer:GiveMoney(amt)Source ☍

Give a player an amount of money.

Parameters

amtnumberThe amount of money to give.

ServerPlayer:GodClear()Source ☍

Turn god mode off outright, whatever is holding it. For staff explicitly disabling it.

ServerPlayer:GodDisable(source)Source ☍

Withdraw one source's god mode. The player stays godded while any other source still holds it.

Parameters

sourcestring?The source passed to GodEnable; defaults to "manual".

ServerPlayer:GodEnable(source)Source ☍

Enable god mode for a player on behalf of one source.

Parameters

sourcestring?What is granting it; defaults to "manual" (staff toggling it directly).

SharedPlayer:HasGodMode() → booleanSource ☍

Check if a player has god mode enabled.

Returns

booleanif the player has god mode enabled.

ServerPlayer:HasHolsteredWeapons() → booleanSource ☍

Check if a player has any holstered weapons.

Returns

boolean

SharedPlayer:HasMembership() → booleanSource ☍

Check if the player currently has active membership.

Returns

booleanif the player has active membership.

SharedPlayer:HasMemberTags() → booleanSource ☍

Check if the player's name contains the community Member tag. Kept separate from HasTags(), which is for staff tags only. Shared, pure Nick() check.

Returns

booleanif the player is wearing the Member tag.

SharedPlayer:HasTags() → booleanSource ☍

Check if the player's name contains appropriate rank tags. Checks for configured Admin and Moderator tags in the player's nickname.

Returns

booleanif the player has appropriate rank tags in their name.

ServerPlayer:HolsterAll(invrem, tablerem)Source ☍

Holsters all of a player's weapons.

Parameters

invrembooleanIf the items should also be removed from the inventory.
tablerembooleanIf the items should not be put in holstered tables.

ServerPlayer:HolsterSelfHolstering()Source ☍

Lets each held weapon that handles being holstered itself do so, before a strip takes it. Such a weapon is not an item, so nothing goes back to the inventory: the bought breach's SWEP and its placed charges go.

SharedPlayer:Hostaged() → boolean|nilSource ☍

Check if a player is hostaged.

Returns

boolean|nilcurrent hostage state.

ServerPlayer:Injure(attacker, damageInfo)Source ☍

Injure a player.

Parameters

attackerany
damageInfoany

SharedPlayer:Injured() → boolean|nilSource ☍

Check if a player is injured.

Returns

boolean|nilcurrent injury state.

ServerPlayer:InjuryTick(attacker)Source ☍

Deal a downed player's 1 HP injury tick, flagged so a lethal tick credits whoever last hurt the body.

Parameters

attackerEntity?Whoever originally injured the player.

SharedPlayer:IsActualPresident() → booleanSource ☍

Check if player is the President. Unlike IsPresident(), this returns true only for the President, not the VP.

Returns

booleanif the player is the President.

SharedPlayer:IsAdmin() → booleanSource ☍

Check if the player has Administrative permissions. Includes: Developer permissions, Super Admin permissions, or Admin rank.

Returns

booleanif the player has Administrative permissions.

SharedPlayer:IsAnarchist() → booleanSource ☍

Check if player is an Anarchist.

Returns

booleanif the player is an Anarchist.

SharedPlayer:IsArmsDealer() → booleanSource ☍

Check if player is a gun dealer.

Returns

booleanif the player is a gun dealer.

SharedPlayer:IsAssistant(strict) → booleanSource ☍

Check if the player has Assistant permissions. Includes: Trial Mod permissions, or assistant rank. In non-strict mode, also includes Developer Only permissions. In strict mode, Developer Only permissions are only included if the player also has Event Manager permissions.

Parameters

strictboolean|nilIf true, enables strict checking for REP validation.

Returns

booleanif the player has Assistant permissions.

SharedPlayer:IsBlackmarketDealer() → booleanSource ☍

Check if player is a Black Market Dealer.

Returns

booleanif the player is a Black Market Dealer.

SharedPlayer:IsBusinessAdvisor() → booleanSource ☍

Check if the player is a business advisor.

Returns

booleanif the player has the business advisor rank.

SharedPlayer:IsChauffeur() → booleanSource ☍

Check if player is a taxi driver.

Returns

booleanif the player is a taxi driver.

SharedPlayer:IsChef() → booleanSource ☍

Check if player is a Chef.

Returns

booleanif the player is a Chef.

SharedPlayer:IsContributor() → booleanSource ☍

Check if the player has Contributor permissions. Includes: Developer Only permissions or contributor rank.

Returns

booleanif the player has Contributor permissions.

SharedPlayer:IsCore() → booleanSource ☍

Check if the player is a core team member. Includes: core rank, coremanager rank, business advisor, security officer, or owner.

Returns

booleanif the player is a core team member.

SharedPlayer:IsDeveloper() → booleanSource ☍

Check if the player has Developer permissions. Includes: Super Developer permissions or Developer rank.

Returns

booleanif the player has Developer permissions.

SharedPlayer:IsDeveloperOnly() → booleanSource ☍

Check if the player has Developer Only permissions. Includes: Trial Dev Mod permissions or developeronly rank.

Returns

booleanif the player has Developer Only permissions.

SharedPlayer:IsDevMod() → booleanSource ☍

Check if the player has Developer Moderator permissions. Includes: Dev Mod 2 permissions or developermod rank.

Returns

booleanif the player has Dev Mod permissions.

SharedPlayer:IsDevMod2() → booleanSource ☍

Check if the player has Developer Moderator Stage 2 permissions. Includes: Developer permissions, developermod2 rank, or developersmod rank.

Returns

booleanif the player has Dev Mod 2 permissions.

SharedPlayer:IsDoctor() → booleanSource ☍

Check if player is a doctor.

Returns

booleanif the player is a doctor.

SharedPlayer:IsFirechief() → booleanSource ☍

Check if player is the Fire Chief.

Returns

booleanif the player is the Fire Chief.

SharedPlayer:IsFireChief() → booleanSource ☍

Alias for IsFirechief() with correct capitalization.

Returns

booleanif the player is the Fire Chief.

SharedPlayer:IsFireman() → booleanSource ☍

Check if player is a Fireman. Also returns true for Fire Chief.

Returns

booleanif the player is a Fireman or Fire Chief.

SharedPlayer:IsGovernment() → booleanSource ☍

Check if player is a government member. Includes: President, VP, Secret Service, SWAT Leader, SWAT, NDS, Police Commander, Police, Paramedic, Fireman.

Returns

booleanif the player is a government member.

ServerPlayer:IsImmuneToKnockOut() → booleanSource ☍

Whether this player is immune to being knocked out right now (Assistant+ observing in noclip).

Returns

boolean

ServerPlayer:IsImmuneToRestraint() → booleanSource ☍

Whether this player is immune to being restrained (cuffed/zip-tied/tied up) right now (Trial Mod+ observing in noclip).

Returns

boolean

SharedPlayer:IsLawenforcement() → booleanSource ☍

Check if player is a law enforcement officer. Includes: Secret Service, Police, SWAT.

Returns

booleanif the player is in law enforcement.

SharedPlayer:IsLawEnforcement() → booleanSource ☍

Alias for IsLawenforcement() with correct capitalization. Forwards compat because Lawenforcement annoys the shit outta me. ~JP.

Returns

booleanif the player is in law enforcement.

SharedPlayer:IsMafia() → booleanSource ☍

Check if player is a Mafia member or Mafia Leader.

Returns

booleanif the player is a Mafia member.

SharedPlayer:IsMafiaDon() → booleanSource ☍

Check if player is the Mafia Don.

Returns

booleanif the player is the Mafia Don.

SharedPlayer:IsMaintenanceWorker() → booleanSource ☍

Check if player is a maintenance worker.

Returns

boolean

SharedPlayer:IsMechanic() → booleanSource ☍

Check if player is a mechanic.

Returns

booleanif the player is a mechanic.

SharedPlayer:IsMember() → booleanSource ☍

Check if a player currently has active Member status (entitled and wearing the tag), or Premium.

Returns

booleanif the player should receive Member perks.

SharedPlayer:IsModerator() → booleanSource ☍

Check if the player has Moderator permissions. Includes: Dev Mod permissions, Moderator 2 permissions, or moderator rank.

Returns

booleanif the player has Moderator permissions.

SharedPlayer:IsModerator2() → booleanSource ☍

Check if the player has Moderator Stage 2 permissions. Includes: Dev Mod 2 permissions, Admin permissions, moderator2 rank, or seniormoderator rank.

Returns

booleanif the player has Moderator 2 permissions.

SharedPlayer:IsNexusDeskSecretary() → booleanSource ☍

Check if player is a Nexus Desk Secretary.

Returns

booleanif the player is a Secretary.

SharedPlayer:IsOutside() → booleanSource ☍

Check if a player is outside. Uses a skybox trace to determine if the player has an unobstructed view of the sky.

Returns

booleanif the player is outside.

SharedPlayer:IsOwner() → booleanSource ☍

Check if the player is of the owner rank.

Returns

booleanif the player is the owner.

SharedPlayer:IsParamedic() → booleanSource ☍

Check if player is a Paramedic. Also returns true for Fire Chief.

Returns

booleanif the player is a Paramedic or Fire Chief.

SharedPlayer:IsPolice() → booleanSource ☍

Check if player is a Police Officer.

Returns

booleanif the player is a Police Officer.

SharedPlayer:IsPoliceCommander() → booleanSource ☍

Check if player is the Police Commander.

Returns

booleanif the player is the Police Commander.

SharedPlayer:IsPresident() → booleanSource ☍

Check if player is President or Vice President.

Returns

booleanif the player is the President or Vice President.

SharedPlayer:IsPresidentAdministration() → booleanSource ☍

Check if player is part of the presidential administration. Includes: President, Vice President, or NDS (Nexus Desk Secretary).

Returns

booleanif the player is in the presidential administration.

SharedPlayer:IsRank(rank) → booleanSource ☍

Check if a player is a specified rank.

--  List of ranks.
--  List of ranks.
rank:
    | "owner" -- Owner
    | "superdeveloper" -- Supervising Developer
    | "superadmin" -- Supervising Administrator
    | "developer" -- Developer / Administrator
    | "admin" -- Administrator
    | "developermod2" -- Developer / Senior Moderator
    | "moderator2" -- Senior Moderator
    | "developermod" -- Developer / Moderator
    | "moderator" -- Moderator
    | "trialdevmod" -- Developer / Trial Moderator
    | "trialmoderator" -- Trial Moderator
    | "coremanager" -- Core Manager
    | "business" -- Business Advisor
    | "security" -- Security Officer
    | "core" -- Core Member
    | "developeronly" -- Developer
    | "contributor" -- Contributor
    | "assistant" -- Roleplay Assistant
    | "console" -- Server Console
    | "veteran" -- Veteran
    | "streamer"

Parameters

rank"admin"|"assistant"|"business"|"console"|"contributor"...(+16)The rank to check against (e.g., "admin", "moderator").

Returns

booleanif the player is the specified rank.

SharedPlayer:IsRebel() → booleanSource ☍

Check if player is a Rebel or Rebel Leader.

Returns

booleanif the player is a Rebel or Rebel Leader.

SharedPlayer:IsRebelLeader() → booleanSource ☍

Check if player is the Rebel Leader.

Returns

booleanif the player is the Rebel Leader.

SharedPlayer:IsRescue() → booleanSource ☍

Check if player is a rescue worker. Includes: EMS (Paramedics) and Fire Department.

Returns

booleanif the player is a rescue worker.

SharedPlayer:IsRestrained() → boolean|nilSource ☍

Check if a player is restrained by any means (cuffed, ziptied, or hostaged).

Returns

boolean|nilcurrent restrained state.

SharedPlayer:IsSecretService() → booleanSource ☍

Check if player is a Secret Service Agent or Secret Service Lead.

Returns

booleanif the player is in the Secret Service.

SharedPlayer:IsSecretServiceLeader() → booleanSource ☍

Alias for IsSSLeader().

Returns

booleanif the player is the Secret Service Lead.

SharedPlayer:IsSecurityGuard() → booleanSource ☍

Check if player is a Security Guard.

Returns

booleanif the player is a Security Guard.

SharedPlayer:IsSecurityOfficer() → booleanSource ☍

Check if the player is a security officer. Includes: security rank or Super Developer permissions.

Returns

booleanif the player is a security officer.

SharedPlayer:IsSSLeader() → booleanSource ☍

Check if player is the Secret Service Lead.

Returns

booleanif the player is the Secret Service Lead.

SharedPlayer:IsStreamer() → booleanSource ☍

Check if a player is in streamer mode. This is a rank check for staff who activate "streamer mode" to hide their identity.

Returns

booleanif streamer mode is active.

SharedPlayer:IsSuperAdmin() → booleanSource ☍

Check if the player has Super Admin permissions. Includes: Super Developer permissions or Super Admin rank.

Returns

booleanif the player has Super Admin permissions.

SharedPlayer:IsSuperDeveloper() → booleanSource ☍

Check if the player has Super Developer permissions. Includes: Owner or Super Developer rank.

Returns

booleanif the player has Super Developer permissions.

SharedPlayer:IsSwat() → booleanSource ☍

Check if player is a SWAT member.

Returns

booleanif the player is a SWAT member.

SharedPlayer:IsSWAT() → booleanSource ☍

Alias for IsSwat() with correct capitalization.

Returns

booleanif the player is a SWAT member.

SharedPlayer:IsSwatLeader() → booleanSource ☍

Check if player is the SWAT Leader.

Returns

booleanif the player is the SWAT Leader.

SharedPlayer:IsSWATLeader() → booleanSource ☍

Alias for IsSwatLeader() with correct capitalization.

Returns

booleanif the player is the SWAT Leader.

SharedPlayer:IsTrialDevMod() → booleanSource ☍

Check if the player has Trial Developer Moderator permissions. Includes: Dev Mod permissions or trialdevmod rank.

Returns

booleanif the player has Trial Dev Mod permissions.

SharedPlayer:IsTrialMod() → booleanSource ☍

Check if the player has Trial Moderator permissions. Includes: Trial Dev Mod permissions, Moderator permissions, or trialmoderator rank.

Returns

booleanif the player has Trial Moderator permissions.

SharedPlayer:IsUserGroup(rank) → booleanSource ☍

Check if a player is a specified rank. Alias for IsRank() for compatibility with Garry's Mod standard API. See: ~~IsRank~~

Parameters

rankstringThe rank to check against (e.g., "admin", "moderator").

Returns

booleanif the player is the specified rank.

SharedPlayer:IsVeteran() → booleanSource ☍

Check if the player is a veteran.

Returns

booleanif the player has the veteran rank.

SharedPlayer:IsVicePresident() → booleanSource ☍

Check if player is the Vice President.

Returns

booleanif the player is the Vice President.

SharedPlayer:IsWarranted() → booleanSource ☍

Check if a player has a warrant that lets officers act on them. A BOLO is not one.

Returns

boolean

SharedPlayer:KnockedOut() → boolean|nilSource ☍

Check if a player is knocked out.

Returns

boolean|nilcurrent knocked out state.

ServerPlayer:KnockOut(boolean, seconds, reset, attacker)Source ☍

Knock out a player or bring them back to consciousness.

Parameters

booleanbooleanIf the player should be knocked out or brought back to consciousness.
secondsnumberHow long they should be knocked out for.
resetbooleanIf the player's status should be reset.
attackerPlayer?Who knocked them out, passed to the PlayerKnockOut hook; nil for sleep, items and injuries.

ServerPlayer:LightSpawn()Source ☍

"Lightly" spawn a player. Ie. don't reset data etc.

ServerPlayer:LoadData()Source ☍

Load a player's data.

Internal
This function is internal. Whilst you can call it, you probably shouldn't.

ServerPlayer:LoadData2(result)Source ☍

Load the player's data from the result table.

Internal
This function is internal. Whilst you can call it, you probably shouldn't.

Parameters

resulttableThe result table from the database.

ServerPlayer:LoadDataNew()Source ☍

Load data for a new player.

Internal
This function is internal. Whilst you can call it, you probably shouldn't.

SharedPlayer:Masked() → booleanSource ☍

Check if a player is currently masked. Checks for mask-capable models, bodygroups, and accessories. Returns false if the player is dead, hostaged, cuffed, or ziptied.

Returns

booleanif the player is masked.

SharedPlayer:MembershipExpires() → numberSource ☍

Get the time when the player's membership expires.

Returns

numbertimestamp of membership expiry time.

SharedPlayer:MembershipLevel() → numberSource ☍

Get a player's membership level. Calculated based on total purchases (£5 spent equals 1 month). Admins always return level 99.

Returns

numbercurrent membership level (0 if no membership, 99 for admins).

SharedPlayer:Name(replace) → stringSource ☍

Get a player's OOC name, with optional undercover name replacement. If replace is true and the player can go undercover, this reveals their real identity for staff logs/echoes: their registered real name if cached, or a generic name like "An Administrator" if not. If replace is true but the player cannot go undercover (e.g. not Moderator 2+), their real nickname is always returned, since they never have a fake identity to hide behind. Otherwise, provides the regular nickname.

Parameters

replaceboolean|nilIf true, the name should be replaced by the undercover name (for command echos).

Returns

stringplayer's name, registered undercover name, "An Administrator", "A Moderator", or "Somebody" depending on state.

SharedPlayer:Nick() → stringSource ☍

Get a player's nickname. This may return a fake name if the player has set one.

Returns

stringplayer's nickname.

SharedPlayer:Noclipping() → booleanSource ☍

Get the player's noclip state. Returns true if the player is in noclip mode and not in a vehicle.

Returns

booleanif the player is noclipping.

ServerPlayer:Notify(message, class, priority)Source ☍

Send a notification message to a player.

Parameters

messagestringThe message to send.
classnumber?The numeric class of the message to send.
priorityboolean?A bool representing if the message should overwrite the "showhud" option (default: false).

ServerPlayer:NotifyCenter(message, icon, color, delay, showinconsole)Source ☍

Send a notification to the center of a player's screen.

Parameters

messagestringThe message to send.
iconstring?The icon for the message.
colorColor?The colour of the message.
delaynumber?The time the message will stay on screen.
showinconsoleboolean?Boolean for if the message should show in console.

ServerPlayer:NotifyChoice(message, button1, function1, button2, function2, icon, color, dismissable, uid)Source ☍

Send a notification message to a player, with clickable buttons to affect commands. it instead of stacking a second one -- use this when a request can be re-sent (e.g. re-approval after the requester changes their proposal) so the player never sees a stale copy alongside it.

Parameters

messagestringThe message to send.
button1string?The tooltip text of the first button.
function1(string|table)?Command to run on click, or table of tables ({{"label", "command"}, {"label 2", "different command"}}).
button2string?The tooltip text of the second button.
function2(string|table)?Command to run on click, or table of tables.
iconstring?The icon for the message to have.
colortable?The colour for the message to have.
dismissableboolean?A bool representing if the checkbox should have a "dismiss" option (default: false).
uidstring?A key identifying this notification. A later call with the same uid replaces

ServerPlayer:NotifyCustom(message, icon, color, length)Source ☍

Send a custom notification message to a player.

Parameters

messagestringThe message to send.
iconstring?The icon for the message to have.
colortable?The colour for the message to have (unused).
lengthnumber?The length of the time the message should be displayed for (default: 3).

ServerPlayer:NotifyDismiss(uid)Source ☍

Removes a still-showing NotifyChoice notification, identified by the uid it was sent with. No-op if the player never got one under that uid, or already dismissed it themselves.

Parameters

uidstring

ServerPlayer:NotifyTarget(tArg, plys)Source ☍

Send an error message to a player saying that they matched multiple players with a command target.

Parameters

tArgstringThe target argument that failed.
plystable?The players to send.

SharedPlayer:Pass() → `PASS_BLUE`|`PASS_GREEN`|`PASS_GREY`|`PASS_ORANGE`|`PASS_RED`...(+1)Source ☍

Check if a player has a pass.

The:
    | `PASS_GREY`
    | `PASS_GREEN`
    | `PASS_BLUE`
    | `PASS_ORANGE`
    | `PASS_RED`

Returns

`PASS_BLUE`|`PASS_GREEN`|`PASS_GREY`|`PASS_ORANGE`|`PASS_RED`...(+1)current pass or nil if none.

SharedPlayer:PlaySound(soundOrPath, playServerSide, volume, level, pitch, channel)Source ☍

Play a sound for the player. Can play either serverside (EmitSound - audible to nearby players) or clientside (surface.PlaySound - only to this player).

Parameters

soundOrPathstringThe sound key from the sound map or a full sound path.
playServerSideboolean|nilIf true, plays via EmitSound (3D sound); else, sends net message to client.
volumenumber|nilPlayback volume (0.0-1.0). Defaults to 1.0.
levelnumber|nilSound attenuation level for EmitSound. Defaults to 75.
pitchnumber|nilPlayback pitch (percentage). Defaults to 100.
channelnumber|nilSound channel for EmitSound. Defaults to CHAN_AUTO.

ServerPlayer:printMessage(message)Source ☍

Send a message to a player.

Parameters

messagestringThe message to send.

ServerPlayer:PrintRadius(msg, pos, rad)Source ☍

Prints a message to players within a radius of a specified position.

Parameters

msgstringThe message to send.
posVectorThe position to check.
radnumberThe radius to send within.

ServerPlayer:RefreshPropLimitDefault()Source ☍

Recomputes and pushes this player's rank/member/hours/rep prop limit layers. Props only - call cityrp.limits.RefreshDefaults to recompute every limit a player has.

ServerPlayer:RefundAllAmmo()Source ☍

Refund all ammo currently loaded onto a player. Boxes are added even past the inventory's capacity, so a full inventory never costs rounds; only an unregistered box item leaves them on the player.

ServerPlayer:ReleaseFromArrest(releaser, opts) → booleanSource ☍

Releases an arrested player; every release route comes here. A player releasing them must pass the unarrest permission check; a served sentence or a staff unarrest is not a player doing it, and skips it. An escape leaves an arrest warrant. Without respawn it grants in place.

Parameters

releaserPlayer?The player releasing them; nil for a served sentence or a staff unarrest.
opts{ escape: boolean?, respawn: boolean? }?

Returns

boolean

ServerPlayer:RemoveHolstered()Source ☍

Removes Holstered weapons/mods from inventory

SharedPlayer:REP(cat) → numberSource ☍

Get a player's REP count.

Parameters

catstring|nilThe category to check ("government", "general", "underground"), or nil for total count.

Returns

numbernumber of REPs the player has.

ServerPlayer:RestoreDefaultModel()Source ☍

Restore a player's default model. Also unsets their custom model field.

ServerPlayer:RestoreDefaultModelTimed(emote, post)Source ☍

Reset a player's default model, using the regular 10 second timer.

Parameters

emotestringEmote to use after changing.
postfunctionHook function called after the change has happened.

ServerPlayer:RestoreWeaponState(state) → booleanSource ☍

Gives a player a weapon back in a recorded state: its clip at once, its attachments and fire mode once the client has the weapon.

Parameters

stateWeaponState

Returns

boolean

SharedPlayer:RPName() → stringSource ☍

Get a player's current in-character (IC) name. If a fake name is set, it will be returned instead of the real IC name.

Returns

stringplayer's IC name.

ServerPlayer:SaveData(create)Source ☍

Save a player's data.

Internal
This function is internal. Whilst you can call it, you probably shouldn't.

Parameters

createbooleanShould the query be an insert or an update.

ServerPlayer:SaveWeaponState(weapon) → WeaponStateSource ☍

Records the state of a weapon the player holds.

Parameters

weaponWeapon

Returns

WeaponState

ServerPlayer:SayDistress(text)Source ☍

Say a message as a distress broadcast.

Parameters

textstringThe message to send.

ServerPlayer:SayRadio(text)Source ☍

Send a message as a radio broadcast. If the player has sent a /panic call in the last 20 seconds, these are sent as distress class messages, rather than radio class.

Parameters

textstringThe message to send.

ServerPlayer:SetHealth(hp)Source ☍

Parameters

hpany

ServerPlayer:SetLPlyVar(name, value)Source ☍

Update a variable that is sent only to this player's client. Prefer this over cityrp.player.setLocalPlayerVariable in new code.

Parameters

namestringThe LocalPlayerVar name to set.
valueanyThe new value.

ServerPlayer:SetMember(bool)Source ☍

Grant or revoke a player's Member entitlement. Persisted in _Flags, the same field Premium's "d" flag lives in, but read/written directly rather than through the cityrp.access system, since Member isn't a permission.

Parameters

boolbooleanIf the player should be entitled to Member status.

ServerPlayer:SetMembershipExpires(expires)Source ☍

Set when a player's membership expires.

Parameters

expiresnumberNew expiry time.

ServerPlayer:SetNetMember(bool)Source ☍

Set the networked Member state (the sync of GetMember()). Does not itself check tags or Premium.

Parameters

boolbooleanIf the player should be networked as entitled to Member status.

ServerPlayer:SetNSVar(name, value)Source ☍

Set a player's NSVar and broadcast it to every client. The name must already be registered in networking/sh_init.lua; unregistered keys are rejected.

Parameters

namestringThe NSVar name to set.
valueanyThe new value.

ServerPlayer:SetPData(_) → nilSource ☍

Override SetPData to disable saving on build/event servers.

Parameters

Returns

ServerPlayer:SetPropLimit(limit)Source ☍

Sets/clears an admin override for a player's prop limit (e.g. a prop extension).

Parameters

limitnumber?Limit to set, nil to reset to the rank/REP-tracked value.

ServerPlayer:SetSalary()Source ☍

Set a player's salary based on third party adjustments.

SharedPlayer:Sleeping() → boolean|nilSource ☍

Check if a player is sleeping.

Returns

boolean|nilcurrent sleep state.

SharedPlayer:Stabilised() → boolean|nilSource ☍

Check if a player has been stabilised via CPR and no longer needs further compressions.

Returns

boolean|nilcurrent stabilised state.

SharedPlayer:Status() → stringSource ☍

Get a player's custom status.

Returns

stringcurrent status, or empty string if none set.

ServerPlayer:StripForRestraint()Source ☍

Strips a player for a restraint: issued equipment goes into the loadouts stash with its state, owned weapons are holstered, and everything else is taken.

SharedPlayer:Stunned() → boolean|nilSource ☍

Check if a player is stunned (tased).

Returns

boolean|nilcurrent stun state.

ServerPlayer:TakeDoor(door)Source ☍

Take a door from a player, including child doors.

Parameters

doorEntityThe door entity to take.

SharedPlayer:Tranqed() → boolean|nilSource ☍

Check if a player is tranquilized.

Returns

boolean|nilcurrent tranquilized state.

SharedPlayer:TweetName() → string|nilSource ☍

Get a player's tweet/social media name.

Returns

string|nilcurrent tweet name.

ServerPlayer:VehicleAccess(veh) → booleanSource ☍

Check if a player has access to a vehicle.

Parameters

vehVehicleThe vehicle to check access for.

Returns

booleanthe player has access to the vehicle.

ServerPlayer:Warrant(class)Source ☍

Warrant or unwarrant a player.

Parameters

classboolean|stringThe warrant class (e.g., "search", "arrest") or false to unwarrant.

SharedPlayer:Warranted() → "arrest"|"bolo"|"search"|nilSource ☍

Check if a player has a warrant.

--  The kinds of warrant that can be held against a player.
--  @section Type Unions
The:
    | "bolo"
    | "search"
    | "arrest"

Returns

"arrest"|"bolo"|"search"|nilcurrent warrant type, or nil if none.

SharedPlayer:Ziptied() → boolean|nilSource ☍

Check if a player is ziptied.

Returns

boolean|nilcurrent ziptie state.

Tables

ServerPlayer._ConfiscationMarksSource ☍
ServerPlayer._HolsteredModsSource ☍
ServerPlayer._HolsteredModsSource ☍
ServerPlayer._HolsteredModsSource ☍
ServerPlayer._HolsteredWeaponsSource ☍
ServerPlayer._HolsteredWeaponsSource ☍
ServerPlayer._HolsteredWeaponsSource ☍
ServerPlayer._HolsteredWeaponsSource ☍
ServerPlayer._RagdollSource ☍: Restore the ragdoll table and set the knocked out variable to nil.
ServerPlayer._WeaponModsSource ☍
ServerPlayer._WeaponModsSource ☍

Classes

ServerPlayerSource ☍

The player metatable, with CityRP's own additions to Garry's Mod's Player.

SharedRankSource ☍

List of ranks. List of ranks.

Accepted values:

"owner" -- Owner
"superdeveloper" -- Supervising Developer
"superadmin" -- Supervising Administrator
"developer" -- Developer / Administrator
"admin" -- Administrator
"developermod2" -- Developer / Senior Moderator
"moderator2" -- Senior Moderator
"developermod" -- Developer / Moderator
"moderator" -- Moderator
"trialdevmod" -- Developer / Trial Moderator
"trialmoderator" -- Trial Moderator
"coremanager" -- Core Manager
"business" -- Business Advisor
"security" -- Security Officer
"core" -- Core Member
"developeronly" -- Developer
"contributor" -- Contributor
"assistant" -- Roleplay Assistant
"console" -- Server Console
"veteran" -- Veteran

SharedRankKeySource ☍

List of ranks. List of ranks. List of ranks.

Accepted values:

"owner" -- Owner
"superdeveloper" -- Supervising Developer
"superadmin" -- Supervising Administrator
"developer" -- Developer / Administrator
"admin" -- Administrator
"developermod2" -- Developer / Senior Moderator
"moderator2" -- Senior Moderator
"developermod" -- Developer / Moderator
"moderator" -- Moderator
"trialdevmod" -- Developer / Trial Moderator
"trialmoderator" -- Trial Moderator
"coremanager" -- Core Manager
"business" -- Business Advisor
"security" -- Security Officer
"core" -- Core Member
"developeronly" -- Developer
"contributor" -- Contributor
"assistant" -- Roleplay Assistant
"console" -- Server Console
"veteran" -- Veteran
"streamer"
"newmember"
"bronzemember"
"silvermember"
"goldmember"
"diamondmember"
"member"
"default"

Fields

ServeramountSource ☍
ServerPlayer.__netReadySource ☍: True once this player has received the manifest and initial bootstrap.
ServerPlayer._BleedOutDeathSource ☍
ServerPlayer._BleedOutDeathSource ☍
ServerPlayer._BleedOutDeathSource ☍
ServerPlayer._BlindfoldedSource ☍: Set variable and NSVar
ServerPlayer._BlindfoldedSource ☍
ServerPlayer._BlindfoldedSource ☍: Reset variable and NSVar
ServerPlayer._EventMgrSource ☍
ServerPlayer._EventMgrSource ☍
ServerPlayer._FatalInjuredSource ☍
ServerPlayer._FatalInjuredSource ☍
ServerPlayer._FatalInjuredSource ☍
ServerPlayer._FatalInjuredSource ☍
ServerPlayer._FatalInjuredSource ☍
ServerPlayer._FatalInjuredendSource ☍
ServerPlayer._FatalInjuredendSource ☍
ServerPlayer._FatalInjuredendSource ☍
ServerPlayer._HolsteredModsSource ☍
ServerPlayer._HolsteredTimeSource ☍
ServerPlayer._HostagedSource ☍
ServerPlayer._HostagedSource ☍
ServerPlayer._initialPropLimitSource ☍
ServerPlayer._initialPropLimitSource ☍
ServerPlayer._InjuredByPlayerWeaponSource ☍
ServerPlayer._InjuredByPlayerWeaponSource ☍
ServerPlayer._InjuredByPlayerWeaponSource ☍
ServerPlayer._InjuredByPropSource ☍
ServerPlayer._InjuredByPropSource ☍
ServerPlayer._InjuredByPropSource ☍
ServerPlayer._InjuredTimeSource ☍
ServerPlayer._InjuringPropSource ☍: The entity metatable, with CityRP's own additions to Garry's Mod's Entity.
ServerPlayer._InjuringPropSource ☍: The entity metatable, with CityRP's own additions to Garry's Mod's Entity.
ServerPlayer._InjuringPropSource ☍: The entity metatable, with CityRP's own additions to Garry's Mod's Entity.
ServerPlayer._InjuryTickSource ☍
ServerPlayer._InjuryTickSource ☍
ServerPlayer._KnockedOutSource ☍: Set the player to be knocked out.
ServerPlayer._KnockedOutSource ☍
ServerPlayer._LastInjureSource ☍
ServerPlayer._LastInjureSource ☍: Sometimes the injure function gets called multiple times
ServerPlayer._LastPropDamageEntSource ☍: The entity metatable, with CityRP's own additions to Garry's Mod's Entity.
ServerPlayer._LastPropDamageEntSource ☍: The entity metatable, with CityRP's own additions to Garry's Mod's Entity.
ServerPlayer._LastPropDamageEntSource ☍: The entity metatable, with CityRP's own additions to Garry's Mod's Entity.
ServerPlayer._LastPropDamageTimeSource ☍
ServerPlayer._LastPropDamageTimeSource ☍
ServerPlayer._LastPropDamageTimeSource ☍
ServerPlayer._LightSpawnSource ☍
ServerPlayer._PretranqSource ☍
ServerPlayer._PurchasesSource ☍
ServerPlayer._PurchasesSource ☍
ServerPlayer._SalarySource ☍: Some default values to prevent bugs
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SalarySource ☍
ServerPlayer._SetPDataSource ☍
ServerPlayer._SleepingSource ☍
ServerPlayer._StunnedSource ☍
ServerPlayer._TapOutDeathSource ☍
ServerPlayer._WarrantedSource ☍: Update their warranted status.
ServerPlayer._WarrantedTimeSource ☍
ServerPlayer.BlacklistTimeSource ☍: Alias of cityrp.access.BanTime.
ServerPlayer.CustomModelSource ☍
ServerPlayer.CustomModelSource ☍
ServerPlayer.CustomModelSource ☍
ServerPlayer.LayerStacksSource ☍: LAYER_STACK> Cached per-attribute layer stacks, lazily populated.
SharedPlayer.NickOrigSource ☍: Original nickname function.
SharedposSource ☍

RankData

5 fields Source ☍

SharedRankData.[1]Source ☍: icon The icon path for the rank.
SharedRankData.[2]Source ☍: symbol The symbol for the rank.
SharedRankData.[3]Source ☍: name The name of the rank.
SharedRankData.[4]Source ☍: color The color of the rank.
SharedRankData.[5]Source ☍: order The order of the rank in the list.

RankPreviewEntry

5 fields Source ☍

SharedRankPreviewEntry.colorSource ☍
SharedRankPreviewEntry.iconSource ☍
SharedRankPreviewEntry.nameSource ☍
SharedRankPreviewEntry.orderSource ☍
SharedRankPreviewEntry.symbolSource ☍

WeaponState

4 fields Source ☍

The state of a weapon a player held, enough to give it back as it was.

ServerWeaponState.classSource ☍
ServerWeaponState.clipSource ☍
ServerWeaponState.fireModeSource ☍: CW 2.0 fire mode; safe is the safety.
ServerWeaponState.modsSource ☍: Fitted CW 2.0 attachments.

Contents

Topics

Items

Metatables

Panels

Modules

Player

Functions

Tables

Classes

Accepted values:

Accepted values:

Fields

RankData

RankPreviewEntry

WeaponState