OSSL Script Library/ModSendCommand - Revision history

Justincc at 20:38, 25 September 2013

2013-09-25T20:38:06Z

Vin seymore: Added a reference to ModInvoke

2012-11-04T14:45:41Z

Added a reference to ModInvoke

Vin seymore: Updated region module example for modSendCommand using interface INonSharedRegionModule

2012-11-04T14:11:01Z

Updated region module example for modSendCommand using interface INonSharedRegionModule

MakoBot: Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name

2012-03-04T06:47:29Z

Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name

MakoBot: Robot: Cosmetic changes

2012-03-04T03:40:49Z

Robot: Cosmetic changes

Fritigern: ModSendCommand moved to OSSL Script Library/ModSendCommand: Moving OSSL scripts to the library....

2011-08-20T11:11:50Z

ModSendCommand moved to OSSL Script Library/ModSendCommand: Moving OSSL scripts to the library....

Fritigern at 13:25, 19 November 2010

2010-11-19T13:25:08Z

Justincc: /* References */

2010-07-16T22:22:10Z

‎References

Justincc: New page: You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSim 0.6.9. This is an alternative to manual...

2010-07-16T22:21:51Z

New page: You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSim 0.6.9. This is an alternative to manual...

New page

You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSim 0.6.9. This is an alternative to manually patching in new script functions. Here's an example of how to do this.

== Enabling modSendCommand() ==

The first thing is to enable modSendCommand() in OpenSim.ini. Make sure the line

<pre>
AllowMODFunctions = true
</pre>

is set to true and uncommented.

== The Region Module ==

Secondly, we need a region module to listen for the data sent by modSendCommand() and send a reply.

<pre>
using System;
using Nini.Config;
using OpenMetaverse;
using OpenSim.Region.Framework.Interfaces;
using OpenSim.Region.Framework.Scenes;

namespace ModSendCommandExample
{
public class MyRegionModule : IRegionModule
{
Scene m_scene;
IScriptModuleComms m_commsMod;

public string Name { get { return "MyRegionModule"; } }
public bool IsSharedModule { get { return false; } }
public void Close() {}

public void Initialise(Scene scene, IConfigSource source)
{
m_scene = scene;
}

public void PostInitialise()
{
m_commsMod
= m_scene.RequestModuleInterface<IScriptModuleComms>();
m_commsMod.OnScriptCommand += ProcessScriptCommand;
}

void ProcessScriptCommand(
UUID scriptId,
string reqId, string module, string input, string k)
{
if ("MYMOD" != module)
return;

string[] tokens
= input.Split(
new char[] { '|' }, StringSplitOptions.None);

string command = tokens[0];
switch (command)
{
case "Greet":
string name = tokens[1];
m_commsMod.DispatchReply(scriptId, 1, "Hello " + name, "");
break;
}
}
}
}
</pre>

The module subscribes to the OnScriptCommand IScriptModuleComms event in PostInitialise(). When a script command event occurs, it checks that the module identifier is correct (MYMOD) and then splits the command into components delimited by a bar (|). This isn’t essential - it’s just one way of invoking arbitrary commands.

In this case, the command name is the first component. If it’s “Greet”, then a reply is sent back using the supplied name argument which is the second component.

== The In-world Script ==

Here’s the in-world script that makes the call and receives the reply.

<pre>
default
{
touch_start(integer total_number)
{
modSendCommand("MYMOD", "Greet|World", "");
}

link_message(integer sender_num, integer num, string message, key id)
{
if (sender_num == -1)
{
llSay(0, message);
}
}
}
</pre>

As you can see, a touch triggers the command to the module. The script receives back the link_message event and says the data in-world.

You can download compilable region module source and script code for this example from [http://justincc.org/downloads/src/ModSendCommandExample-1.0.zip here].

== References ==

At the moment, this page is a rather simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].

← Older revision		Revision as of 20:38, 25 September 2013
Line 1:		Line 1:
	You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSimulator 0.6.9. This is an alternative to manually patching in new script functions. Here's an example of how to do this.		You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSimulator 0.6.9. This is an alternative to manually patching in new script functions. Here's an example of how to do this.
		+
		+	See also [[OSSL_Script_Library/ModInvoke]] for a later extension of this functionality which allows you to patch in completely new script functions from region modules.

	== Enabling modSendCommand() ==		== Enabling modSendCommand() ==

← Older revision		Revision as of 14:45, 4 November 2012
Line 180:		Line 180:

	At the moment, this page is a simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].		At the moment, this page is a simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].
		+
		+	Another method for in-world script / region module data exchange is [[OSSL Script Library/ModInvoke]].

	[[Category:Scripts]]		[[Category:Scripts]]

← Older revision		Revision as of 06:47, 4 March 2012
Line 1:		Line 1:
−	You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in ~~OpenSim~~ 0.6.9. This is an alternative to manually patching in new script functions. Here's an example of how to do this.	+	You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSimulator 0.6.9. This is an alternative to manually patching in new script functions. Here's an example of how to do this.

	== Enabling modSendCommand() ==		== Enabling modSendCommand() ==

← Older revision		Revision as of 13:25, 19 November 2010
Line 102:		Line 102:

	At the moment, this page is a simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].		At the moment, this page is a simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].
		+
		+
		+
		+	[[Category:Scripts]]

← Older revision		Revision as of 22:22, 16 July 2010
Line 101:		Line 101:
	== References ==		== References ==

−	At the moment, this page is a ~~rather~~ simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].	+	At the moment, this page is a simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].

← Older revision		Revision as of 14:11, 4 November 2012
Line 72:		Line 72:

	In this case, the command name is the first component. If it’s “Greet”, then a reply is sent back using the supplied name argument which is the second component.		In this case, the command name is the first component. If it’s “Greet”, then a reply is sent back using the supplied name argument which is the second component.
		+
		+	== The Region Module Revisited ==
		+
		+	This is an alternate version of the previous region module example. It addresses the new region module mechanism, which has been in place since at least 0.6.9.
		+
		+	Specifically the newer interface INonSharedRegionModule is being used here. The in-world script stays untouched.
		+
		+	<source lang="csharp">
		+	using System;
		+	using System.Reflection;
		+	using Mono.Addins;
		+	using Nini.Config;
		+	using OpenSim.Region.Framework.Interfaces;
		+	using OpenSim.Region.Framework.Scenes;
		+	using OpenMetaverse;
		+
		+	[assembly: Addin("MyRegionModule", "0.1")]
		+	[assembly: AddinDependency("OpenSim", "0.5")]
		+
		+	namespace ModSendCommandExample
		+	{
		+	[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule")]
		+	public class MyRegionModule : INonSharedRegionModule
		+	{
		+	private Scene m_scene = null;
		+	private IScriptModuleComms m_commsMod = null;
		+
		+	public string Name
		+	{
		+	get {
		+	return "MyRegionModule";
		+	}
		+	}
		+
		+	public Type ReplaceableInterface
		+	{
		+	get {
		+	return null;
		+	}
		+	}
		+
		+	public void Initialise(IConfigSource source) {}
		+
		+	public void Close() {}
		+
		+	public void AddRegion(Scene scene)
		+	{
		+	m_scene = scene;
		+	}
		+
		+	public void RemoveRegion(Scene scene) {}
		+
		+	public void RegionLoaded(Scene scene)
		+	{
		+	m_commsMod = m_scene.RequestModuleInterface<IScriptModuleComms>();
		+	m_commsMod.OnScriptCommand += ProcessScriptCommand;
		+	}
		+
		+	void ProcessScriptCommand(UUID scriptId, string reqId, string module, string input, string k)
		+	{
		+	if ("MYMOD" != module)
		+	return;
		+
		+	string[] tokens = input.Split(new char[] { '\|' }, StringSplitOptions.None);
		+
		+	string command = tokens[0];
		+	switch (command)
		+	{
		+	case "Greet":
		+	string name = tokens[1];
		+	m_commsMod.DispatchReply(scriptId, 1, "Hello " + name, "");
		+	break;
		+	}
		+	}
		+
		+	}
		+	}
		+	</source>

	== The In-world Script ==		== The In-world Script ==

@@ Line 1: / Line 1: @@
-You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSim 0.6.9.  This is an alternative to manually patching in new script functions.  Here's an example of how to do this.
+You can pass data back and forth between region modules and scripts using a script function called modSendCommand() which was introduced in OpenSim 0.6.9. This is an alternative to manually patching in new script functions. Here's an example of how to do this.
 == Enabling modSendCommand() ==
-The first thing is to enable modSendCommand() in OpenSim.ini.  Make sure the line
+The first thing is to enable modSendCommand() in OpenSim.ini. Make sure the line
 <pre>
@@ Line 69: / Line 69: @@
 </pre>
-The module subscribes to the OnScriptCommand IScriptModuleComms event in PostInitialise().  When a script command event occurs, it checks that the module identifier is correct (MYMOD) and then splits the command into components delimited by a bar (|).  This isn’t essential - it’s just one way of invoking arbitrary commands.
+The module subscribes to the OnScriptCommand IScriptModuleComms event in PostInitialise(). When a script command event occurs, it checks that the module identifier is correct (MYMOD) and then splits the command into components delimited by a bar (|). This isn’t essential - it’s just one way of invoking arbitrary commands.
-In this case, the command name is the first component.  If it’s “Greet”, then a reply is sent back using the supplied name argument which is the second component.
+In this case, the command name is the first component. If it’s “Greet”, then a reply is sent back using the supplied name argument which is the second component.
 == The In-world Script ==
@@ Line 95: / Line 95: @@
 </pre>
-As you can see, a touch triggers the command to the module.  The script receives back the link_message event and says the data in-world.
+As you can see, a touch triggers the command to the module. The script receives back the link_message event and says the data in-world.
 You can download compilable region module source and script code for this example from [http://justincc.org/downloads/src/ModSendCommandExample-1.0.zip here].
@@ Line 102: / Line 102: @@
 At the moment, this page is a simplified version of [http://justincc.org/blog/2010/07/16/passing-data-between-a-script-and-a-region-module-with-modsendcommand this blog post].
 [[Category:Scripts]]