CityRP Documentation Repository

core.sh_configuration

Name: "sh_configuration.lua". Product: "CityRP 2 (Roleplay)".

Functions

Sharedcityrp.configuration.GetBannedPropReason(model, fallback) → string|nilSource ☍

Resolve the refusal message for a banned prop model.

Parameters

  • modelstring|nilThe model path to look up.
  • fallbackstring?Message used when the entry is bare true. Defaults to the generic spawn error.

Returns

  1. string|nilThe refusal message, or nil when the model is not banned.

Tables

Sharedcityrp.configuration.Banned ADV EntsSource ☍
Sharedcityrp.configuration.Banned PropsSource ☍
Sharedcityrp.configuration.ContrabandSource ☍

Contraband

Sharedcityrp.configuration.Default InventorySource ☍

The default inventory that each player starts with.

Sharedcityrp.configuration.DepositSource ☍

Rocks to Riches

Sharedcityrp.configuration.Female Citizen ModelsSource ☍
Sharedcityrp.configuration.InfoBoardsSource ☍

HTML Infoboards displayed at Nexus. ( Scale height and width with the formula: width / 0.26 )

Sharedcityrp.configuration.Male Citizen ModelsSource ☍

MODEL VALUES

Sharedcityrp.configuration.MenuSource ☍

DERMA VALUES

Sharedcityrp.configuration.PassesSource ☍
Sharedcityrp.configuration.RegenSource ☍

Health Regen

Sharedcityrp.configuration.Special PropsSource ☍

BANNED/SPECIAL PROPS LIST

Fields

Sharedcityrp.configuration.Admin TagSource ☍

The admintag of the community.

Sharedcityrp.configuration.Advert CostSource ☍

MONEY COST VALUES

The money that it costs to advertise.

Sharedcityrp.configuration.Area PluginSource ☍

Area plugin disable for v4b1/v2p

Sharedcityrp.configuration.Arrest Warrant Expire TimeSource ☍

The time that a player's arrest warrant expires (seconds) (set to 0 for never).

Sharedcityrp.configuration.Arrested Run Speed MultiplierSource ☍

Run speed while arrested or hostaged (100 flat).

Sharedcityrp.configuration.Arrested Walk Speed MultiplierSource ☍

Walk and jog speed while arrested (100 flat on both).

Sharedcityrp.configuration.Atmos EnabledSource ☍

Enable/Disable atmos.

Sharedcityrp.configuration.Banned EntitiesSource ☍
Sharedcityrp.configuration.Bleed TimeSource ☍

The time that a player bleeds for when they get damaged (seconds).

Sharedcityrp.configuration.Blindfold RemoveSource ☍

Time in seconds before blindfold gets automaticly removed from player to prevent abuse.

Sharedcityrp.configuration.Cleanup DecalsSource ☍

Whether or not to automatically cleanup decals every minute.

Sharedcityrp.configuration.Cocaine Jump Power MultiplierSource ☍

Jump power while the cocaine effect is active (200 flat).

Sharedcityrp.configuration.Cocaine Run Speed MultiplierSource ☍

Run speed while the cocaine effect is active (400 flat).

Sharedcityrp.configuration.Command PrefixSource ☍

MISC. VALUES

The prefix that is used for chat commands.

Sharedcityrp.configuration.Contraband IntervalSource ☍

The different types of contraband. The interval that players recieve money from their contraband (seconds).

Sharedcityrp.configuration.Currency PositionSource ☍
Sharedcityrp.configuration.Currency SymbolSource ☍
Sharedcityrp.configuration.Default AccessSource ☍

The access that each player begins with.

Sharedcityrp.configuration.Default Arrest TimeSource ☍

The default time that a player is arrested for (seconds).

Sharedcityrp.configuration.Default ClanSource ☍

The clan that each player belongs to by default.

Sharedcityrp.configuration.Default DescriptionSource ☍

The description that each player belongs to by default.

Sharedcityrp.configuration.Default GenderSource ☍

What gender they are by default.

Sharedcityrp.configuration.Default JobSource ☍

The job that each player starts with.

Sharedcityrp.configuration.Default ModelSource ☍

What their default model is.

Sharedcityrp.configuration.Default MoneySource ☍

DEFAULT VALUES FOR PLAYERS

The money that each player starts with.

Sharedcityrp.configuration.Disarm Waiting TimeSource ☍

The time that a player has to wait to disarm all weapons and mods (seconds).

Sharedcityrp.configuration.Electric Vehicle Recharge CostSource ☍

The money that it costs to recharge an electric vehicle, at a supercharger (per tick). Homecharger owners may set their own price up to 3.5x this.

Sharedcityrp.configuration.Exhausted Run Speed MultiplierSource ☍

Run speed eases toward jog speed as stamina depletes.

Sharedcityrp.configuration.Government Salary Tax BaselineSource ☍

Tax rate at which government salaries receive no bonus; each % above this adds 0.5% to government pay (floored).

Sharedcityrp.configuration.Headlights PluginSource ☍

Headlights plugin (Replaced by addons/vcmod1. They will conflict with eachother when enabled)

Sharedcityrp.configuration.Inventory SizeSource ☍

MAXIMUM VALUES

The maximum inventory size.

Sharedcityrp.configuration.Jog SpeedSource ☍

The speed that players jog at, while holding +walk.

Sharedcityrp.configuration.Jump CostSource ☍

Jump stamina degredation

Sharedcityrp.configuration.Jump PowerSource ☍

The jump power that players have by default.

Sharedcityrp.configuration.Knock Out TimeSource ☍

The time that a player gets knocked out for (seconds).

Sharedcityrp.configuration.Loadout Lock TimeSource ☍

The time that a locked issued weapon stays unusable (seconds).

Sharedcityrp.configuration.Max Arrest TimeSource ☍

The max time that a player can be arrested for (seconds).

Sharedcityrp.configuration.Max Arrest Time (Presidential)Source ☍

The max time that a player can be arrested for (seconds), when the President or Vice President is available.

Sharedcityrp.configuration.Maximum BoomboxesSource ☍

The maximum amount of boomboxes a player can spawn.

Sharedcityrp.configuration.Maximum Contact DamageSource ☍

Vehicle contact damage at run over speed, scaling to zero at rest.

Sharedcityrp.configuration.Maximum Lockpick UsesSource ☍

The maximum amount of times a lockpick can be used (not needed).

Sharedcityrp.configuration.Maximum NotesSource ☍

The maximum amount of notes a player can write.

Sharedcityrp.configuration.Maximum PropertiesSource ☍

The maximum amount of properties a player can own.

Sharedcityrp.configuration.Maximum RagdollsSource ☍

The maximum amount of ragdolls a player can spawn.

Sharedcityrp.configuration.Mechanic Customization Approval TimeSource ☍

The time a vehicle owner has to approve a mechanic's customization before it's treated as denied and reverted (seconds).

Sharedcityrp.configuration.Member TagSource ☍

The community Member tag.

Sharedcityrp.configuration.Minimum Run Over SpeedSource ☍

Minimum speed, in MPH, before vehicle contact runs someone over.

Sharedcityrp.configuration.Moderator TagSource ☍

The moderator tag.

Sharedcityrp.configuration.Name FullSource ☍

Full name of community.

Sharedcityrp.configuration.Name ShortSource ☍

Short name of community.

Sharedcityrp.configuration.Name TagsSource ☍

The clantags of the community.

Sharedcityrp.configuration.NewUpdate DelaySource ☍

Delay in seconds after InitialSpawn before notifications shows.

Sharedcityrp.configuration.NewUpdate TextSource ☍

Text shown in notification on new update.

Sharedcityrp.configuration.OOC DelaySource ☍

TIMER VALUES

How often players can speak in OOC chat.

Sharedcityrp.configuration.OOC Delay High PlayersSource ☍

At or above this player count, the full OOC delay applies; it scales linearly in between.

Sharedcityrp.configuration.OOC Delay Low PlayersSource ☍

At or below this player count, the OOC delay is halved.

Sharedcityrp.configuration.Petrol Refuel CostSource ☍

The money that it costs to refuel a petrol tank, at a petrol station (per tick).

Sharedcityrp.configuration.Plate CostSource ☍

Amount of money to buy custom plate.

Sharedcityrp.configuration.Plate DelaySource ☍

Delay in seconds before player can buy new plate.

Sharedcityrp.configuration.Plate PluginSource ☍

License plates Enable/Disable the license plate plugin.

Sharedcityrp.configuration.Prop Limit AssistantSource ☍
Sharedcityrp.configuration.Prop Limit ContributorSource ☍
Sharedcityrp.configuration.Prop Limit DefaultSource ☍

PROP LIMIT VALUES

Sharedcityrp.configuration.Prop Limit DeveloperSource ☍
Sharedcityrp.configuration.Prop Limit Give Min HoursSource ☍

Playtime hours needed to send/receive a /giveprops loan (unless the "Give Min REP" threshold is met instead).

Sharedcityrp.configuration.Prop Limit Give Min REPSource ☍

REP needed to send/receive a /giveprops loan (unless the "Give Min Hours" threshold is met instead).

Sharedcityrp.configuration.Prop Limit HoursSource ☍
Sharedcityrp.configuration.Prop Limit Hours needSource ☍
Sharedcityrp.configuration.Prop Limit MaxSource ☍
Sharedcityrp.configuration.Prop Limit MemberSource ☍
Sharedcityrp.configuration.Prop Limit ModSource ☍
Sharedcityrp.configuration.Prop Limit REPSource ☍
Sharedcityrp.configuration.Prop Limit VeteranSource ☍
Sharedcityrp.configuration.Root URLSource ☍

COMMUNITY VALUES

The root URL to the website.

Sharedcityrp.configuration.Run SpeedSource ☍

The speed that players run at.

Sharedcityrp.configuration.Salary IntervalSource ☍

The interval that players receive their salary (seconds).

Sharedcityrp.configuration.Scale Chest DamageSource ☍

How much to scale chest damage by.

Sharedcityrp.configuration.Scale Head DamageSource ☍

How much to scale head damage by.

Sharedcityrp.configuration.Scale Limb DamageSource ☍

How much to scale limb damage by.

Sharedcityrp.configuration.Scale Ragdoll DamageSource ☍

DAMAGE VALUES

How much to scale ragdolled player damage by.

Sharedcityrp.configuration.Search Warrant Expire TimeSource ☍

The time that a player's search warrant expires (seconds) (set to 0 for never).

Sharedcityrp.configuration.Sleep Waiting TimeSource ☍

The time that a player has wait to sleep (seconds).

Sharedcityrp.configuration.Spawn TimeSource ☍

The time that a player has to wait before they can spawn again (seconds).

Sharedcityrp.configuration.Spot DistanceSource ☍

The distance between target and player before player can use /spotted.

Sharedcityrp.configuration.Talk RadiusSource ☍

RADIUS / DISTANCE VALUES

The radius of each player that other players have to be in to hear them talk (units).

Sharedcityrp.configuration.Tied-Up SpeedSource ☍

How fast a player walks when they are tied up.

Sharedcityrp.configuration.Tranq Knock Out TimeSource ☍

The time that a player gets knocked out when they have been tranqed for (seconds).

Sharedcityrp.configuration.Updates PluginSource ☍
Sharedcityrp.configuration.Vehicle Repair CostSource ☍

The money that it costs to repair a vehicle, at a repair station (per tick).

Sharedcityrp.configuration.Voice RadiusSource ☍

Voice range.

Sharedcityrp.configuration.Walk SpeedSource ☍

SPEED VALUES

The speed that players walk at, with no modifier held.

Sharedcityrp.configuration.Warrant Request Expire TimeSource ☍

The time an unanswered warrant request waits for approval before expiring (seconds) (set to 0 for never).

Sharedcityrp.configuration.Website URLSource ☍

Text shown in right down corner of screen.

Sharedcityrp.configuration.Weed CostSource ☍

Reference list price; Stormzy pays by bagged-weed quality (see cityrp.weed.GetUnitPrice).

Sharedcityrp.configuration.Whisper RadiusSource ☍

The radius other players have to be in to hear a /w whisper (units).

Sharedcityrp.configuration.Yell RadiusSource ☍

The radius other players have to be in to hear a /y yell (units).

Pass

4 fields Source ☍
SharedPass.colourSource ☍

The color of the pass.

SharedPass.iconSource ☍

The icon of the pass.

SharedPass.nameSource ☍

The name of the pass.

SharedPass.sortorderSource ☍

The sort order of the pass.