From 5928d78ba18fafbf4c8b6f4b8d7600df7ccf1d02 Mon Sep 17 00:00:00 2001
From: Haru <haru@dotalux.com>
Date: Wed, 22 Oct 2014 20:54:34 +0200
Subject: Improved bindatcmd handling of spaces in parameters.

- Parameters passed to bindatcmd-invoked labels are now properly
  space-delimited.
- This is in order to support strings containing multiple spaces or
  containing a trailing space. Previously it was impossible to create a
  bindatcmd command that could accept a player name such as
  'This name has  two spaces' or 'Sir Trailingspace '.
- Added documentation and usage examples, especially wrt space handling.
  See doc/script_commands.txt for details.
- NOTE: Your custom atcommand labels may need edits, as we're no longer
  trimming multiple sequantial spaces or trailing spaces, in order to
  gain more flexibility. It is your care to do that.
- Special thanks to Dastgir, jaBote.

Signed-off-by: Haru <haru@dotalux.com>
---
 doc/script_commands.txt | 58 ++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 53 insertions(+), 5 deletions(-)

(limited to 'doc')

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 0af9644dd..d0acbf1c8 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7250,12 +7250,16 @@ when not provided, "group level char" defaults to 99.
 (1 = log, 0 = no log), default is to not log.
 
 The following variables are set upon execution:
-	.@atcmd_command$       =  The name of the @command used.
-	.@atcmd_parameters$[]  =  Array containing the given parameters, 
-                              starting from an index of 0.
-	.@atcmd_numparameters  =  The number of parameters defined.
+	.@atcmd_command$      =  The name of the @command used.
+	.@atcmd_parameters$[] =  Array containing the given parameters,
+	                         starting from an index of 0.
+	.@atcmd_numparameters =  The number of parameters defined.
 
-Example:
+Parameters are split on spaces. Multiple spaces aren't grouped together, and
+will create multiple (empty) arguments.
+Any leading spaces before the first parameter will be omitted.
+
+Usage example:
 
 When a user types the command "@test", an angel effect will be shown.
 
@@ -7268,6 +7272,50 @@ OnAtcommand:
 	end;
 }
 
+Parameter splitting example:
+	@mycommand
+		.@atcmd_numparameters -> 0
+		.@atcmd_parameters$   -> { }
+	@mycommand<space><space>
+		.@atcmd_numparameters -> 0
+		.@atcmd_parameters$   -> { }
+	@mycommand<space>foo
+		.@atcmd_numparameters -> 1
+		.@atcmd_parameters$   -> { "foo" }
+	@mycommand<space><space>foo
+		.@atcmd_numparameters -> 1
+		.@atcmd_parameters$   -> { "foo" }
+	@mycommand<space>foo<space>bar
+		.@atcmd_numparameters -> 2
+		.@atcmd_parameters$   -> { "foo", "bar" }
+	@mycommand<space>foo<space><space>bar
+		.@atcmd_numparameters -> 3
+		.@atcmd_parameters$   -> { "foo", "", "bar" }
+	@mycommand<space>foo<space>
+		.@atcmd_numparameters -> 2
+		.@atcmd_parameters$   -> { "foo", "" }
+	@mycommand<space>foo<space><space>
+		.@atcmd_numparameters -> 3
+		.@atcmd_parameters$   -> { "foo", "", "" }
+
+The called event label needs to take care of joining arguments together, in
+case it expects spaces. For example:
+
+-	script	atcmd_example	-1,{
+OnInit:
+	bindatcmd "test",strnpcinfo(3)+"::OnAtcommand";
+	end;
+OnAtcommand:
+	// This command expects a character name (that may contain spaces) as
+	// the only parameter.
+	.@name$ = "";
+	for (.@i = 0; .@i < .@atcmd_numparameters; ++.@i) {
+		.@name$ += (.@i > 0 ? " " : "") + .@atcmd_parameters$[.@i];
+	}
+	dispbottom("The specified name is: '" + .@name$ + "'");
+	end;
+}
+
 ---------------------------------------
 
 *unbindatcmd "command";
-- 
cgit v1.2.3-70-g09d2