OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Enumerations | Functions
Package OpenSim.Region.Framework.Interfaces

Classes

interface  ILandChannel
 
interface  IAgentAssetTransactions
 
interface  IAgentStatefulModule
 
interface  IAttachmentsModule
 
interface  IAvatarFactoryModule
 
interface  IBuySellModule
 
interface  ICapabilitiesModule
 
interface  ICloudModule
 
interface  ICommand
 
interface  ICommandableModule
 
interface  ICommander
 
interface  IDialogModule
 
interface  IDwellModule
 
class  FloaterData
 
interface  IDynamicFloaterModule
 
interface  IDynamicMenuModule
 
interface  IDynamicTextureManager
 
interface  IDynamicTextureRender
 
interface  IDynamicTexture
 
class  Email
 
interface  IEmailModule
 
interface  IEntityCreator
 Interface to a class that is capable of creating entities More...
 
interface  IEntityInventory
 Interface to an entity's (SceneObjectPart's) inventory More...
 
interface  IEntityTransferModule
 
interface  IUserAgentVerificationModule
 
interface  IEnvironmentModule
 
interface  IEstateModule
 
interface  IEventQueue
 
interface  IExternalCapsModule
 
interface  IFriendsModule
 
interface  IGodsModule
 This interface provides god related methods More...
 
interface  IGroupsMessagingModule
 Provide mechanisms for messaging groups. More...
 
interface  IGroupsModule
 
interface  IHttpRequestModule
 
interface  IInventoryAccessModule
 
interface  IInventoryArchiverModule
 
interface  IInventoryTransferModule
 An interface for a module that manages inter-agent inventory offers and transfers. More...
 
interface  IJ2KDecoder
 
struct  JsonStoreStats
 
interface  IJsonStoreModule
 
interface  ILightShareModule
 
interface  IMapImageUploadModule
 
interface  IMessageTransferModule
 
interface  IMoapModule
 Provides methods from manipulating media-on-a-prim More...
 
interface  INonSharedRegionModule
 
interface  INPC
 Temporary interface. More methods to come at some point to make NPCs more object oriented rather than controlling purely through module level interface calls (e.g. sit/stand). More...
 
interface  INPCModule
 
interface  IPermissionsModule
 
struct  PresenceInfo
 
interface  IPresenceModule
 
interface  IPrimCountModule
 
interface  IRegionArchiverModule
 Interface to region archive functionality More...
 
interface  IRegionCombinerModule
 
interface  IRegionConsole
 
interface  IRegionModuleBase
 
interface  IRegionModulesController
 
interface  IRegionReadyModule
 
interface  IRegionSerialiserModule
 
interface  IRestartModule
 
interface  ISceneCommandsModule
 
interface  IScenePresence
 An agent in the scene. More...
 
interface  IScriptModule
 
interface  IScriptModuleComms
 Interface for communication between OpenSim modules and in-world scripts More...
 
class  ScriptInvocationAttribute
 
class  ScriptConstantAttribute
 
interface  IServiceRequest
 
interface  IServiceThrottleModule
 
interface  ISharedRegionModule
 
interface  ISimulationDataService
 
interface  ISimulationDataStore
 
interface  ISimulatorFeaturesModule
 Add remove or retrieve Simulator Features that will be given to a viewer via the SimulatorFeatures capability. More...
 
interface  ISoundModule
 
interface  ISunModule
 
interface  ITerrain
 
interface  IMapImageGenerator
 
interface  ITerrainChannel
 
interface  ITerrainEffect
 
interface  ITerrainModule
 
interface  IUrlModule
 
interface  IVegetationModule
 
interface  IVoiceModule
 
interface  IWindModelPlugin
 
interface  IWindModule
 
interface  IWorldCommListenerInfo
 
interface  IWorldComm
 
interface  IWorldMapModule
 
interface  IXfer
 
interface  IXmlRpcRequestInfo
 
interface  IXMLRPC
 
interface  IXmlRpcRouter
 

Enumerations

enum  CommandIntentions { CommandIntentions.COMMAND_STATISTICAL, CommandIntentions.COMMAND_NON_HAZARDOUS, CommandIntentions.COMMAND_HAZARDOUS }
 
enum  InsertLocation : int {
  InsertLocation.Agent = 1, InsertLocation.World = 2, InsertLocation.Tools = 3, InsertLocation.Advanced = 4,
  InsertLocation.Admin = 5
}
 
enum  UserMode : int { UserMode.Normal = 0, UserMode.RegionManager = 2, UserMode.God = 3 }
 
enum  HttpRequestConstants {
  HttpRequestConstants.HTTP_METHOD = 0, HttpRequestConstants.HTTP_MIMETYPE = 1, HttpRequestConstants.HTTP_BODY_MAXLENGTH = 2, HttpRequestConstants.HTTP_VERIFY_CERT = 3,
  HttpRequestConstants.HTTP_VERBOSE_THROTTLE = 4, HttpRequestConstants.HTTP_CUSTOM_HEADER = 5, HttpRequestConstants.HTTP_PRAGMA_NO_CACHE = 6
}
 
enum  HttpInitialRequestStatus { HttpInitialRequestStatus.OK = 1, HttpInitialRequestStatus.DISALLOWED_BY_FILTER = 2 }
 The initial status of the request before it is placed on the wire. More...
 
enum  JsonStoreNodeType { JsonStoreNodeType.Undefined = 0, JsonStoreNodeType.Object = 1, JsonStoreNodeType.Array = 2, JsonStoreNodeType.Value = 3 }
 
enum  JsonStoreValueType {
  JsonStoreValueType.Undefined = 0, JsonStoreValueType.Boolean = 1, JsonStoreValueType.Integer = 2, JsonStoreValueType.Float = 3,
  JsonStoreValueType.String = 4, JsonStoreValueType.UUID = 5
}
 
enum  NPCOptionsFlags : int {
  NPCOptionsFlags.None = 0x00, NPCOptionsFlags.AllowNotOwned = 0x01, NPCOptionsFlags.AllowSenseAsAvatar = 0x02, NPCOptionsFlags.AllowCloneOtherAvatars = 0x04,
  NPCOptionsFlags.NoNPCGroup = 0x08, NPCOptionsFlags.objectGroup = 0x10
}
 
enum  PermissionClass { PermissionClass.Owner, PermissionClass.Group, PermissionClass.Everyone }
 

Functions

delegate void ReportOutputAction (string format, params object[] args)
 
delegate bool HandlerDelegate (IClientAPI client, FloaterData data, string[] msg)
 
delegate void CustomMenuHandler (string action, UUID agentID, List< uint > selection)
 
delegate ScenePresence CrossAgentToNewRegionDelegate (ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, EntityTransferContext ctx)
 
delegate ScenePresence CrossAsyncDelegate (ScenePresence agent, bool isFlying)
 
delegate void ChangeDelegate (UUID regionID)
 
delegate void MessageDelegate (UUID regionID, UUID fromID, string fromName, string message)
 
delegate void NewGroupNotice (UUID groupID, UUID noticeID)
 
delegate void InventoryArchiveSaved (UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream saveStream, Exception reportedException, int saveCount, int filterCount)
 Used for the OnInventoryArchiveSaved event. More...
 
delegate void InventoryArchiveLoaded (UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream loadStream, Exception reportedException, int loadCount)
 Used for the OnInventoryArchiveLoaded event. More...
 
delegate void DecodedCallback (UUID AssetId, OpenJPEG.J2KLayerInfo[] layers)
 
delegate void TakeValueCallback (string s)
 
delegate void MessageResultNotification (bool success)
 
delegate void UndeliveredMessage (GridInstantMessage im)
 
delegate void PresenceChange (PresenceInfo info)
 
delegate void BulkPresenceData (PresenceInfo[] info)
 
delegate void ConsoleMessage (UUID toAgentID, string message)
 
delegate void ScriptRemoved (UUID script)
 
delegate void ObjectRemoved (UUID prim)
 
delegate void ScriptCommand (UUID script, string id, string module, string command, string k)
 
delegate void SimulatorFeaturesRequestDelegate (UUID agentID, ref OSDMap features)
 

Enumeration Type Documentation

Enumerator
COMMAND_STATISTICAL 
COMMAND_NON_HAZARDOUS 
COMMAND_HAZARDOUS 

Definition at line 32 of file ICommand.cs.

The initial status of the request before it is placed on the wire.

The request may still fail later on, in which case the normal HTTP status is set.

Enumerator
OK 
DISALLOWED_BY_FILTER 

Definition at line 52 of file IHttpRequests.cs.

Enumerator
HTTP_METHOD 
HTTP_MIMETYPE 
HTTP_BODY_MAXLENGTH 
HTTP_VERIFY_CERT 
HTTP_VERBOSE_THROTTLE 
HTTP_CUSTOM_HEADER 
HTTP_PRAGMA_NO_CACHE 

Definition at line 34 of file IHttpRequests.cs.

Enumerator
Agent 
World 
Tools 
Advanced 
Admin 

Definition at line 34 of file IDynamicMenuModule.cs.

Enumerator
Undefined 
Object 
Array 
Value 

Definition at line 36 of file IJsonStoreModule.cs.

Enumerator
Undefined 
Boolean 
Integer 
Float 
String 
UUID 

Definition at line 44 of file IJsonStoreModule.cs.

Enumerator
None 
AllowNotOwned 
AllowSenseAsAvatar 
AllowCloneOtherAvatars 
NoNPCGroup 
objectGroup 

Definition at line 35 of file INPCModule.cs.

Which set of permissions a user has.

Enumerator
Owner 
Group 
Everyone 

Definition at line 36 of file IPermissionsModule.cs.

Enumerator
Normal 
RegionManager 
God 

Definition at line 43 of file IDynamicMenuModule.cs.

Function Documentation

delegate void OpenSim.Region.Framework.Interfaces.BulkPresenceData ( PresenceInfo[]  info)
delegate void OpenSim.Region.Framework.Interfaces.ChangeDelegate ( UUID  regionID)

Here is the caller graph for this function:

delegate void OpenSim.Region.Framework.Interfaces.ConsoleMessage ( UUID  toAgentID,
string  message 
)

Here is the caller graph for this function:

delegate ScenePresence OpenSim.Region.Framework.Interfaces.CrossAgentToNewRegionDelegate ( ScenePresence  agent,
Vector3  pos,
GridRegion  neighbourRegion,
bool  isFlying,
EntityTransferContext  ctx 
)
delegate ScenePresence OpenSim.Region.Framework.Interfaces.CrossAsyncDelegate ( ScenePresence  agent,
bool  isFlying 
)

Here is the caller graph for this function:

delegate void OpenSim.Region.Framework.Interfaces.CustomMenuHandler ( string  action,
UUID  agentID,
List< uint >  selection 
)
delegate void OpenSim.Region.Framework.Interfaces.DecodedCallback ( UUID  AssetId,
OpenJPEG.J2KLayerInfo[]  layers 
)
delegate bool OpenSim.Region.Framework.Interfaces.HandlerDelegate ( IClientAPI  client,
FloaterData  data,
string[]  msg 
)
delegate void OpenSim.Region.Framework.Interfaces.InventoryArchiveLoaded ( UUID  id,
bool  succeeded,
UserAccount  userInfo,
string  invPath,
Stream  loadStream,
Exception  reportedException,
int  loadCount 
)

Used for the OnInventoryArchiveLoaded event.

Parameters
idRequest id
succeededtrue if the load succeeded, false otherwise
userInfoThe user for whom the load was conducted
invPathThe inventory path loaded
savePathThe stream from which the archive was loaded
reportedExceptionContains the exception generated if the load did not succeed
loadCountNumber of inventory items loaded from archive
delegate void OpenSim.Region.Framework.Interfaces.InventoryArchiveSaved ( UUID  id,
bool  succeeded,
UserAccount  userInfo,
string  invPath,
Stream  saveStream,
Exception  reportedException,
int  saveCount,
int  filterCount 
)

Used for the OnInventoryArchiveSaved event.

Parameters
idRequest id
succeededtrue if the save succeeded, false otherwise
userInfoThe user for whom the save was conducted
invPathThe inventory path saved
savePathThe stream to which the archive was saved
reportedExceptionContains the exception generated if the save did not succeed
saveCountNumber of inventory items saved to archive
filterCountNumber of inventory items skipped due to perm filter option
delegate void OpenSim.Region.Framework.Interfaces.MessageDelegate ( UUID  regionID,
UUID  fromID,
string  fromName,
string  message 
)

Here is the caller graph for this function:

delegate void OpenSim.Region.Framework.Interfaces.MessageResultNotification ( bool  success)
delegate void OpenSim.Region.Framework.Interfaces.NewGroupNotice ( UUID  groupID,
UUID  noticeID 
)
delegate void OpenSim.Region.Framework.Interfaces.ObjectRemoved ( UUID  prim)

Here is the caller graph for this function:

delegate void OpenSim.Region.Framework.Interfaces.PresenceChange ( PresenceInfo  info)
delegate void OpenSim.Region.Framework.Interfaces.ReportOutputAction ( string  format,
params object[]  args 
)
delegate void OpenSim.Region.Framework.Interfaces.ScriptCommand ( UUID  script,
string  id,
string  module,
string  command,
string  k 
)

Here is the caller graph for this function:

delegate void OpenSim.Region.Framework.Interfaces.ScriptRemoved ( UUID  script)

Here is the caller graph for this function:

delegate void OpenSim.Region.Framework.Interfaces.SimulatorFeaturesRequestDelegate ( UUID  agentID,
ref OSDMap  features 
)
delegate void OpenSim.Region.Framework.Interfaces.TakeValueCallback ( string  s)
delegate void OpenSim.Region.Framework.Interfaces.UndeliveredMessage ( GridInstantMessage  im)

Here is the caller graph for this function: