NPC Support and className fix for the editor

--- NPC SUPPORT 1/2---
What is a NPC here?
Maybe you understand it in another way, but this is how I do.
A Player is a humand person playing the game.
A Bot is an AI controlled character with the same opportunities as a player. In fact it simulates one.
A NPC is much more limited. In our game, it cannot enter vehicles, pickup flags, score or chat. AND it does not require a player slot, because it does not use a connection.

First, we have a default datablock with all the data similar for NPCs and Players.

datablock PlayerData(DefaultArmor) { };

I recommend to remove the className (=Armor) field, if there is any, normally under emap. Same for cmdCategory (="Clients").

Now we have two different datablocks.

datablock PlayerData(NPCArmor : DefaultArmor)
{
	className= NPC;   // NPC class
	category= "NPC";   // Add to editor
	cmdCategory= "NPCs";
	
	name= "Black Hawk Leader";
	has[Hammer]= true;
};

datablock PlayerData(PlayerArmor : DefaultArmor)
{
	className= Armor;
	cmdCategory= "Clients";
	
	maxInv[Flag1]= 1;
	maxInv[Flag2]= 1;
	maxInv[Flag3]= 1;
};

I included an example why to use two different datablocks.
In our project, a NPC cannot pickup the flag, as you see, only the player/bot can.
An NPC can get a special name and can be equiped.

For adding the NPC to the game, we need a create function.

function NPC::create(%datablock)
{
	// Create the player object
	%obj= new Player()
	{
		dataBlock= %datablock;
	};
	
	//%obj.setControlObject(%player); //   <- AI here
	
	return %obj;
}

But that is not all. There is a bug within the editor which let it call the PlayerData::create function. Fix this now, but we are not finished, yet.

--- EDITOR FIX ---
EditorGui.cs

// ---------- SHAPES - add in all the shapes now...

...

CHANGE:

%this.addItem(%grp, %obj.getName(), %obj.getClassName() @ "::create(" @ %obj.getName() @ ");");

TO:

if( (%obj.className !$="") && (%obj.getClassName !$=%obj.className) )
	%this.addItem(%grp, %obj.getName(), %obj.className @ "::create(" @ %obj.getName() @ ");");
else %this.addItem(%grp, %obj.getName(), %obj.getClassName() @ "::create(" @ %obj.getName() @ ");");

--- NPC SUPPORT 2/2---
Let us have a look at the datablocks again.

datablock PlayerData(NPCArmor : DefaultArmor)
{
	className= NPC;   // NPC class
	category= "NPC";   // Add to editor
	cmdCategory= "NPCs";
	
	name= "Black Hawk Leader";
	has[Hammer]= true;
};

datablock PlayerData(PlayerArmor : DefaultArmor)
{
	className= Armor;
	cmdCategory= "Clients";
	
	maxInv[Flag1]= 1;
	maxInv[Flag2]= 1;
	maxInv[Flag3]= 1;
};

Now, NPCs and players have two different classes, which also causes that they need different functions.

Copy all Armor:: functions and rename them to NPC::. I create a new 'server/scripts/npc.cs'.
Now remove all client stuff and if you do not want them to enter vehicles, you can remove the mount functions, too.

If you are making a RPG, you can expand you onAdd function a little bit.

function NPC::onAdd(%this,%obj)
{
	%data= %obj.getDatablock();
	// Vehicle timeout
	%obj.mountVehicle= false;

	// Default dynamic NPC stats
	%obj.setRechargeRate(%this.rechargeRate);
	%obj.setRepairRate(0);
	
		if(%data.has[Hammer])   // Equip Character
			%obj.incInventory(Hammer, %data.has[Hammer]);
		
		if(%data.has[Mattock])   // Equip Character
			%obj.incInventory(Mattock, %data.has[Mattock]);
		
		if(%obj.name !$="")   // If it is a special character,you can give him/her a name.
			%obj.setShapeName(%obj.name);
	
	%obj.startFade(2000, 0, false);
}

Now, it should work. Modify your NPC:: functions as you need them.

A little hint: When you add a NPC and he/her is dropped to the ground, it might happen that he/her falls through the terrain. Use another kind of dropping instead.

Have fun.