SA-MP Forums

Go Back   SA-MP Forums > SA-MP Scripting and Plugins > Filterscripts > Includes

Reply
 
Thread Tools Display Modes
Old 01/06/2015, 08:02 AM   #1
Yashas
Gangsta
 
Join Date: Jun 2012
Location: India
Posts: 878
Reputation: 313
Default [I-ZCMD]Improved ZCMD - Fastest Command Processor

Improved ZCMD
Latest Version:0.2.3.0 (August 2016)

NOTE: Please do not credit me for the include. The original concept is from ZCMD. This is just a useless optimized (practically insignificant) cleaner version of ZCMD with one bug fixed.

ZCMD hasn't been updated in the last 6 years. We (the SAMP community) have advanced a lot in these years and these advancements haven't been implemented in ZCMD. I just re-wrote ZCMD 0.3.1 include and updated it. This is now a lot faster (still negligible) than ZCMD which makes this the fastest 'PAWN code' based Command Processor at the moment. The speed test results are given at the end of this thread. iZCMD also addresses few issues/bugs with ZCMD and also adds some new features (Case-sensitivity can be turned on/off using a define).

The great improvement in efficiency can be observed when you have small commands(commands which do not take a lot of CPU). If you have just one format function call in your command, I-ZCMD will be almost 2x faster than ZCMD. If you have 10 format calls in your command, I-ZCMD will be 1.5x faster than ZCMD.The main reason why I-ZCMD is amazingly fast when compared to ZCMD is because I-ZCMD gets rid of two CallLocalFunction(very slow function) calls. However, this improvement is negligible compared to the overall performance of your server which means don't expect your server to show measurable improvements after installing iZCMD. Anyway, its always advisable to use updated includes.

Changes from ZCMD:
  • OnPlayerCommandReceived & OnPlayerCommandPerformed are now called directly instead of using CallLocalFunction
  • Removed the OnGameModeInit/OnFilterscriptInit Hooks
  • Minor optimizations
  • Case Sensitivity now toggled on/off using a define
  • Addresses few ZCMD bugs

How to install?
For those who are already using ZCMD, you just need to replace ZCMD include with IZCMD include.There is no change in functionality (by default), all the changes affect the speed and efficiency of the script. The only new feature in I-ZCMD is that now case-sensitivity can be turned on/off by defining IZCMD_ENABLE_CASE_SENSITIVITY before including IZCMD. To maximize compatibility, iZCMD is not case-sensitive by default (ZCMD is not case-sensitive).

For those who are not using ZCMD, you need to download I-ZCMD include and paste it in your include folder. Any ZCMD tutorial will do for I-ZCMD since the syntax and functionality are the same in both.

How to use?
To create a command, all you need to do is create a public function using any of the given formats.

Code:
COMMAND:yourcommand(playerid,params[])
{
     return CMD_SUCCESS;
}
CMD:yourcommand(playerid,params[])
{
     return CMD_SUCCESS;
}
command(yourcommand,playerid,params[])
{
     return CMD_SUCCESS;
}
cmd(yourcommand,playerid,params[])
{
     return CMD_SUCCESS;
}
When a player types "/yourcommand parameters", the public function will be called.The playerid parameter will have the id of the player who used the command and the params[] parameter will have the text which the player typed after typing the command (for the given example, params[] will have "parameters").

The "params" parameter will never be empty. If the player did give any parameters then params[0] will be '\1'.

You must return CMD_SUCCESS if the command was executed successfully (return CMD_FAILURE if you wish the server to send the "Unknown Command" message). This result will be passed on to OnPlayerCommandPerformed.

You can also use the ZCMD style of returning, i.e: 1 for success and any other value for failure.

You cannot use OnPlayerCommandText once you include this include. It won't be called if you still have it in your code. There are two new callbacks instead.

OnPlayerCommandReceived
This callback is called before the actual command function is called.

Parameters:
  • playerid is the ID of the player who used the command
  • cmdtext is text which the player typed

Return Values:
1 - command function will be called
0 - the command function won't be called.

Code:
public OnPlayerCommandReceived(playerid,cmdtext[])
{
	return 1;
}
OnPlayerCommandPerformed
This callback is called after the command function is executed.

Parameters:
  • playerid is the ID of the player who used the command
  • cmdtext is text which the player typed
  • success is what the command function returned (CMD_SUCCESS or CMD_FAILURE)

Return Values:
0 or CMD_FAILURE - Player will see the Error Message, i.e "Unknown command"
1 or CMD_SUCCESS - The error message won't be sent

Code:
public OnPlayerCommandPerformed(playerid,cmdtext[], success)
{
	return success;
}
If you are not using OnPlayerCommandPerformed then what you return in your command function will decide if the Error Message will be sent or not.

Returning 0 or CMD_FAILURE in the command function means the error message will be sent.
Returning 1 or CMD_SUCCESS in the command function means the error message won't be sent.

Case-Sensitivity
Case Sensitivity is disabled by default which means that "/pm" and "/PM" will be treated to be the same. Case-sensitivity can be enabled by defining IZCMD_ENABLE_CASE_SENSITIVITY before you include izcmd to your script.

Tips & Tricks

1. Calling command functions manually
You can call a command function using the following code.

Code:
cmd_yourcommand(playerid,params);
You need to prefix "cmd_" to your command to call the command function.

2. Shortcut Commands
You can make shortcut commands using the idea given below.

Code:
COMMAND:arrest(playerid,params[])
{
     //your arrest code
     return CMD_SUCCESS; 
}
COMMAND:ar(playerid,params[])
{
     return cmd_arrest(playerid,params);
}
3. Disable Commands if player is not logged in
You can disable commands for a player who hasn't logged in using the following idea.

Code:
public OnPlayerCommandReceived(playerid,cmdtext[])
{
        if(!PlayerLoggedIn[playerid]) 
        {
               SendClientMessage(playerid,-1,"You need to log in to use commands");
               return 0;
        }
	return 1;
}
4. I-ZCMD with sscanf is the fastest way to process commands

Code:
COMMAND:setskin(playerid,params[])
{
      new skinid;
      if(sscanf(params,"i",skinid)) SendClientMessage(playerid,-1,"Usage:/setskin [skinid]");
      else SetPlayerSkin(playerid, skin);
      return CMD_SUCCESS;
}
More Examples
Code:
COMMAND:getvid(playerid,params[])
{
		new id,string[144],vid;
		if(sscanf(params,"u",id))
		{
			if(IsPlayerInAnyVehicle(playerid))
			{
			    vid = GetPlayerVehicleID(playerid);
			    format(string,sizeof(string),"The vehicle ID of your vehicle is %d.Use/getvid [Name/ID] to get vehicle ID of other player's vehicle.",vid);
				return SendClientMessage(playerid,-1,string);
		 	}
			return SendClientMessage(playerid,-1,"Your not in a vehicle nor you have specified any player from which to get the vehicle id.Use /getvid [Name/ID] to get the vehicle ID of their vehicle.");
	 	}
		if(IsPlayerConnected(id))
		{
		    if(IsPlayerInAnyVehicle(id))
		    {
                        new pName[MAX_PLAYER_NAME];
                        GetPlayerName(playerid,pName,MAX_PLAYER_NAME);
		        vid = GetPlayerVehicleID(id);
		        format(string,sizeof(string),"The vehicle ID of the vehicle which %s(%d) is using is %d.",pName,id,vid);
				SendClientMessage(playerid,-1,string);
			}
		    else
		    {
		        SendClientMessage(playerid,-1,"The given player is not using any vehicle.");
		    }
		}
		else { return SendClientMessage(playerid,-1,"Usage:/getvid:Invalid Player ID"); }
	}
	return CMD_SUCCESS;
}
Speed Tests
The test code approximately has 250 test commands out of which 6 valid commands are called and one invalid command is called.

The code which was used for speed test can be found here.

I-ZCMD (case-sensitive) is 5.4 times faster than ZCMD

I-ZCMD (non-case-sensitive) is 2.2 times faster than ZCMD

ZCMD and y_command perform equally well in cases such as in the above speed test where there are lot of commands.

Please note that if you need any of the y_command features, then use y_commands. If you try to implement a similar feature in iZCMD then iZCMD will most likely get slower than y_commands. Use iZCMD if and only if you don't use any of y_command features.

Download
Download izcmd.inc if you need the I-ZCMD include.

Download izcmd-original.inc if you need the original ZCMD Include

Visit GitHub Project Page

Credits
Zeex for the original ZCMD Include & the concept/algorithm.
Yashas for spending 60 minutes to update the include.

Last edited by Yashas; 04/03/2018 at 03:57 PM.
Yashas is offline   Reply With Quote
Old 01/06/2015, 08:19 AM   #2
SickAttack
Godfather
 
Join Date: Dec 2013
Posts: 5,095
Reputation: 754
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Nice one!
SickAttack is offline   Reply With Quote
Old 01/06/2015, 10:18 AM   #3
Manyula
Huge Clucker
 
Manyula's Avatar
 
Join Date: Jan 2012
Location: Germany
Posts: 286
Reputation: 47
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Using this straight away, thank you.
__________________
Manyula is offline   Reply With Quote
Old 01/06/2015, 10:36 AM   #4
HydraHumza
Gangsta
 
HydraHumza's Avatar
 
Join Date: Oct 2014
Posts: 635
Reputation: 130
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Why you delete the old topic? and why you create new topic for this?
HydraHumza is offline   Reply With Quote
Old 01/06/2015, 03:51 PM   #5
SickAttack
Godfather
 
Join Date: Dec 2013
Posts: 5,095
Reputation: 754
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Quote:
Originally Posted by Humza View Post
Why you delete the old topic? and why you create new topic for this?
A moderator deleted the old one and told him to create a new one to prevent confusions whether this include is faster than ZCMD or not, and to clean up the thread, I guess.
SickAttack is offline   Reply With Quote
Old 01/06/2015, 06:26 PM   #6
PT
Godfather
 
PT's Avatar
 
Join Date: Nov 2012
Location: Portugal
Posts: 7,213
Reputation: 780
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Simple and Nice.

Now keep update that to get better results
__________________
"Quem caiu e se levantou honrado era e honrado ficou..."


CVU vai voltar e.e


http://steamcommunity.com/id/pt_player/
PT is offline   Reply With Quote
Old 01/06/2015, 07:06 PM   #7
Pottus
Godfather
 
Pottus's Avatar
 
Join Date: Jun 2012
Posts: 5,245
Reputation: 1256
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Just to point out the benchmarks have very little relevance it is like trying to measure a piece of hair with a meter stick the scale does not match reality but still interesting to look at.
Pottus is offline   Reply With Quote
Old 01/06/2015, 07:37 PM   #8
hamzajaved780
Big Clucker
 
hamzajaved780's Avatar
 
Join Date: Jan 2015
Location: Karachi
Posts: 173
Reputation: 14
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Good work.....
btw Potus what you recommend??
__________________
hamzajaved780 is offline   Reply With Quote
Old 01/06/2015, 08:05 PM   #9
Mellnik
Gangsta
 
Mellnik's Avatar
 
Join Date: Dec 2011
Location: Paradise Falls, CAℕADA
Posts: 795
Reputation: 369
Default AW: [I-ZCMD]Improved ZCMD - Fastest Command Processor

What happened to the old thread.
Mellnik is offline   Reply With Quote
Old 01/06/2015, 08:39 PM   #10
Pottus
Godfather
 
Pottus's Avatar
 
Join Date: Jun 2012
Posts: 5,245
Reputation: 1256
Default Re: [I-ZCMD]Improved ZCMD - Fastest Command Processor

Quote:
Originally Posted by hamzajaved780 View Post
Good work.....
btw Potus what you recommend??
Well if I'm using YSI then y_commands otherwise another command processor of choice it really doesn't matter since the syntax of is same for all the standard command processor includes.
Pottus is offline   Reply With Quote
Reply

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
[Include] [INC] zcmd 0.3.1 | Fast & Simple Command Processor (updated 30/10/2009) Zeex Includes 573 08/10/2017 04:04 PM
[Include] y_commands - Most flexible and fastest command processor, now on the YSI wiki corne Includes 19 03/12/2015 02:41 AM
How to Use Zcmd or any other cmd Processor [Cali]ChrOnic_T Server Support 5 19/03/2012 07:38 PM


All times are GMT. The time now is 01:17 AM.


Powered by vBulletin® Version 3.8.6
Copyright ©2000 - 2019, Jelsoft Enterprises Ltd.