My PvPTitles NPC Docs and Config Guide

[Devilsadvocate]

PvPTitlesNPC Documentation and Configuration Guide

Table of Contents

1. Notes From The Author
2. What's New
3. Default Requirements
4. Configuring The Script
5. Development Info

Chapter 1:: Notes From The Author
Ok, I've added new titles to the NPC, look in "What's New" section for more details.
Included "defines" for script values so everything is easy to customize.
Completely rewrote the selection functions so that now when a player purchases a title the previous title held is removed and replaced with newly selected title and added a fallback feature to beginning titles to insure that once a player purchases a title they cannot accidentally reset there progress thru the title line as that can be annoying. This also means that the player must have the preceeding title in the line to acquire the one they're attempting to buy except on the beginning titles.

Chapter 2:: What's New
New Titles Added:

• Duelist
• Rival
• Challenger
• Conqueror (Horde)
• Justicar (Alliance)
• Gladiator
• Merciless Gladiator
• Vengeful Gladiator

Since the titles on the previous release of this script gave players great incentive to participate in Battlegrounds, I oriented these titles to provide an incentive for Arena participation.

Title Requirements Menu:
Ok, this feature was added to make customizing the script noob friendly. When I was implementing the "defines" for script configurization, I noticed that others would still have to locate the Title Menus and modify the requirements txt for every change you make. The way this Menu works is when you select a title to view the requirements, it broadcasts a message to the player with the values set in the "defines." Here's an example:

If you have the requirement values for the title "Grunt" set like this:

#define HK_2 500 <-- (Honorable Kill Requirement)

#define GOLD_2 1500000 <--(Gold Requirement)

You will set the value for "GINFO_2 like this:

#define GINFO_2 150

And when you select a title to view the requirement, the client will broadcast a message in chat like this:

Grunt Requirements: 500 Honorable Kills, 150 Gold

I'll explain why we use the GINFO_ define in the Configuration section.

Chapter 3:: Default Requirements
The Requirements by default in the script are set as follows:

• Scout - Private
  100 Hks & 50 gold
• Grunt - Corporal
  300 Hks & 100 gold
• Sergeant - Sergeant
  600 Hks & 150 gold
• Senior Sergeant - Master Sergeant
  900 Hks & 200 gold
• First Sergeant - Sergeant Major
  1200 Hks & 250 gold
• Stone Guard - Knight
  1500 Hks & 300 gold
• Blood Guard - Knight Lieutenant
  1800 Hks & 350 gold
• Legionaire - Knight Captain
  2100 Hks & 400 gold
• Centurion - Knight Champion
  2500 Hks & 500 gold
• Champion - Lieutenant Commander
  3000 Hks & 650 gold
• Lieutenant General - Commander
  6000 Hks & 800 gold
• General - Marshal
  10k Hks & 1k gold
• Warlord - Field Marshal
  15k Hks & 1.5k gold
• High Warlord - Grand Marshal
  20k Hks & 2k gold
• Duelist
  200 ArenaPoints & 1550 Personal Arena Rating
• Rival
  400 ArenaPoints & 1600 Personal Arena Rating
• Challenger
  600 ArenaPoints & 1650 Personal Arena Rating
• Conqueror - Justicar
  800 ArenaPoints & 1700 Personal Arena Rating
• Gladiator
  1000 ArenaPoints & 1800 Personal Arena Rating
• Merciless Gladiator
  1500 ArenaPoints & 1900 Personal Arena Rating
• Vengeful Gladiator
  2000 ArenaPoints & 2000 Personal Arena Rating

Basically, if you like the default values then don't change the "defines" values.

Chapter 4:: Configuring The Script
Ok, now we'll take a closer look at the script and learn what those defines are.
Before we read any further, you may notice that the defines are in # order(HK_1 - HK_14, etc..). Here's a diagram that shows us which titles are linked to with #s:

• Scout - Private = 1
• Grunt - Corporal = 2
• Sergeant - Sergeant = 3
• Senior Sergeant - Master Sergeant = 4
• First Sergeant - Sergeant Major = 5
• Stone Guard - Knight = 6
• Blood Guard - Knight Lieutenant = 7
• Legionaire - Knight Captain = 8
• Centurion - Knight Champion = 9
• Champion - Lieutenant Commander = 10
• Lieutenant General - Commander = 11
• General - Marshal = 12
• Warlord - Field Marshal = 13
• High Warlord - Grand Marshal = 14
• Duelist = 1
• Rival = 2
• Challenger = 3
• Conqueror - Justicar = 4
• Gladiator = 5
• Merciless Gladiator = 6
• Vengeful Gladiator = 7

Ledger:
Cyan = Define Name
Orange = Title #
Yellow = Value

HK_ Defines
These are used to define the values for Honorable Kill Requirements.
Example:

#define HK_2 300

Here we see that we have set the Honorable Kill Requirement for the titles "Grunt & Corporal" to 300

GOLD_ Defines
These are used to define the values for gold costs. This is in Copper format (00g 00s 00c) so 100g would look like 1000000
Example:

#define GOLD_2 1000000

Here we define the gold requirement for the titles Grunt and Corporal as 100g 00s 00c.

GINFO_ Defines
These are used by the Requirements menu to display the gold cost requirement for titles in only gold format. We do this because emus only recognize coinage in "Copper" format. If we simply used the GOLD_ define for the requirements menu values it would Broadcast this:

Grunt Requirements: 300 Honorable Kills & 1000000 gold

As you can see that would raise alot of issues so we use the GINFO_ defines in only "Gold" format so it displays the correct gold cost.
So If we have the requirement for Grunt and Corporal set to:

#define GOLD_2 1000000

We would define GINFO_2 like so:

GINFO_2 100

Remember: What ever you set GOLD_ define values to, you want to make sure to set the correct GINFO_ define to match.

ARENA_ Defines
These are used to define how many Arena Points a title costs.
Example:

#define ARENA_2 400

Here we define the ArenaPoint cost for the title "Rival" to cost 400 points.
(Note: The newly added World PvP Titles are Arena Oriented which means you purchase these titles with Arena currency)

ARATING_ Defines
These are used to define what the required Personal Arena Rating for each title is.
Example:

#define ARATING_2 1650

Here we see that we have defined the Rating requirement for the title "Rival" as 1650.

NPC_ID Define
You should already know what this is for but if not, It's used to define the NPCs ID that this script is linked to.
Example:

#define NPC_ID 55562

So, here we have set the script to link with the NPC "55562"

Ok, well that's it for the configs.
Enjoy the script!

[Devilsadvocate]

Updated guide.....

[Chrommie]

1st!!!!!!!!!!!!!! nice :P

[yannick0007]

well great job =) nice guide

[kirasha]

workin good

[fokui]

People really need guides to set this up even with the noob friendly defines? :banghead:
Either way good work I suppose.

[Devilsadvocate]

People really need guides to set this up even with the noob friendly defines? :banghead:
Either way good work I suppose.

lol it surprizes me too bro lol

[dirtaa]

thanks nice good job +rep clean guide helped