XEngine - Revision history

Justincc at 21:16, 8 January 2015

2015-01-08T21:16:30Z

Justincc: /* ScriptStopStrategy */

2014-07-15T00:07:44Z

‎ScriptStopStrategy

Justincc: Add AppDomainLoading and DeleteScriptsOnStartup settings to example ini

2014-07-14T20:12:29Z

Add AppDomainLoading and DeleteScriptsOnStartup settings to example ini

Justincc: Add info on ScriptStopStrategy

2014-07-14T20:10:52Z

Add info on ScriptStopStrategy

Justincc: /* WARNING! Do NOT copy the section below to your OpenSim.ini! */

2014-07-14T19:54:47Z

‎WARNING! Do NOT copy the section below to your OpenSim.ini!

Justincc: /* WARNING! Do NOT copy the section below to your OpenSim.ini! */

2014-07-14T19:41:02Z

‎WARNING! Do NOT copy the section below to your OpenSim.ini!

Justincc at 19:52, 9 April 2013

2013-04-09T19:52:36Z

Justincc at 19:51, 9 April 2013

2013-04-09T19:51:57Z

Justincc: /* The XEngine Script Engine */

2013-04-09T19:34:32Z

‎The XEngine Script Engine

Justincc: /* The XEngine Script Engine */

2013-04-09T19:29:51Z

‎The XEngine Script Engine

@@ Line 169: / Line 169: @@
 * Resetting other scripts (XEngine only)
 * Stopping/starting other scripts (XEngine only)
 = State persistence =

← Older revision		Revision as of 00:07, 15 July 2014
Line 147:		Line 147:

	From OpenSimulator 0.7.6 to 0.8, if this setting was changed from "abort" to "co-op", then the compiled script cache would either need to be manually cleared or OpenSimulator started with DeleteScriptsOnStartup = true for one session.		From OpenSimulator 0.7.6 to 0.8, if this setting was changed from "abort" to "co-op", then the compiled script cache would either need to be manually cleared or OpenSimulator started with DeleteScriptsOnStartup = true for one session.
		+
		+	As of git master d7b92604 OpenSimulator development code (11th July 2014), this setting can now be switched without any other user action being required. The recompiled DLLs will be used on the next simulator restart.

	== OS Functions enable/disable ==		== OS Functions enable/disable ==

@@ Line 63: / Line 63: @@
   ThreadStackSize = 262144
      ''The stack size each script thread runs with. The default also represents the minimum''
   ; Controls whether scripts are stopped by aborting their threads externally (abort)

@@ Line 29: / Line 29: @@
 XEngine has a number of configuration options in OpenSim.ini, which are listed below, with an explanation and the default values:
-=== WARNING! Do NOT copy the section below to your OpenSim.ini! ===
+''' WARNING! Do NOT copy the section below to your OpenSim.ini! '''
 ''Use the template provided in OpenSim.ini.example. The section below contains syntactically incorrect documentation text, which is not meant to be placed in the OpenSim.ini file!
@@ Line 120: / Line 120: @@
 </source>
-=== OS Functions enable/disable ===
+== ScriptStopStrategy ==
 For each function, you can add one line, as shown

@@ Line 63: / Line 63: @@
   ThreadStackSize = 262144
      ''The stack size each script thread runs with. The default also represents the minimum''
   ; Rate to poll for asynchronous command replies (ms)

@@ Line 32: / Line 32: @@
 ''Use the template provided in OpenSim.ini.example. The section below contains syntactically incorrect documentation text, which is not meant to be placed in the OpenSim.ini file!
   [XEngine]
   ; Allow the XEngine to run
@@ Line 109: / Line 110: @@
   OSFunctionThreatLevel = VeryLow
      ''osFunctions are rated by exploitability. This allows balancing functionality and risk
+</source>
 === OS Functions enable/disable ===
 For each function, you can add one line, as shown

@@ Line 6: / Line 6: @@
 This is a fully functional, full featured script engine which supports persistent script states and script state serialization.
-This engine is enabled by default.  If you do need to enable it manually, make sure that the following line is present in your OpenSim.ini [Startup] section:
+This engine is enabled by default.
-−
- DefaultScriptEngine = "XEngine"
 For each unique script asset, XEngine will create up to 4 files.  These are:
@@ Line 24: / Line 22: @@
 = Configuration =
 XEngine has a number of configuration options in OpenSim.ini, which are listed below, with an explanation and the default values:

@@ Line 1: / Line 1: @@
 {{Quicklinks}}
 <br />
-== The XEngine Script Engine ==
+=Summary=
 This is a fully functional, full featured script engine which supports persistent script states and script state serialization.
@@ Line 11: / Line 10: @@
   DefaultScriptEngine = "XEngine"
-The XEngine will create up to 4 files for each script, these are:
+For each unique script asset, XEngine will create up to 4 files.  These are:
-* .dll, the actual executable file
+* '''CommonCompiler_compiled_<script-asset-id>.dll''', the actual executable DLL for that script asset.
-* On mono, .mdb, the debug data file (necessary for resolving line numbers).
+* On mono, '''CommonCompiler_compiled_<script-asset-id>.mdb''', the debug data file (necessary for resolving line numbers).
-* On Windows, .pdb, the debug data file (necessary for resolving line numbers).
+* On Windows, '''CommonCompiler_compiled_<script-asset-id>.pdb''', the debug data file (necessary for resolving line numbers).
-* .state, the saved state of the script.
+* '''CommonCompiler_source_CommonCompiler_compiled_<script-asset-id>.cs''', if WriteScriptSourceToDebugFile = true in [XEngine] in OpenSim.ini.  This is the C# source file as translated from the source language (e.g. from LSL) before compilation.
-Each file will have a UUID embedded which is the ID of the prim inventory item that contains the script.
+If scripts contain identical source code then there can be more than one script using the same code.  However, they will maintain separate state files to record the script's individual state.  These are labelled
-If WriteScriptSourceToDebugFile = true in [XEngine] in OpenSim.ini then there will also be:
+* '''<script-item-id>.state'''
-* .cs, the c# source file converted from the original script if applicable (e.g. when using LSL as the script language).
+For more information on state files, see below.
 XEngine has a number of configuration options in OpenSim.ini, which are listed below, with an explanation and the default values:
@@ Line 127: / Line 128: @@
 * Stopping/starting other scripts (XEngine only)
-=== State persistence ===
+= State persistence =
-XEngine persists state and variable values across region restarts
+XEngine persists state and variable values for individual script instances across region restarts.  This is stored in a .state file.  When a script is deleted, the .state file is also deleted.
 [[Category:Modules]]