IRegionModule - Revision history

Manni at 12:16, 2 April 2024

2024-04-02T12:16:35Z

Steevithak: /* Where to go from here */ added link to orphaned page on child agent connections to regions

2020-09-15T15:05:00Z

‎Where to go from here: added link to orphaned page on child agent connections to regions

Ubit: /* From Scratch */

2019-09-26T16:35:35Z

‎From Scratch

Ubit: /* From Scratch */

2019-09-26T16:34:14Z

‎From Scratch

Ubit: /* Events */

2019-09-26T16:30:21Z

‎Events

Ubit: /* From Scratch */

2019-09-26T16:22:10Z

‎From Scratch

Ubit: /* From Scratch */

2019-09-26T16:19:54Z

‎From Scratch

Justincc: /* From Scratch */

2014-08-11T18:24:20Z

‎From Scratch

Justincc: /* Region Module Interfaces */

2014-07-08T17:24:51Z

‎Region Module Interfaces

Justincc: /* Region Module Interfaces */

2014-07-02T23:54:08Z

‎Region Module Interfaces

← Older revision		Revision as of 12:16, 2 April 2024
Line 1:		Line 1:
−	{{Quicklinks}}	+	{{Quicklinks\|IRegionModule}}
	<br />		<br />

@@ Line 388: / Line 388: @@
 * Read the source code for the EventManager class in the OpenSim.Region.Framework.Scenes project. These list the many events that exist. Some modules may also export their own events (e.g. OnInventoryArchiveSaved in the InventoryArchiverModule at OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/).
 * Help write some examples here. OpenSimulator grows with your contributions.
 [[Category:Development]]
 [[Category:Modules]]

@@ Line 64: / Line 64: @@
 There are a number of things to note about this file
-* The frameworkVersion should match the opensim one. See its setting in file prebuild.xml
+* The frameworkVersion should match the opensim one. See its setting in main opensim prebuild.xml file
 * The path attribute in <Project> needs to point to the location in the addon-modules directory where your source code is located.  This directory is relative to the root OpenSimulator path.  In the example above, the code is in addon-modules/BareBonesNonSharedModule/src/BareBonesNonSharedModule.
 * The <OutputPath> tags specify where your compiled module DLL is copied after it's built.  This is relative to the location of your source code as specified in the path attribute of <Project>.  In most cases, you want this to be placed in the OpenSimulator bin/ directory with the rest of the DLLs.  Do not place this in the bin/addon-modules directory - confusingly this is for addon-module configuration files (*.ini) only.

@@ Line 64: / Line 64: @@
 There are a number of things to note about this file
+* The frameworkVersion should match the opensim one. See its setting in file prebuild.xml
 * The path attribute in <Project> needs to point to the location in the addon-modules directory where your source code is located.  This directory is relative to the root OpenSimulator path.  In the example above, the code is in addon-modules/BareBonesNonSharedModule/src/BareBonesNonSharedModule.
 * The <OutputPath> tags specify where your compiled module DLL is copied after it's built.  This is relative to the location of your source code as specified in the path attribute of <Project>.  In most cases, you want this to be placed in the OpenSimulator bin/ directory with the rest of the DLLs.  Do not place this in the bin/addon-modules directory - confusingly this is for addon-module configuration files (*.ini) only.

← Older revision		Revision as of 16:30, 26 September 2019
Line 307:		Line 307:

	== Events ==		== Events ==
		+
		+
		+	<div style="background-color:#FFA0A0; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
		+	WARNING: most events are time critical. Your code must not delay them too much, like going a http connection...
		+	</div>

	Various occurrences in OpenSimulator (e.g. avatar entering a region, chat) have event hooks to which a module can subscribe. The major sets of events are available from Scene.EventManager.		Various occurrences in OpenSimulator (e.g. avatar entering a region, chat) have event hooks to which a module can subscribe. The major sets of events are available from Scene.EventManager.

@@ Line 31: / Line 31: @@
 <source lang="xml">
-<Project frameworkVersion="v4_0" name="BareBonesNonSharedModule" path="addon-modules/BareBonesNonSharedModule/src/BareBonesNonSharedModule" type="Library">
+<Project frameworkVersion="v4_6" name="BareBonesNonSharedModule" path="addon-modules/BareBonesNonSharedModule/src/BareBonesNonSharedModule" type="Library">
    <Configuration name="Debug">
      <Options>
@@ Line 55: / Line 55: @@
    <Files>
-     <Match pattern="*.cs" recurse="true"/>
+     <Match pattern="*.cs" recurse="true">
      <Match path="Resources" pattern="*.*" buildAction="EmbeddedResource"/>
    </Files>

@@ Line 186: / Line 186: @@
 <tr>
    <td>PostInitialise</td>
-   <td>Called after Initialise() but before modules are added.  This may be a bug - it might be that this should really be called after all the regions have been added.</td>
+   <td>Guaranteed to be called after Initialise() on all other modules has been called but before modules are added.</td>
 </tr>
 </table>

@@ Line 158: / Line 158: @@
    <td>
 * For a non-shared region module, this will be called when its region is closed.  This usually occurs on shutdown.  However, it's also possible for a region to be removed whilst the simulator remains running.
-* For a shared region module, this should be called when the simulator is shutdown.  '''However, due to a regression in OpenSimulator 0.8 (and probably in many earlier versions) this was not occurring.  This is fixed in current development code (from commit 889194d, 3rd July 2014).  In the mean time, the easiest workaround is to count the number of scenes added to the module and then shutdown if the same number are removed.  However, this will stop it being possible to operate a simulator with temporarily no regions (a somewhat minor use case).'''
+* For a shared region module, this should be called when the simulator is shutdown.  '''However, due to a regression in OpenSimulator 0.8 (and probably in many earlier versions) this was not occurring.  This is fixed in current development code (from commit 889194d, 3rd July 2014).  In the mean time, the easiest workaround is to count the number of scenes added to the module and then shutdown if the same number are removed.  However, this will stop it being possible to operate a simulator with temporarily no regions (a somewhat minor use case).  For an example of this approach, see https://github.com/justincc/EventRecordingModule/blob/master/src/EventRecorder/EventRecordingModule.cs'''
 </tr>
 </table>