DarkRP:CustomJobFields

From Official DarkRP Wiki
Revision as of 14:02, 21 December 2013 by FPtje (talk | contribs) (Example with all fields)
Jump to navigation Jump to search
DarkRP: Custom Job Fields
Page white text.png Description:Custom Job Fields.
User.png Original Author:Unknown
Table edit.png Updated:October 25, 2013


This page is available in the following languages:
Данная версия страницы доступна на следующих языках:
Jarvis-flag 8010.png English | Russia-flag.png Русский


Custom job fields

You can create custom jobs in DarkRP. However, there are many things to fiddle with. This page explains every single "field".

Example with all fields

Here's an example with all available fields filled in:

TEAM_Example = DarkRP.createJob("Example team", {
	color = Color(255, 255, 255, 255),
	model = {
		"models/player/Group03/Female_01.mdl",
		"models/player/Group03/Female_02.mdl"
		},
	description = [[This text will serve as the description of
		this team.]],
	weapons = {"weapon_p2282"},
	command = "example",
	max = 3,
	salary = 45,
	admin = 0,
	vote = false,
	hasLicense = false,
	NeedToChangeFrom = TEAM_CITIZEN,
	help = "You are an example. Walk around and be exemplary.",
	customCheck = function(ply) return ply:getDarkRPVar("money") > 10000 end,
	CustomCheckFailMsg = "You don't have enough money!",
	modelScale = 1.2,
	maxpocket = 20,
	maps = {"rp_downtown_v2", "gm_construct"},
	candemote = false,
	mayor = false,
	chief = false,
	medic = false,
	cook = false,
	hobo = false,

	CanPlayerSuicide = function(ply) return false end,
	PlayerCanPickupWeapon = function(ply, weapon) return true end,
	PlayerDeath = function(ply, weapon, killer) end,
	PlayerLoadout = function(ply) return true end,
	PlayerSelectSpawn = function(ply, spawn) end,
	PlayerSetModel = function(ply) return "models/player/Group03/Female_02.mdl" end,
	PlayerSpawn = function(ply) end,
	PlayerSpawnProp = function(ply, model) end,
	RequiresVote = function(ply, job) for k,v in pairs(player.GetAll()) do if IsValid(v) and v:IsAdmin() then return false end end return true end, -- People need to make a vote when there is no admin around
	ShowSpare1 = function(ply) end,
	ShowSpare2 = function(ply) end,
	canStartVote = function(ply) return ply:Distance(SomeNPC) < 200 end,
	canStartVoteReason = "Must be close to some NPC",
        buttonColor = Color(255, 255, 255, 255), -- The color of the button in the F4 menu
})

Here is another example(edited by skyarmyninja): {[CODE|TEAM_EXAMPLE = DarkRP.createJob("Example", Color(1, 2, 3, 255), "models/player/police.mdl", Example, {"weapon_glock2"}, "example", 1, 20, 0, true) //

If none of them work, try this: (edited by skyarmyninja... again :P) Template:CODE

Yes, the above code is from older versions of DarkRP that DOES work. So dont be blaming me (skyarmyninja) or the DarkRP developers if it doesnt work.

Field explanations

color

The color of the team in tab and other places.

model

The model of the team. This can either be a string or a table of strings. Two examples: A string, players who have this job have ONE model, namely the one given in the string:

model = "models/player/Group03/Female_01.mdl"

A table, the model of the player holding this job is randomly chosen from the list of given models:

model = {
		"models/player/Group03/Female_01.mdl",
		"models/player/Group03/Female_02.mdl"
	}

description

The description of a job shows up in the F4 menu when selecting the job. Describe what your job does and what the use of it is.

weapons

The list of weapons people with this job spawn with (besides the default weapons) The following example means that the job spawns with the weapons in the list:

weapons = {"arrest_stick", "unarrest_stick", "weapon_deagle2", "stunstick", "door_ram", "weaponchecker"}

command

What do you have to enter in chat to get this job? example: type /example in chat to get the example job

command = "example"

Note: If the job requires voting, a command "/voteexample" is added.

max

How many people can have this job at any given time.

salary

The salary this job gets.

admin

What (admin) access you need to get this job.

admin = 0 -- anyone can get this job
admin = 1 -- only admins can get this job
admin = 2 -- only superadmins can get this job

If you want to customize this further (with donators, moderators and whatnot), look at customCheck (scroll down)

vote

Do players need to create a vote to get this job? true for yes, false for no.

hasLicense

Does this job get a gun license for free? true for yes, false for no. It's useful to give the cops gun licenses.

NeedToChangeFrom

You can only get this job if you had a specific other job first. Example: You can only become a chief of police when you're already a CP:

NeedToChangeFrom = TEAM_POLICE

Example 2: You can only become a mayor if you're either a CP or a chief

NeedToChangeFrom = {TEAM_CHIEF, TEAM_POLICE}

help

The help text that shows up for this job when the player opens the F1 help menu.

customCheck

See here for an example with donator jobs.

CustomCheckFailMsg

Custom message when someone tries and fails to get the job. See here.

modelScale

How big are the players that have this job?

modelScale = 1 -- the default size
modelScale = 1.2 -- 120% of the default size
modelScale = 0.9 -- 90% of the default size.

Don't make it too big or too small, people will get trouble with jumping and crouching.

maxpocket

The amount of items that can fit in the pocket of people having this job. If not set, it will revert to the setting in config.lua, which is set to 10 by default.

maps

In what maps this job will be available. This is just a list of maps.

candemote

Can people who have this job be demoted? By default hobo's and citizens cannot be demoted because it has no use to demote them.

mayor

People with this job can do things the mayor can do (create a lottery, accept warrants etc.)

chief

People with this job can do things the chief can do.

medic

People with this job can do things the medic can do.

cook

People with this job can do things the cook can do.

hobo

People with this job can do things the hobo can do.

More advanced fields

These fields are all implemented by using a function. If you're thinking of editing DarkRP files (especially gamemode_functions.lua!) first look at these functions. Always try to avoid having to edit DarkRP files.

CanPlayerSuicide

A function that decides whether players with this job can commit suicide. Arguments: Player ply

PlayerCanPickupWeapon

A function that decides whether players with this job can pick up a certain weapon Arguments: Player ply, Entity weapon

PlayerDeath

Called when a player dies Arguments: Player ply, Entity weapon, Entity killer

PlayerLoadout

Called when a player gets his weapons. Return true to prevent him from getting his default weapons! Arguments: Player ply

PlayerSelectSpawn

Called when a spawn is selected for this player. Arguments: Player ply, Entity spawn

PlayerSetModel

A function that decides what the model should be. ALWAYS return a model (string) if you implement this function. Arguments: Player ply

PlayerSpawn

Called when a player spawns Arguments: Player ply

PlayerSpawnProp

Called when a player attempts to spawn a prop Arguments: Player ply, string model

RequiresVote

Decides whether the player needs to make a vote to get the job. Note: overrides the vote field! (the vote field will have no effect when this is set)
Arguments: Player ply
Number team (DON'T use TEAM_BLA variables, that won't work!)
Example:

DescriptionPeople need to make a vote if there are three or more people who have this job. People DON'T need to make a vote if there are fewer than three people with this job.
Code
RequiresVote = function(ply, job) return #team.GetPlayers(job) >= 3 end

Another:

DescriptionVIPS can skip the vote
Code
RequiresVote = function(ply, job) return ply:GetNWString("usergroup") ~= "vip" end


ShowSpare1

Called when a player presses the F1 key Arguments: Player ply

ShowSpare2

Called when a player presses the F2 key Arguments: Player ply

Credits

Unknown Author

http://steamcommunity.com/id/nearbyplayer/ Making edits for the new update[DarkRP 2.5] + Adding Credits

skyarmyninja Adding a shorter version of the job code